Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


ProcessCameraCommand

Use this method to process per-Camera VFX commands for the current frame.
Read time 2 minutesLast updated 13 days ago

Definition

ProcessCameraCommand(Camera, CommandBuffer)

Use this method to process per-Camera VFX commands for the current frame.
Warning
Deprecated. Use ProcessCameraCommand with CullingResults to allow culling of VFX per camera
public static void ProcessCameraCommand(Camera cam, CommandBuffer cmd)

Parameters

The Camera to process the VFX commands for.

The CommandBuffer to push commands to (can be null).

Remarks

The current Scriptable Render Pipeline implementation is responsible for calling this function. The High Definition and Universal Render Pipelines implement this call but you must do it manually if you create your own Scriptable Render Pipeline.
Additional Resources: PrepareCamera.

ProcessCameraCommand(Camera, CommandBuffer, VFXCameraXRSettings)

Use this method to process per-Camera VFX commands for the current frame.
Warning
Deprecated. Use ProcessCameraCommand with CullingResults to allow culling of VFX per camera
public static void ProcessCameraCommand(Camera cam, CommandBuffer cmd, VFXCameraXRSettings camXRSettings)

Parameters

The Camera to process the VFX commands for.

The CommandBuffer to push commands to (can be null).

camXRSettings

The XR settings that the Visual Effect Graph uses to process the Camera commands.

Remarks

The current Scriptable Render Pipeline implementation is responsible for calling this function. The High Definition and Universal Render Pipelines implement this call but you must do it manually if you create your own Scriptable Render Pipeline.
Additional Resources: PrepareCamera.

ProcessCameraCommand(Camera, CommandBuffer, VFXCameraXRSettings, CullingResults)

Use this method to process per-Camera VFX commands for the current frame.
public static void ProcessCameraCommand(Camera cam, CommandBuffer cmd, VFXCameraXRSettings camXRSettings, CullingResults results)

Parameters

The Camera to process the VFX commands for.

The CommandBuffer to push commands to (can be null).

camXRSettings

The XR settings that the Visual Effect Graph uses to process the Camera commands.

The CullingResults for the current camera, used to cull per-camera VFX commands.

Remarks

The current Scriptable Render Pipeline implementation is responsible for calling this function. The High Definition and Universal Render Pipelines implement this call but you must do it manually if you create your own Scriptable Render Pipeline.
Additional Resources: PrepareCamera.

ProcessCameraCommand(Camera, CommandBuffer, VFXCameraXRSettings, CullingResults, CullingResults)

Use this method to process per-Camera VFX commands for the current frame.
public static void ProcessCameraCommand(Camera cam, CommandBuffer cmd, VFXCameraXRSettings camXRSettings, CullingResults results, CullingResults customPassResults)

Parameters

The Camera to process the VFX commands for.

The CommandBuffer to push commands to (can be null).

camXRSettings

The XR settings that the Visual Effect Graph uses to process the Camera commands.

The CullingResults for the current camera, used to cull per-camera VFX commands.

customPassResults

Additional CullingResults coming from custom passes, if any.

Remarks

The current Scriptable Render Pipeline implementation is responsible for calling this function. The High Definition and Universal Render Pipelines implement this call but you must do it manually if you create your own Scriptable Render Pipeline.
Additional Resources: PrepareCamera.