Struct ProbeCapturePositionSettings

Settings to use when capturing a probe.

Namespace: UnityEngine.Experimental.Rendering.HDPipeline

Syntax

[Serializable]
public struct ProbeCapturePositionSettings

Constructors

ProbeCapturePositionSettings(Vector3, Quaternion)

Create a new settings with only the probe transform.

Declaration

public ProbeCapturePositionSettings(Vector3 proxyPosition, Quaternion proxyRotation)

Parameters

Type	Name	Description
Vector3	proxyPosition	The proxy position.
Quaternion	proxyRotation	The proxy rotation.

ProbeCapturePositionSettings(Vector3, Quaternion, Vector3, Quaternion)

Create new settings.

Declaration

public ProbeCapturePositionSettings(Vector3 proxyPosition, Quaternion proxyRotation, Vector3 referencePosition, Quaternion referenceRotation)

Parameters

Type	Name	Description
Vector3	proxyPosition	The proxy position.
Quaternion	proxyRotation	The proxy rotation.
Vector3	referencePosition	The reference position.
Quaternion	referenceRotation	The reference rotation.

Fields

default

Default value.

Declaration

public static readonly ProbeCapturePositionSettings default

Field Value

Type	Description
ProbeCapturePositionSettings

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. (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. (ProbeSettings.ProbeType)

Declaration

public Quaternion referenceRotation

Field Value

Type	Description
Quaternion

Methods

ComputeFrom(HDProbe, Transform)

Declaration

public static ProbeCapturePositionSettings ComputeFrom(HDProbe probe, Transform reference)

Parameters

Type	Name	Description
HDProbe	probe
Transform	reference

Returns

Type	Description
ProbeCapturePositionSettings

ComputeFromMirroredReference(HDProbe, Vector3)

Declaration

public static ProbeCapturePositionSettings ComputeFromMirroredReference(HDProbe probe, Vector3 referencePosition)

Parameters

Type	Name	Description
HDProbe	probe
Vector3	referencePosition

Returns

Type	Description
ProbeCapturePositionSettings

ComputeHash()

Declaration

public Hash128 ComputeHash()

Returns

Type	Description
Hash128