Skip to content

LiteFX::Rendering::ICommandBuffer::transfer

Performs a buffer-to-buffer transfer from a temporary buffer into target.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] void transfer(
    void const const* data,
    size_t size,
    IBuffer const& target,
    UInt32 targetElement = 0,
    UInt32 elements = 1) const;

Description

This method creates a temporary buffer and maps data into it, before transferring it into target. A reference of the temporary buffer is stored until the parent command queue finished using the command buffer. At this point, the command queue calls releaseSharedState to release all shared references. Note that this is a relaxed constraint. It is only guaranteed, that the queue calls this method at some point after the command buffer has been executed.

Parameters

NameDescription
dataThe address that marks the beginning of the data to map.
sizeThe number of bytes to map.
targetThe target buffer to transfer data to.
targetElementThe array element to map the data to.
elementsThe number of elements to copy.