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.
Closeoutput | Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete. |
src | The Texture resource to read the data from. |
mipIndex | The index of the mipmap to fetch. |
dstFormat | The target TextureFormat of the data. Conversion happens automatically if this format is different from the format stored on the GPU. |
x | The starting x-coordinate, in pixels, of the Texture data to fetch. |
width | The width, in pixels, of the Texture data to fetch. |
y | The starting y-coordinate, in pixels, of the Texture data to fetch. |
height | The height, in pixels, of the Texture data to fetch. |
z | The starting z-coordinate, in pixels, of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the index of the start layer. |
depth | The depth, in pixels of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the number of layers to retrieve. |
callback | An optional delegate System.Action to call after Unity completes the request. When Unity calls the delegate, it passes the completed request as a parameter to the System.Action. |
AsyncGPUReadbackRequest Returns an AsyncGPUReadbackRequest that you can use to determine when the data is available. Otherwise, returns a request with an error.
Retrieves data asynchronously from a GPU Texture resource.
If the return value is a request with an error, 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.
For texture data, use the SystemInfo.IsFormatSupported method with the FormatUsage.ReadPixels flag to query if the format is supported.
When requesting into multiple slices in the same frame, ensure that each slice comes from a different memory allocation. Using multiple slices from the same allocation within a single frame is not supported.
output | Reference to the NativeSlice to write the data into. The underlying memory cannot be Disposed until the request is complete. |
src | The GraphicsBuffer to read the data from. |
size | The size, in bytes, of the data to retrieve from the GraphicsBuffer. |
offset | Offset in bytes in the GraphicsBuffer. |
callback | An optional delegate System.Action to call after Unity completes the request. When Unity calls the delegate, it passes the completed request as a parameter to the System.Action. |
AsyncGPUReadbackRequest Returns an AsyncGPUReadbackRequest that you can use to determine when the data is available. Otherwise, returns a request with an error.
Retrieves data asynchronously from a GPU Graphics Buffer resource.
If the return value is a request with an error, 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.
For texture data, use SystemInfo.IsFormatSupported with FormatUsage.ReadPixels to query if the format is supported.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.