Version: 2018.1
Experimental: this API is experimental and might be changed or removed in the future.

AsyncGPUReadbackRequest

struct in UnityEngine.Experimental.Rendering

Switch to Manual

Description

Represents an asynchronous request for a GPU resource.

Use AsyncGPUReadback.Request to retrieve an asynchronous request for a GPU resource. Pending requests are automatically updated each frame. The result is accessible only for a single frame once is successfully fulfilled and this request is then disposed of in the following frame. Common uses for this are to query AsyncGPUReadbackRequest.done each frame (or within a coroutine) and then call AsyncGPUReadbackRequest.GetData if the AsyncGPUReadbackRequest.hasError is false. You don't have to manage the request lifetime as this is managed internally. A request that has been disposed of will result in the AsyncGPUReadbackRequest.hasError property being true. See Also:AsyncGPUReadback.

Variables

doneChecks whether the request has been processed.
hasErrorThis property is true if the request has encountered an error.
layerCountNumber of layers in the current request.

Public Functions

GetDataFetches the data of a successful request.
UpdateTriggers an update of the request.
WaitForCompletionWaits for completion of the request.