Struct ProbeCapturePositionSettings
Settings to use when capturing a probe.
Inherited Members
Namespace: UnityEngine.Rendering.HighDefinition
Assembly: Unity.RenderPipelines.HighDefinition.Runtime.dll
Syntax
[Serializable]
public struct ProbeCapturePositionSettings
Constructors
ProbeCapturePositionSettings(Vector3, Quaternion, Matrix4x4)
Create a new settings with only the probe transform.
Declaration
public ProbeCapturePositionSettings(Vector3 proxyPosition, Quaternion proxyRotation, Matrix4x4 influenceToWorld)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | proxyPosition | The proxy position. |
Quaternion | proxyRotation | The proxy rotation. |
Matrix4x4 | influenceToWorld | Influence to world matrix |
ProbeCapturePositionSettings(Vector3, Quaternion, Vector3, Quaternion, Matrix4x4)
Create new settings.
Declaration
public ProbeCapturePositionSettings(Vector3 proxyPosition, Quaternion proxyRotation, Vector3 referencePosition, Quaternion referenceRotation, Matrix4x4 influenceToWorld)
Parameters
Type | Name | Description |
---|---|---|
Vector3 | proxyPosition | The proxy position. |
Quaternion | proxyRotation | The proxy rotation. |
Vector3 | referencePosition | The reference position. |
Quaternion | referenceRotation | The reference rotation. |
Matrix4x4 | influenceToWorld | Influence to world matrix |
Fields
default
Default value.
Declaration
[Obsolete("Since 2019.3, use ProbeCapturePositionSettings.NewDefault() instead.")]
public static readonly ProbeCapturePositionSettings @default
Field Value
Type | Description |
---|---|
ProbeCapturePositionSettings |
influenceToWorld
The matrix for influence to world.
Declaration
public Matrix4x4 influenceToWorld
Field Value
Type | Description |
---|---|
Matrix4x4 |
proxyPosition
The proxy position.
Declaration
public Vector3 proxyPosition
Field Value
Type | Description |
---|---|
Vector3 |
proxyRotation
The proxy rotation.
Declaration
public Quaternion proxyRotation
Field Value
Type | Description |
---|---|
Quaternion |
referencePosition
The reference position.
This additional information is used to compute the actual capture position. (usually, the viewer position) (ProbeSettings.ProbeType)
Declaration
public Vector3 referencePosition
Field Value
Type | Description |
---|---|
Vector3 |
referenceRotation
The reference rotation.
This additional information is used to compute the actual capture position. (usually, the viewer rotation) (ProbeSettings.ProbeType)
Declaration
public Quaternion referenceRotation
Field Value
Type | Description |
---|---|
Quaternion |
Methods
ComputeFrom(HDProbe, Transform)
Compute the probe capture settings from an HDProbe and a reference transform.
Declaration
public static ProbeCapturePositionSettings ComputeFrom(HDProbe probe, Transform reference)
Parameters
Type | Name | Description |
---|---|---|
HDProbe | probe | The probe to extract settings from. |
Transform | reference | The reference transform. Use |
Returns
Type | Description |
---|---|
ProbeCapturePositionSettings | The probe capture position settings. |
ComputeFromMirroredReference(HDProbe, Vector3)
Compute the probe capture settings from an HDProbe and a reference position. The position will be mirrored based on the mirror position of the probe.
Declaration
public static ProbeCapturePositionSettings ComputeFromMirroredReference(HDProbe probe, Vector3 referencePosition)
Parameters
Type | Name | Description |
---|---|---|
HDProbe | probe | The probe to extract settings from. |
Vector3 | referencePosition | The reference position to use. |
Returns
Type | Description |
---|---|
ProbeCapturePositionSettings | The probe capture position setting. |
ComputeHash()
Compute a hash based on the settings' values
Declaration
public Hash128 ComputeHash()
Returns
Type | Description |
---|---|
Hash128 |
NewDefault()
Default value.
Declaration
public static ProbeCapturePositionSettings NewDefault()
Returns
Type | Description |
---|---|
ProbeCapturePositionSettings | The default value. |