[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
[AddComponentMenu("")]
[ExecuteAlways]
[DisallowMultipleComponent]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.cinemachine@2.8/manual/CinemachineStoryboard.html")]
public class CinemachineStoryboard : CinemachineExtension

Fields

m_Alpha

The opacity of the image. 0 is transparent, 1 is opaque

Declaration

[Tooltip("The opacity of the image.  0 is transparent, 1 is opaque")]
[Range(0F, 1F)]
public float m_Alpha

Field Value

Type	Description
Single

m_Aspect

How to handle differences between image aspect and screen aspect

Declaration

[Tooltip("How to handle differences between image aspect and screen aspect")]
public CinemachineStoryboard.FillStrategy m_Aspect

Field Value

Type	Description
CinemachineStoryboard.FillStrategy

m_Center

The screen-space position at which to display the image. Zero is center

Declaration

[Tooltip("The screen-space position at which to display the image.  Zero is center")]
public Vector2 m_Center

Field Value

Type	Description
Vector2

m_Image

The image to display

Declaration

[Tooltip("The image to display")]
public Texture m_Image

Field Value

Type	Description
Texture

m_MuteCamera

If checked, Camera transform will not be controlled by this virtual camera

Declaration

[Tooltip("If checked, Camera transform will not be controlled by this virtual camera")]
public bool m_MuteCamera

Field Value

Type	Description
Boolean

m_PlaneDistance

How far away from the camera is the storyboard's canvas generated.

Declaration

[Tooltip("How far away from the camera is the Canvas generated.")]
public float m_PlaneDistance

Field Value

Type	Description
Single

m_RenderMode

The render mode of the canvas on which the storyboard is drawn.

Declaration

[Tooltip("The render mode of the canvas on which the storyboard is drawn.")]
public CinemachineStoryboard.StoryboardRenderMode m_RenderMode

Field Value

Type	Description
CinemachineStoryboard.StoryboardRenderMode

m_Rotation

The screen-space rotation to apply to the image

Declaration

[Tooltip("The screen-space rotation to apply to the image")]
public Vector3 m_Rotation

Field Value

Type	Description
Vector3

m_Scale

The screen-space scaling to apply to the image

Declaration

[Tooltip("The screen-space scaling to apply to the image")]
public Vector2 m_Scale

Field Value

Type	Description
Vector2

m_ShowImage

If checked, the specified image will be displayed as an overlay over the virtual camera's output

Declaration

[Tooltip("If checked, the specified image will be displayed as an overlay over the virtual camera's output")]
public bool m_ShowImage

Field Value

Type	Description
Boolean

m_SortingOrder

Allows ordering canvases to render on top or below other canvases.

Declaration

[Tooltip("Allows ordering canvases to render on top or below other canvases.")]
public int m_SortingOrder

Field Value

Type	Description
Int32

m_SplitView

Wipe the image on and off horizontally

Declaration

[Range(-1F, 1F)]
[Tooltip("Wipe the image on and off horizontally")]
public float m_SplitView

Field Value

Type	Description
Single

m_SyncScale

If checked, X and Y scale are synchronized

Declaration

[Tooltip("If checked, X and Y scale are synchronized")]
public bool m_SyncScale

Field Value

Type	Description
Boolean

s_StoryboardGlobalMute

If checked, all storyboards are globally muted

Declaration

[Tooltip("If checked, all storyboards are globally muted")]
public static bool s_StoryboardGlobalMute

Field Value

Type	Description
Boolean

Methods

ConnectToVcam(Boolean)

Connect to virtual camera. Adds/removes listener

Declaration

protected override void ConnectToVcam(bool connect)

Parameters

Type	Name	Description
Boolean	connect	True if connecting, false if disconnecting

Overrides

CinemachineExtension.ConnectToVcam(Boolean)

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

Callback to display the image

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)