Version: 2017.4
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Graphics.WaitOnGPUFence

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 static method WaitOnGPUFence(fence: Rendering.GPUFence, stage: Rendering.SynchronisationStage = SynchronisationStage.VertexProcessing): void;
public static void WaitOnGPUFence(Rendering.GPUFence fence, Rendering.SynchronisationStage stage = SynchronisationStage.VertexProcessing);

Parameters

fenceThe GPUFence that the GPU will be instructed to wait upon before proceeding with its processing of the graphics queue.
stageOn some platforms there is a significant gap between the vertex processing completing and the pixel processing begining for a given draw call. This parameter allows for requested wait to be before the next items vertex or pixel processing begins. If a compute shader dispatch is the next item to be submitted then this parameter is ignored.

Description

Instructs the GPU's processing of the graphics queue to wait until the given GPUFence is passed.

Some platforms can not differentiate between the start of vertex and pixel processing, these platforms will wait before the next items vertex processing regardless of the value passed to the stage parameter.

On platforms which do not support GPUFences this call does nothing see SystemInfo.supportsGPUFence.

It is possible for the user to create GPU deadlocks with this function. Care should be taken to ensure that the GPUFence passed can be completed before the GPU is instructed to wait.

This function returns immediately on the CPU, only GPU processing is effected by the fence.

See Also: GPUFence, Graphics.CreateGPUFence.