Class AdditionalGIBakeRequestsManager

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

Inheritance
object
AdditionalGIBakeRequestsManager
Inherited Members
Namespace: UnityEngine.Experimental.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)

Enqueue a request for probe rendering at the specified location.

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

An ID that can be used to retrieve the data once it has been computed

EnqueueRequest(Vector3)

Enqueue a request for probe rendering at the specified location.

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

The position at which a probe is baked.
Returns
Type Description
int

An ID that can be used to retrieve the data once it has been computed

RetrieveProbeSH(int, out SphericalHarmonicsL2)

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
public bool RetrieveProbeSH(int requestID, out SphericalHarmonicsL2 sh)
Parameters
Type Name Description
int requestID

The request ID that has been given by the manager through a previous EnqueueRequest.
SphericalHarmonicsL2 sh

The output SH coefficients that have been computed.
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 int UpdatePositionForRequest(int requestID, Vector3 newPosition)
Parameters
Type Name Description
int requestID

The request ID that has been given by the manager through a previous EnqueueRequest.
Vector3 newPosition
Returns
Type Description
int

Extension Methods