Class CinemachineStoryboard

An add-on module for Cinemachine Virtual Camera that places an image in screen space over the camera's output.

Inheritance
Object
CinemachineExtension
CinemachineStoryboard
Inherited Members
Namespace: Cinemachine
Syntax
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public class CinemachineStoryboard : CinemachineExtension

Fields

m_Alpha

Declaration
public float m_Alpha
Field Value
Type Description
Single

m_Aspect

Declaration
public CinemachineStoryboard.FillStrategy m_Aspect
Field Value
Type Description
CinemachineStoryboard.FillStrategy

m_Center

Declaration
public Vector2 m_Center
Field Value
Type Description
Vector2

m_Image

Declaration
public Texture m_Image
Field Value
Type Description
Texture

m_MuteCamera

Declaration
public bool m_MuteCamera
Field Value
Type Description
Boolean

m_Rotation

Declaration
public Vector3 m_Rotation
Field Value
Type Description
Vector3

m_Scale

Declaration
public Vector2 m_Scale
Field Value
Type Description
Vector2

m_ShowImage

Declaration
public bool m_ShowImage
Field Value
Type Description
Boolean

m_SplitView

Declaration
public float m_SplitView
Field Value
Type Description
Single

m_SyncScale

Declaration
public bool m_SyncScale
Field Value
Type Description
Boolean

s_StoryboardGlobalMute

Declaration
public static bool s_StoryboardGlobalMute
Field Value
Type Description
Boolean

Methods

ConnectToVcam(Boolean)

Declaration
protected override void ConnectToVcam(bool connect)
Parameters
Type Name Description
Boolean connect
Overrides

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

Standard CinemachineExtension callback

Declaration
protected override void PostPipelineStageCallback(CinemachineVirtualCameraBase vcam, CinemachineCore.Stage stage, ref CameraState state, float wipeAmountTime)
Parameters
Type Name Description
CinemachineVirtualCameraBase vcam
CinemachineCore.Stage stage
CameraState state
Single wipeAmountTime
Overrides