Version: 2019.3
LanguageEnglish
  • C#

CommandBuffer.RequestAsyncReadback

Leave feedback
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 RequestAsyncReadback(ComputeBuffer src, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadback(ComputeBuffer src, int size, int offset, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadback(Texture src, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadback(Texture src, int mipIndex, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadback(Texture src, int mipIndex, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadback(Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, Action<AsyncGPUReadbackRequest> callback);
public void RequestAsyncReadback(Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, TextureFormat dstFormat, Action<AsyncGPUReadbackRequest> callback);

Parameters

srcThe resource to read the data from.
sizeSize in bytes of the data to be retrieved from the ComputeBuffer.
offsetOffset in bytes in the ComputeBuffer.
mipIndexThe index of the mipmap to be fetched.
dstFormatThe target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU.
xStarting X coordinate in pixels of the Texture data to be fetched.
yStarting Y coordinate in pixels of the Texture data to be fetched.
zStart Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched.
depthDepth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray.
widthWidth in pixels of the Texture data to be fetched.
heightHeight in pixels of the Texture data to be fetched.
callbackA delegate System.Action called once the request is fullfilled. The done request is passed as parameter to the System.Action.

Description

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

See Also: AsyncGPUReadback.Request.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2020 Unity Technologies. Publication Date: 2020-06-05.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information