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.
CloseFor 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| output | Reference to the NativeArray to write the data into. |
| src | Resource to read the data from. |
| size | Size in bytes of the data to be retrieved from the ComputeBuffer. |
| offset | Offset in bytes in the ComputeBuffer. |
| mipIndex | Index of the mipmap to be fetched. |
| dstFormat | Target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. |
| x | Starting X coordinate in pixels of the Texture data to be fetched. |
| width | Width in pixels of the Texture data to be fetched. |
| y | Starting Y coordinate in pixels of the Texture data to be fetched. |
| height | Height in pixels of the Texture data to be fetched. |
| z | Starting Z coordinate in pixels for the Texture3D being retrieved. The index is the start layer for TextureCube, Texture2DArray and TextureCubeArray being retrieved. |
| depth | Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. |
| callback | Optional delegate System.Action that is called once the request is completed. The completed request is passed as parameter to the System.Action. |
void Returns an AsyncGPUReadbackRequest that you can use to determine when the data is available. Otherwise, a request with an error is returned.
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.