Class CinemachineBlenderSettings

Asset that defines the rules for blending between Virtual Cameras.

Inheritance

ScriptableObject

CinemachineBlenderSettings

Namespace: Cinemachine

Syntax

[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public sealed class CinemachineBlenderSettings : ScriptableObject

Fields

kBlendFromAnyCameraLabel

Internal API for the inspector editopr: a label to represent any camera

Declaration

public const string kBlendFromAnyCameraLabel = "**ANY CAMERA**"

Field Value

Type	Description
System.String

m_CustomBlends

The array containing explicitly defined blends between two Virtual Cameras

Declaration

public CinemachineBlenderSettings.CustomBlend[] m_CustomBlends

Field Value

Type	Description
CinemachineBlenderSettings.CustomBlend[]

Methods

GetBlendForVirtualCameras(String, String, CinemachineBlendDefinition)

Attempts to find a blend definition which matches the to and from cameras as specified. If no match is found, the function returns the supplied default blend.

Declaration

public CinemachineBlendDefinition GetBlendForVirtualCameras(string fromCameraName, string toCameraName, CinemachineBlendDefinition defaultBlend)

Parameters

Type	Name	Description
System.String	fromCameraName	The game object name of the from camera
System.String	toCameraName	The game object name of the to camera
CinemachineBlendDefinition	defaultBlend	Blend to return if no custom blend found.

Returns

Type	Description
CinemachineBlendDefinition