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(
    Span<void const const*> data,
    size_t elementSize,
    IImage const& target,
    UInt32 firstSubresource = 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

Name	Description
data	The addresses that mark the beginning of the element data to map.
elementSize	The number of bytes to map for each element.
target	The target buffer to transfer data to.
firstSubresource	The index of the first sub-resource of the target image to receive data.
elements	The number of elements to copy from the source buffer into the target image sub-resources.