Scripting API

VolumeManager

class in UnityEngine.Rendering · Unity.RenderPipelines.Core.Runtime

25 of 25 of Unity's members
In Tassix

Blends the active Volumes into stacks: each stack starts from the defaults (the components' own values, then the default profiles' overrides), then each volume (lowest priority first) moves the values it overrides toward its own by its influence.

Properties 8

Type[] baseComponentTypeArray { get; }

Every non-abstract VolumeComponent type loaded.

IEnumerable<Type> baseComponentTypes { get; }
System.Collections.ObjectModel.ReadOnlyCollection<VolumeProfile>? customDefaultProfiles { get; }
VolumeProfile? globalDefaultProfile { get; }
static VolumeManager instance { get; }
bool isInitialized { get; }
VolumeProfile? qualityDefaultProfile { get; }
VolumeStack stack { get; set; }

The main stack (created on first use).

Methods 18

void CheckDefaultVolumeState()
void CheckStack(VolumeStack s)
VolumeStack CreateStack()
void Deinitialize()
void DestroyStack(VolumeStack s)
VolumeComponent? GetVolumeComponentDefaultState(Type volumeComponentType)
Volume[] GetVolumes(LayerMask layerMask)
void Initialize(VolumeProfile? globalDefaultVolumeProfile = null, VolumeProfile? qualityDefaultVolumeProfile = null)
bool IsComponentActiveInMask<T>(LayerMask layerMask)
void OnVolumeComponentChanged(VolumeComponent component)
void OnVolumeProfileChanged(VolumeProfile profile)
void Register(Volume volume)
void ResetMainStack()
void SetCustomDefaultProfiles(List<VolumeProfile>? profiles)
void SetGlobalDefaultProfile(VolumeProfile? profile)
void SetQualityDefaultProfile(VolumeProfile? profile)
void Unregister(Volume volume)
void Update(Transform? trigger, LayerMask layerMask)
void Update(VolumeStack stack, Transform? trigger, LayerMask layerMask)

Blends the volumes on layerMask's layers into stack, as seen from trigger (global volumes only without one).