public static Rendering.AsyncGPUReadbackRequest Request (ComputeBuffer src, Action<AsyncGPUReadbackRequest> callback);
public static Rendering.AsyncGPUReadbackRequest Request (ComputeBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);
public static Rendering.AsyncGPUReadbackRequest Request (Texture src, int mipIndex, Action<AsyncGPUReadbackRequest> callback);
public static Rendering.AsyncGPUReadbackRequest Request (Texture src, int mipIndex, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);
public static Rendering.AsyncGPUReadbackRequest Request (Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, Action<AsyncGPUReadbackRequest> callback);
public static Rendering.AsyncGPUReadbackRequest Request (Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Parameters

srcResource to read the data from.
sizeSize in bytes of the data to be retrieved from the ComputeBuffer or GraphicsBuffer.
offsetOffset in bytes in the ComputeBuffer or GraphicsBuffer.
mipIndexIndex of the mipmap to be fetched.
dstFormatTarget TextureFormat of the data. If the target format is different from the format stored on the GPU, the conversion is automatic.
xStarting X coordinate in pixels of the Texture data to be fetched.
widthWidth in pixels of the Texture data to be fetched.
yStarting Y coordinate in pixels of the Texture data to be fetched.
heightHeight in pixels of the Texture data to be fetched.
zStart Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched.
depthDepth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray.
callbackAn optional delegate System.Action called once the request is fullfilled. The completed request is passed as parameter to the System.Action.

Returns

AsyncGPUReadbackRequest Returns an AsyncGPUReadbackRequest that you can use to determine when the data is available. Otherwise, a request with an error is returned.

Description

Retrieves data asynchronously from a GPU resource.

If a request with an error is returned, calling AsyncGPUReadbackRequest.hasError returns true.

For texture data, the extents are checked against the size of the source texture. If graphics QualitySettings are set low enough to generate reduced size textures, then the reduced size must be requested. Use QualitySettings.masterTextureLimit to adjust the width and height (and x,y if required), by bit shifting right.