Struct CinemachineConfiner2D.OversizeWindowSettings

Settings to optimize computation and memory costs in the event that the window size is expected to be larger than will fit inside the confining shape.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Cinemachine

Assembly: Unity.Cinemachine.dll

Syntax

[Serializable]
public struct CinemachineConfiner2D.OversizeWindowSettings

Fields

Enabled

Enable optimizing of computation and memory costs in the event that the window size is expected to be larger than will fit inside the confining shape. Enable only if needed, because it's costly.

Declaration

[Tooltip("Enable optimizing of computation and memory costs in the event that the window size is expected to be larger than will fit inside the confining shape.\nEnable only if needed, because it's costly")]
public bool Enabled

Field Value

Type	Description
bool

MaxWindowSize

To optimize computation and memory costs, set this to the largest view size that the camera is expected to have. The confiner will not compute a polygon cache for frustum sizes larger than this. This refers to the size in world units of the frustum at the confiner plane (for orthographic cameras, this is just the orthographic size). If set to 0, then this parameter is ignored and a polygon cache will be calculated for all potential window sizes.

Declaration

[Tooltip("To optimize computation and memory costs, set this to the largest view size that the camera is expected to have.  The confiner will not compute a polygon cache for frustum sizes larger than this.  This refers to the size in world units of the frustum at the confiner plane (for orthographic cameras, this is just the orthographic size).  If set to 0, then this parameter is ignored and a polygon cache will be calculated for all potential window sizes.")]
public float MaxWindowSize

Field Value

Type	Description
float

Padding

For large window sizes, the confiner will potentially generate polygons with zero area.
The padding may be used to add a small amount of area to these polygons, to prevent them from being a series of disconnected dots.

Declaration

[Tooltip("For large window sizes, the confiner will potentially generate polygons with zero area.  The padding may be used to add a small amount of area to these polygons, to prevent them from being a series of disconnected dots.")]
[Range(0, 100)]
public float Padding

Field Value

Type	Description
float