Struct CameraSettings
Contains all settings required to setup a camera in HDRP.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public struct CameraSettings
Fields
bufferClearing
Buffer clearing settings to use.
Declaration
public CameraSettings.BufferClearing bufferClearing
Field Value
Type | Description |
---|---|
CameraSettings.BufferClearing |
culling
Culling settings to use.
Declaration
public CameraSettings.Culling culling
Field Value
Type | Description |
---|---|
CameraSettings.Culling |
customRenderingSettings
Override rendering settings if true.
Declaration
public bool customRenderingSettings
Field Value
Type | Description |
---|---|
bool |
default
Default value.
Declaration
[Obsolete("Since 2019.3, use CameraSettings.defaultCameraSettingsNonAlloc instead.")]
public static readonly CameraSettings @default
Field Value
Type | Description |
---|---|
CameraSettings |
defaultCameraSettingsNonAlloc
Default camera settings.
Declaration
public static readonly CameraSettings defaultCameraSettingsNonAlloc
Field Value
Type | Description |
---|---|
CameraSettings |
defaultFrameSettings
Which default FrameSettings should be used when rendering with these parameters.
Declaration
public FrameSettingsRenderType defaultFrameSettings
Field Value
Type | Description |
---|---|
FrameSettingsRenderType |
flipYMode
The mode to use when we want to flip the Y axis.
Declaration
public HDAdditionalCameraData.FlipYMode flipYMode
Field Value
Type | Description |
---|---|
HDAdditionalCameraData.FlipYMode |
frustum
Frustum settings to use.
Declaration
public CameraSettings.Frustum frustum
Field Value
Type | Description |
---|---|
CameraSettings.Frustum |
invertFaceCulling
True to invert face culling, false otherwise.
Declaration
public bool invertFaceCulling
Field Value
Type | Description |
---|---|
bool |
probeLayerMask
The layer mask to use to filter probes that can influence this camera.
Declaration
public LayerMask probeLayerMask
Field Value
Type | Description |
---|---|
LayerMask |
renderingPathCustomFrameSettings
Frame settings to use.
Declaration
public FrameSettings renderingPathCustomFrameSettings
Field Value
Type | Description |
---|---|
FrameSettings |
renderingPathCustomFrameSettingsOverrideMask
Frame settings mask to use.
Declaration
public FrameSettingsOverrideMask renderingPathCustomFrameSettingsOverrideMask
Field Value
Type | Description |
---|---|
FrameSettingsOverrideMask |
volumes
Volumes settings to use.
Declaration
public CameraSettings.Volumes volumes
Field Value
Type | Description |
---|---|
CameraSettings.Volumes |
Methods
From(HDCamera)
Extract the CameraSettings from an HDCamera
Declaration
public static CameraSettings From(HDCamera hdCamera)
Parameters
Type | Name | Description |
---|---|---|
HDCamera | hdCamera | The camera to extract from |
Returns
Type | Description |
---|---|
CameraSettings | The CameraSettings |
NewDefault()
Default value.
Declaration
public static CameraSettings NewDefault()
Returns
Type | Description |
---|---|
CameraSettings | The default value and allocate ~250B of garbage. |