Struct LensSettings

Describes the FOV and clip planes for a camera. This generally mirrors the Unity Camera's lens settings, and will be used to drive the Unity camera when the vcam is active.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Cinemachine

Assembly: solution.dll

Syntax

[Serializable]
[DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
public struct LensSettings

Constructors

Name	Description
LensSettings(float, float, float, float, float)	Explicit constructor for this LensSettings

Fields

Name	Description
Default	Default Lens Settings
Dutch	The dutch (tilt) to be applied to the camera. In degrees
FarClipPlane	The far clip plane for this LensSettings
FieldOfView	This is the camera view in vertical degrees. For cinematic people, a 50mm lens on a super-35mm sensor would equal a 19.6 degree FOV
LensShift	For physical cameras only: position of the gate relative to the film back
NearClipPlane	The near clip plane for this LensSettings
OrthographicSize	When using an orthographic camera, this defines the height, in world co-ordinates, of the camera view.

Properties

Name	Description
Aspect	Sensor aspect, not screen aspect. For nonphysical cameras, this is the same thing.
IsPhysicalCamera	This is set every frame by the virtual camera, based on the value found in the currently associated Unity camera
Orthographic	This is set every frame by the virtual camera, based on the value found in the currently associated Unity camera
SensorSize	This is set every frame by the virtual camera, based on the value found in the currently associated Unity camera

Methods

Name	Description
FromCamera(Camera)	Creates a new LensSettings, copying the values from the supplied Camera
Lerp(LensSettings, LensSettings, float)	Linearly blends the fields of two LensSettings and returns the result
SnapshotCameraReadOnlyProperties(ref LensSettings)	Snapshot the properties that are read-only in the Camera
SnapshotCameraReadOnlyProperties(Camera)	Snapshot the properties that are read-only in the Camera
Validate()	Make sure lens settings are sane. Call this from OnValidate().