Class AdaptiveProbeVolumes

Class responsible for baking of Probe Volumes

Inheritance
object
AdaptiveProbeVolumes
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Editor.dll
Syntax
[InitializeOnLoad]
public class AdaptiveProbeVolumes

Properties

isRunning

Returns true when the bake job is running, false otherwise (Read Only).

Declaration
public static bool isRunning { get; }
Property Value
Type Description
bool

Methods

BakeAdditionalRequest(int)

Request additional bake request manager to recompute baked data for a given request

Declaration
public static void BakeAdditionalRequest(int probeInstanceID)
Parameters
Type Name Description
int probeInstanceID

The instance ID of the probe doing the request.

BakeAdditionalRequests(int[])

Request additional bake request manager to recompute baked data for an array of requests

Declaration
public static void BakeAdditionalRequests(int[] probeInstanceIDs)
Parameters
Type Name Description
int[] probeInstanceIDs

Array of instance IDs of the probes doing the request.

BakeAsync()

Starts an asynchronous bake job for Adaptive Probe Volumes.

Declaration
public static bool BakeAsync()
Returns
Type Description
bool

Returns true if the bake was successfully started.

Cancel()

Cancels the currently running asynchronous bake job.

Declaration
public static bool Cancel()
Returns
Type Description
bool

Returns true if baking was successfully cancelled.

GetLightingBakerOverride()

Used to override the lighting baking system.

Declaration
public static AdaptiveProbeVolumes.LightingBaker GetLightingBakerOverride()
Returns
Type Description
AdaptiveProbeVolumes.LightingBaker

The baker override or null if none is set.

GetSkyOcclusionBakerOverride()

Get the current sky occlusion baker override

Declaration
public static AdaptiveProbeVolumes.SkyOcclusionBaker GetSkyOcclusionBakerOverride()
Returns
Type Description
AdaptiveProbeVolumes.SkyOcclusionBaker

The baker override or null if none is set.

GetVirtualOffsetBakerOverride()

Used to override the virtual offset baking system.

Declaration
public static AdaptiveProbeVolumes.VirtualOffsetBaker GetVirtualOffsetBakerOverride()
Returns
Type Description
AdaptiveProbeVolumes.VirtualOffsetBaker

The baker override or null if none is set.

SetLightingBakerOverride(LightingBaker)

Used to override the lighting baking system.

Declaration
public static void SetLightingBakerOverride(AdaptiveProbeVolumes.LightingBaker baker)
Parameters
Type Name Description
AdaptiveProbeVolumes.LightingBaker baker

The baker override or null to use the default system.

SetSkyOcclusionBakerOverride(SkyOcclusionBaker)

Used to override the sky occlusion baking system.

Declaration
public static void SetSkyOcclusionBakerOverride(AdaptiveProbeVolumes.SkyOcclusionBaker baker)
Parameters
Type Name Description
AdaptiveProbeVolumes.SkyOcclusionBaker baker

The baker override or null to use the default system.

SetVirtualOffsetBakerOverride(VirtualOffsetBaker)

Used to override the virtual offset baking system.

Declaration
public static void SetVirtualOffsetBakerOverride(AdaptiveProbeVolumes.VirtualOffsetBaker baker)
Parameters
Type Name Description
AdaptiveProbeVolumes.VirtualOffsetBaker baker

The baker override or null to use the default system.

Extension Methods