Class AdditionalGIBakeRequestsManager

A manager to enqueue extra probe rendering outside of probe volumes.

Inheritance
object
AdditionalGIBakeRequestsManager
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public class AdditionalGIBakeRequestsManager

Properties

instance

Get the manager that governs the additional light probe rendering requests.

Declaration
public static AdditionalGIBakeRequestsManager instance { get; }
Property Value
Type Description
AdditionalGIBakeRequestsManager

Methods

DequeueRequest(int)

Dequeue a request for probe rendering.

Declaration
public void DequeueRequest(int probeInstanceID)
Parameters
Type Name Description
int probeInstanceID

The instance ID of the probe for which we want to dequeue a request.

EnqueueRequest(Vector3, int)

Enqueue a request for probe rendering at the specified location.

Declaration
public void EnqueueRequest(Vector3 capturePosition, int probeInstanceID)
Parameters
Type Name Description
Vector3 capturePosition

The position at which a probe is baked.
int probeInstanceID

The instance ID of the probe doing the request.

RetrieveProbe(EntityId, out Vector3, out SphericalHarmonicsL2, out float)

Retrieve the result of a capture request, it will return false if the request ID is invalid.

Declaration
public bool RetrieveProbe(EntityId probeInstanceID, out Vector3 pos, out SphericalHarmonicsL2 sh, out float validity)
Parameters
Type Name Description
EntityId probeInstanceID

The instance ID of the probe doing the request.
Vector3 pos

The position for which the computed SH coefficients are valid.
SphericalHarmonicsL2 sh

The output SH coefficients that have been computed.
float validity

The output validity that has been computed.
Returns
Type Description
bool

True if the request ID is valid.

RetrieveProbeSH(int, out SphericalHarmonicsL2, out Vector3)

Retrieve the result of a capture request, it will return false if the request has not been fulfilled yet or the request ID is invalid.

Declaration
[Obsolete("Use RetrieveProbe instead.", false)]
public bool RetrieveProbeSH(int probeInstanceID, out SphericalHarmonicsL2 sh, out Vector3 pos)
Parameters
Type Name Description
int probeInstanceID

The instance ID of the probe doing the request.
SphericalHarmonicsL2 sh

The output SH coefficients that have been computed.
Vector3 pos

The position for which the computed SH coefficients are valid.
Returns
Type Description
bool

Whether the request for light probe rendering has been fulfilled and sh is valid.

UpdatePositionForRequest(int, Vector3)

Update the capture location for the probe request.

Declaration
public void UpdatePositionForRequest(int probeInstanceID, Vector3 newPosition)
Parameters
Type Name Description
int probeInstanceID

The instance ID of the probe doing the request and that wants the capture position updated.
Vector3 newPosition

Extension Methods