Version: 2022.1
LanguageEnglish
  • C#

AsyncGPUReadback.RequestIntoNativeArray

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

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, Experimental.Rendering.GraphicsFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, Experimental.Rendering.GraphicsFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Parameters

output Reference to the NativeArray to write the data into. The NativeArray or 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.

Returns

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

Description

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 SystemInfo.IsFormatSupported with FormatUsage.ReadPixels to query if the format is supported.


Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, ComputeBuffer src, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, ComputeBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, GraphicsBuffer src, Action<AsyncGPUReadbackRequest> callback);

Declaration

public static Rendering.AsyncGPUReadbackRequest RequestIntoNativeArray(ref NativeArray<T> output, GraphicsBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);

Parameters

output Reference to the NativeArray to write the data into. The NativeArray or 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.

Returns

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

Description

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.