Home -> IDataArray -> QueueDataTransfer

Description

The QueueDataTransfer method schedules a transfer from one IDataArray to another, within GPU memory.

ImportantImportant

Data transfer operations are scheduled work. When an ITransferBatch is supplied, the transfer follows the synchronization rules for that batch.

Usage

SuccessToken QueueDataTransfer(IDataArray* targetBuffer, size_t transferCountInBytes, size_t sourceBufferOffsetInBytes = 0, size_t targetBufferOffsetInBytes = 0, ITransferBatch* transferBatch = nullptr);

Argument list

targetBuffer [IDataArray*]
The destination buffer for the GPU-side transfer.
transferCountInBytes [size_t]
The number of bytes to transfer.
sourceBufferOffsetInBytes [size_t]
The source byte offset where the transfer begins.
targetBufferOffsetInBytes [size_t]
The destination byte offset where the transfer begins.
transferBatch [ITransferBatch*]
An optional transfer batch to schedule the transfer into. If null, the renderer schedules the transfer independently.

Return value

[SuccessToken]
True if the operation succeeded, false otherwise. An assertion will be raised in debug builds if the result is not tested.

See also