Class ProbeVolumeBakingSet

An Asset which holds a set of settings to use with a Probe Reference Volume.

Inheritance
object
Object
ScriptableObject
ProbeVolumeBakingSet
Implements
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public sealed class ProbeVolumeBakingSet : ScriptableObject, ISerializationCallbackReceiver

Fields

minDistanceBetweenProbes

The minimum distance between two probes in meters.

Declaration
[Min(0.1)]
public float minDistanceBetweenProbes
Field Value
Type Description
float

minRendererVolumeSize

Specifies the minimum bounding box volume of renderers to consider placing probes around.

Declaration
[Min(0)]
public float minRendererVolumeSize
Field Value
Type Description
float

probeOffset

Offset on world origin used during baking. Can be used to have cells on positions that are not multiples of the probe spacing.

Declaration
[SerializeField]
public Vector3 probeOffset
Field Value
Type Description
Vector3

renderersLayerMask

Layer mask filter for all renderers.

Declaration
public LayerMask renderersLayerMask
Field Value
Type Description
LayerMask

simplificationLevels

How many levels contains the probes hierarchical structure.

Declaration
[Range(2, 5)]
public int simplificationLevels
Field Value
Type Description
int

skyOcclusion

Specifies whether the baking set will have sky handled dynamically.

Declaration
public bool skyOcclusion
Field Value
Type Description
bool

skyOcclusionAverageAlbedo

Average albedo for dynamic sky bounces

Declaration
[Range(0, 1)]
public float skyOcclusionAverageAlbedo
Field Value
Type Description
float

skyOcclusionBackFaceCulling

Sky Occlusion backface culling

Declaration
public bool skyOcclusionBackFaceCulling
Field Value
Type Description
bool

skyOcclusionBakingBounces

Controls the number of bounces per light path for dynamic sky baking.

Declaration
[Range(0, 5)]
public int skyOcclusionBakingBounces
Field Value
Type Description
int

skyOcclusionBakingSamples

Controls the number of samples per probe for dynamic sky baking.

Declaration
public int skyOcclusionBakingSamples
Field Value
Type Description
int

skyOcclusionShadingDirection

Bake sky shading direction.

Declaration
public bool skyOcclusionShadingDirection
Field Value
Type Description
bool

Properties

cellSizeInBricks

The size of a Cell in number of bricks.

Declaration
public int cellSizeInBricks { get; }
Property Value
Type Description
int

cellSizeInMeters

Size of the cell in meters.

Declaration
public float cellSizeInMeters { get; }
Property Value
Type Description
float

lightingScenarios

The list of lighting scenarios.

Declaration
public IReadOnlyList<string> lightingScenarios { get; }
Property Value
Type Description
IReadOnlyList<string>

maxSubdivision

Maximum subdivision in the structure.

Declaration
public int maxSubdivision { get; }
Property Value
Type Description
int

minBrickSize

Minimum size of a brick in meters.

Declaration
public float minBrickSize { get; }
Property Value
Type Description
float

sceneGUIDs

The list of scene GUIDs.

Declaration
public IReadOnlyList<string> sceneGUIDs { get; }
Property Value
Type Description
IReadOnlyList<string>

Methods

IsEquivalent(ProbeVolumeBakingSet)

Determines if the Probe Reference Volume Profile is equivalent to another one.

Declaration
public bool IsEquivalent(ProbeVolumeBakingSet otherProfile)
Parameters
Type Name Description
ProbeVolumeBakingSet otherProfile

The profile to compare with.
Returns
Type Description
bool

Whether the Probe Reference Volume Profile is equivalent to another one.

RemoveScenario(string)

Tries to remove a given scenario from the baking set. This will delete associated baked data.

Declaration
public bool RemoveScenario(string name)
Parameters
Type Name Description
string name

The name of the scenario to remove
Returns
Type Description
bool

Whether the scenario was successfully deleted.

RemoveScene(string)

Removes a scene from the baking set.

Declaration
public void RemoveScene(string guid)
Parameters
Type Name Description
string guid

The GUID of the scene to remove.

RenameScenario(string, string)

Renames a given scenario.

Declaration
public string RenameScenario(string scenario, string newName)
Parameters
Type Name Description
string scenario

The original scenario name.
string newName

The requested new scenario name.
Returns
Type Description
string

The new scenario name. The is different than the requested name in case a scenario with the same name already exists.

SetAllSceneBaking(bool)

Changes the baking status of all scenes. Objects in scenes disabled for baking will still contribute to lighting for other scenes.

Declaration
public void SetAllSceneBaking(bool enableForBaking)
Parameters
Type Name Description
bool enableForBaking

Wheter or not scenes should be included when baking lighting.

SetSceneBaking(string, bool)

Changes the baking status of a scene. Objects in scenes disabled for baking will still contribute to lighting for other scenes.

Declaration
public void SetSceneBaking(string guid, bool enableForBaking)
Parameters
Type Name Description
string guid

The GUID of the scene to remove.
bool enableForBaking

Wheter or not this scene should be included when baking lighting.

TryAddScenario(string)

Tries to add a lighting scenario to the baking set.

Declaration
public bool TryAddScenario(string name)
Parameters
Type Name Description
string name

The name of the scenario to add.
Returns
Type Description
bool

Whether the scenario was successfully created.

TryAddScene(string)

Tries to add a scene to the baking set.

Declaration
public bool TryAddScene(string guid)
Parameters
Type Name Description
string guid

The GUID of the scene to add.
Returns
Type Description
bool

Whether the scene was successfull added to the baking set.

Implements

Extension Methods