Struct CameraSettings.Volumes

Defines the settings for querying and evaluating volumes within the framework. This structure contains options for filtering volumes by LayerMask and customizing the location of volume evaluations through an optional Transform anchor override. These settings control how volumes are processed and how they interact with the scene's camera or other objects.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.Rendering.HighDefinition

Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll

Syntax

[Serializable]
public struct CameraSettings.Volumes

Remarks

The CameraSettings.Volumes struct is used for controlling volume behavior, including selecting which volumes to query using the LayerMask and overriding the default evaluation anchor. It is useful when customizing volume queries and evaluation locations within a scene.

Fields

anchorOverride

If not null, specifies a custom location for evaluating the volumes. This allows for overriding the default anchor point for volume processing.

Declaration

public Transform anchorOverride

Field Value

Type	Description
Transform

Remarks

If anchorOverride is set to null, the default evaluation location is used. This property provides additional flexibility in controlling where volumes are processed within the scene.

default

Default value for volume settings. This is the default configuration used before any customizations are applied.

Declaration

[Obsolete("This field is obsolete use Volumes.NewDefault() instead. #from(2019.3)", true)]
public static readonly CameraSettings.Volumes @default

Field Value

Type	Description
CameraSettings.Volumes

Remarks

The default value uses a LayerMask of -1 (which includes all layers) and a null override for the anchor (indicating no anchor override).

layerMask

The LayerMask used to filter which volumes should be evaluated. This setting allows you to control which layers are considered during volume evaluation.

Declaration

public LayerMask layerMask

Field Value

Type	Description
LayerMask

Remarks

A LayerMask of -1 includes all layers, while setting specific values allows you to limit evaluation to certain layers.

Methods

NewDefault()

Creates a new default CameraSettings.Volumes instance with predefined settings. The default configuration includes a LayerMask that includes all layers and a null anchor override.

Declaration

public static CameraSettings.Volumes NewDefault()

Returns

Type	Description
CameraSettings.Volumes	The default CameraSettings.Volumes configuration.

Remarks

This method returns a fresh instance of CameraSettings.Volumes with default values. It can be used to initialize the volume settings before applying specific customizations like setting the LayerMask or overriding the evaluation anchor.

Examples

Volumes defaultVolumes = Volumes.NewDefault();