Version: 2020.1
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

public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, ComputeBuffer src, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, ComputeBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, GraphicsBuffer src, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, GraphicsBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadbackIntoNativeArray(ref NativeArray<T> output, Texture src, int mipIndex, Experimental.Rendering.GraphicsFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);
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);
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);
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.
size The size in bytes of the data to be retrieved from the ComputeBuffer or GraphicsBuffer.
offset The offset in bytes in the ComputeBuffer or GraphicsBuffer.
mipIndex The index of the mipmap to be retrieved.
dstFormat The target TextureFormat of the data. If the target format is different from the format stored on the GPU, the conversion is automatic.
x The starting X coordinate in pixels of the Texture data to be retrieved.
y The starting Y coordinate in pixels of the Texture data to be retrieved.
z The starting Z coordinate in pixels for the Texture3D being retrieved. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being retrieved.
depth The depth in pixels for Texture3D being retrieved. Number of layers for TextureCube, TextureArray and TextureCubeArray.
width The width in pixels of the Texture data to be retrieved.
height The height in pixels of the Texture data to be retrieved.
callback A delegate System.Action called when the request is completed. The done request is passed as a parameter to the System.Action callback.

Description

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

Did you find this page useful? Please give it a rating: