Version: 2022.3
LanguageEnglish
  • C#

CommandBuffer.RequestAsyncReadbackIntoNativeArray

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 void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, Action<AsyncGPUReadbackRequest> callback);

Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, Action<AsyncGPUReadbackRequest> callback);

Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Declaration

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

Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, Action<AsyncGPUReadbackRequest> callback);

Declaration

public void RequestAsyncReadbackIntoNativeArray(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 void RequestAsyncReadbackIntoNativeArray(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 a NativeArray to write the data into.
src The 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.
y The starting y-coordinate, 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.
width The width, in pixels, of the Texture data to fetch.
height The height, in pixels, of the Texture data to fetch.
depth The depth, in pixels of the Texture3D to fetch. For TextureCube, Texture2DArray, and TextureCubeArray, this is the number of layers to retrieve.
callback A 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.

Description

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


Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, ComputeBuffer src, Action<AsyncGPUReadbackRequest> callback);

Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, ComputeBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);

Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, GraphicsBuffer src, Action<AsyncGPUReadbackRequest> callback);

Declaration

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, GraphicsBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);

Parameters

output Reference to a NativeArray to write the data into.
src The resource to read the data from.
size The size, in bytes, of the data to retrieve from the ComputeBuffer or GraphicsBuffer.
offset The offset in bytes in the ComputeBuffer or GraphicsBuffer.
callback A 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.

Description

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