LiteFX::Rendering::ICommandBuffer::transfer

Performs an image-to-image transfer from source to target.

Synopsis

Declared in <litefx/rendering_api.hpp>

[[dllimport, dllexport]] void transfer(
    IImage const& source,
    IImage const& target,
    UInt32 sourceSubresource = 0,
    UInt32 targetSubresource = 0,
    UInt32 subresources = 1) const;

Description

Note that you have to manually ensure that source and target are in the proper state for transfer operations. You might have to use a IBarrier before starting the transfer.

Exceptions

Name	Thrown on
ArgumentOutOfRangeException	Thrown, if the number of either the source buffer or the target buffer has not enough elements for the specified elements parameter.

Parameters

Name	Description
source	The source image to transfer data from.
target	The target image to transfer data to.
sourceSubresource	The index of the first sub-resource to copy from the source image.
targetSubresource	The image of the first sub-resource in the target image to receive data.
subresources	The number of sub-resources to copy between the images.