Version: 2019.3
LanguageEnglish
  • C#

CommandBuffer.RequestAsyncReadback(ref NativeArray_1, ComputeBuffer,Action<AsyncGPUReadbackRequest>)

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Parameters

outputReference to a NativeArray to write the data into.
srcThe resource to read the data from.
sizeThe size in bytes of the data to be retrieved from the ComputeBuffer.
offsetThe offset in bytes in the ComputeBuffer.
mipIndexThe index of the mipmap to be retrieved.
dstFormatThe target TextureFormat of the data. If the target format is different from the format stored on the GPU, the conversion is automatic.
xThe starting X coordinate in pixels of the Texture data to be retrieved.
yThe starting Y coordinate in pixels of the Texture data to be retrieved.
zThe starting Z coordinate in pixels for the Texture3D being retrieved. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being retrieved.
depthThe depth in pixels for Texture3D being retrieved. Number of layers for TextureCube, TextureArray and TextureCubeArray.
widthThe width in pixels of the Texture data to be retrieved.
heightThe height in pixels of the Texture data to be retrieved.
callbackA delegate System.Action called when the request is completed. The done request is passed as a parameter to the System.Action callback.

Description

Adds an asynchonous GPU readback request command to the command buffer.