Version: Unity 6.0 (6000.0)
LanguageEnglish
  • C#

AsyncGPUReadback.RequestAsync

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

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(ComputeBuffer src);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(ComputeBuffer src, int size, int offset);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(GraphicsBuffer src);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(GraphicsBuffer src, int size, int offset);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(Texture src, int mipIndex);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(Texture src, int mipIndex, TextureFormat dstFormat);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(Texture src, int mipIndex, Experimental.Rendering.GraphicsFormat dstFormat);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, TextureFormat dstFormat);

Declaration

public static Awaitable<AsyncGPUReadbackRequest> RequestAsync(Texture src, int mipIndex, int x, int width, int y, int height, int z, int depth, Experimental.Rendering.GraphicsFormat dstFormat);

Parameters

Parameter Description
src Resource to read the data from.
size Size in bytes of the data to be retrieved from the ComputeBuffer or GraphicsBuffer.
offset Offset in bytes in the ComputeBuffer or GraphicsBuffer.
mipIndex Index of the mipmap to be fetched.
dstFormat Target TextureFormat of the data. If the target format is different from the format stored on the GPU, the conversion is automatic.
x Starting X coordinate in pixels of the Texture data to be fetched.
width Width in pixels of the Texture data to be fetched.
y Starting Y coordinate in pixels of the Texture data to be fetched.
height Height in pixels of the Texture data to be fetched.
z Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray.
depth Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray.

Description

Retrieves data asynchronously from a GPU resource.

See 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 ©2005-2025 Unity Technologies. All rights reserved. Built from: 6000.0.62f1 (c57367d9e417). Built on: 2025-10-26.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information