Struct ScreenComposerSettings

This structure holds settings for screen-space composition.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Unity.Cinemachine

Assembly: solution.dll

Syntax

[Serializable]
public struct ScreenComposerSettings

Fields

Name	Description
DeadZone	The camera will not adjust if the target is within this range of the screen position
HardLimits	The target will not be allowed to be outside this region. When the target is within this region, the camera will gradually adjust to re-align towards the desired position, depending on the damping speed
ScreenPosition	Screen position for target. The camera will adjust to position the tracked object here. 0 is screen center, and +0.5 or -0.5 is screen edge

Properties

Name	Description
DeadZoneRect	Get/set the screenspace rect for the dead zone region. This also defines screen position
Default	The default screen composition
EffectiveDeadZoneSize	Get the effective dead zone size, taking enabled state into account
EffectiveHardLimitSize	Get the effective hard limits size, taking enabled state into account
HardLimitsRect	Get/set the screenspace rect for the hard limits.

Methods

Name	Description
Approximately(in ScreenComposerSettings, in ScreenComposerSettings)	Tests whether 2 ScreenComposerSettings are approximately equal.
Lerp(in ScreenComposerSettings, in ScreenComposerSettings, float)	Linear interpolation between 2 settings objects.
Validate()	Clamps values to the expected ranges