Version: 2021.3
LanguageEnglish
  • C#

ScriptableRenderContext.StartMultiEye

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 void StartMultiEye(Camera camera);

Declaration

public void StartMultiEye(Camera camera, int eye);

Parameters

camera Camera to enable stereo rendering on.
eye The current eye to be rendered.

Description

Schedules a fine-grained beginning of stereo rendering on the ScriptableRenderContext.

Activates stereo rendering on the ScriptableRenderContext and camera. When used in conjunction with StopMultiEye, these APIs provide fine-grained control of which draw calls are multi-plexed for stereo purposes. For example, you would wrap your opaque and transparent passes with StartMultiEye and StopMultiEye, but you could exclude your shadow rendering.

Note that only draws are affected by this API. Compute work is not automatically adjusted for stereo, therefore, per-eye compute work must be manually generated.

Additional resources: StopMultiEye, SetupCameraProperties, StereoEndRender, CullingResults.GetCullingParameters.