Class CinemachineFadeOutNearbyObjects

An example add-on module for Cinemachine Virtual Camera for controlling the FadeOut shader included in our example package.

Inheritance

Object

CinemachineExtension

CinemachineFadeOutNearbyObjects

Inherited Members

CinemachineExtension.Epsilon

CinemachineExtension.VirtualCamera

CinemachineExtension.Awake()

CinemachineExtension.OnEnable()

CinemachineExtension.OnDestroy()

CinemachineExtension.ConnectToVcam(Boolean)

CinemachineExtension.PrePipelineMutateCameraStateCallback(CinemachineVirtualCameraBase, CameraState, Single)

CinemachineExtension.InvokePostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, CameraState, Single)

CinemachineExtension.OnTargetObjectWarped(Transform, Vector3)

CinemachineExtension.ForceCameraPosition(Vector3, Quaternion)

CinemachineExtension.OnTransitionFromCamera(ICinemachineCamera, Vector3, Single)

CinemachineExtension.GetMaxDampTime()

CinemachineExtension.GetExtraState<T>(ICinemachineCamera)

CinemachineExtension.GetAllExtraStates<T>()

Namespace: Cinemachine.Examples

Syntax

public class CinemachineFadeOutNearbyObjects : CinemachineExtension

Fields

m_FadeOutMaterial

Material using the FadeOut shader.

Declaration

public Material m_FadeOutMaterial

Field Value

Type	Description
Material

m_LookAtTargetRadius

Radius of the look at target.

Declaration

public float m_LookAtTargetRadius

Field Value

Type	Description
Single

m_MaxDistance

Maximum distance to have fading out effect in front of the camera.

Declaration

public float m_MaxDistance

Field Value

Type	Description
Single

m_MinDistance

Minimum distance to have fading out effect in front of the camera.

Declaration

public float m_MinDistance

Field Value

Type	Description
Single

m_SetToCameraToLookAtDistance

If true, m_MaxDistance will be set to distance between this virtual camera and LookAt target minus m_LookAtTargetRadius.

Declaration

public bool m_SetToCameraToLookAtDistance

Field Value

Type	Description
Boolean

Methods

PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)

Updates FadeOut shader on the specified FadeOutMaterial.

Declaration

protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float deltaTime)

Parameters

Type	Name	Description
CinemachineVirtualCameraBase	vcam	The virtual camera being processed
CinemachineCore.Stage	stage	The current pipeline stage
CameraState	state	The current virtual camera state
Single	deltaTime	The current applicable deltaTime

Overrides

CinemachineExtension.PostPipelineStageCallback(CinemachineVirtualCameraBase, CinemachineCore.Stage, ref CameraState, Single)