Scripting Support (C#)

advanced scripting

Beautify 3 (URP) · Scripting Support (C#)

Class: Beautify (namespace Beautify.Universal) Volume override.
This page documents the user-facing API (public parameters and enums). URP internal overrides (for example IsActive()) and internal helper types are intentionally omitted.

Getting Started

There are two ways to access Beautify properties at runtime. Both modify the same underlying Volume data:

Singleton shortcut (most common)

The BeautifySettings singleton provides quick access to Beautify properties. It automatically finds the first Volume in the scene that contains a Beautify override and reads its profile. This is the fastest way when you have a single Beautify volume:

using Beautify.Universal;

// Read or change any property via the singleton
BeautifySettings.settings.brightness.Override(1.2f);
BeautifySettings.settings.bloomIntensity.Override(0.5f);
BeautifySettings.settings.depthOfField.Override(true);

Direct Volume access (multiple volumes)

If your scene has multiple volumes with different Beautify profiles (e.g. indoor vs outdoor areas), use the standard URP TryGet pattern to target a specific volume:

using Beautify.Universal;
using UnityEngine.Rendering;

var volume = GetComponent<Volume>();
if (volume.profile.TryGet<Beautify>(out var beautify)) {
    beautify.sharpenIntensity.Override(4f);
    beautify.bloomIntensity.Override(0.5f);
}

URP handles blending between volumes automatically based on their weight, priority, and blend distance. You only need one BeautifySettings component in the scene regardless of how many volumes you have - the singleton is just a convenience shortcut, not a requirement.

Parameters (Fields)

All members below are public fields on Beautify (Volume parameters). Use Override(value) at runtime to force a value regardless of profile blending, or set value and overrideState.

General Settings

Performance

BoolParameter directWrite

Writes result directly to camera target saving intermediate blits. This option will overwrite any previous post-processing effects so make sure there's no other effects being executed besides Beautify. Default: false.

BoolParameter downsampling

Reduces camera target before applying Beautify effects This option can contribute to compensate render scale if it's set to greater than 1 or to improve performance. Default: false.

BoolParameter downsamplingBilinear

Enables bilinear filtering when using downsampling. Default: false.

BeautifyDownsamplingModeParameter downsamplingMode

How downsampling is applied. Default: DownsamplingMode.BeautifyEffectsOnly.

ClampedFloatParameter downsamplingMultiplier

Downsampling multiplier. Default: 1. Range: 1 to 64f.

BoolParameter ignoreDepthTexture

Doesn't request depth texture - effects or options that rely on depth will be disabled. Default: false.

BoolParameter turboMode

Sharpen, bloom and anamorphic flares will reduce quality a bit to improve performance. This option can be useful on less powerful platforms or devices. Default: false.

Misc

FloatParameter compareLineAngle

Sets the separator line angle (free-angle compare style). Default: 1.4f. Range: -Mathf.PI to Mathf.PI.

FloatParameter compareLineWidth

Controls the separator line width in compare mode. Default: 0.002f. Range: 0.0001f to 0.05f.

BoolParameter compareMode

Enables compare mode to visualize Beautify on/off using a split view. Default: false.

ClampedFloatParameter comparePanning

Controls the panning amount of the compare view. Default: 0.25f. Range: 0 to 0.5f.

BeautifyCompareStyleParameter compareStyle

Selects the compare mode layout. Default: new BeautifyCompareStyleParameter().

BeautifyDebugOutputParameter debugOutput

Selects a debug output (buffers useful for diagnosing Bloom/DoF/etc.). Default: new BeautifyDebugOutputParameter().

BoolParameter disabled

Ignore all Beautify effects. This option overrides any existing profile. Default: false.

BoolParameter flipY

Inverts vertical orientation of image when blitting. This option can be used to overcome an issue in certain versions of URP. Default: false.

BoolParameter hideInSceneView

Prevents Beautify from rendering in the Scene view camera. Default: false.

Image Enhancement

Dithering

ClampedFloatParameter ditherIntensity

Controls the intensity of Dithering. Default: 0.0f. Range: 0 to 0.02f.

Sharpen

ClampedFloatParameter sharpenClamp

Reduces final sharpen modifier. Default: 0.45f. Range: 0 to 1f.

ClampedFloatParameter sharpenDepthThreshold

By default, sharpen ignores edges to avoid aliasing. Increase this property to also include edges. Edge detection is based on scene depth. Default: 0.035f. Range: 0f to 0.05f.

BeautifyLayerMaskParameter sharpenExclusionLayerMask

Layers to exclude from sharpening. Default: 0.

ClampedFloatParameter sharpenIntensity

Controls the intensity of Sharpen. Default: 0f. Range: 0f to 25f.

MinMaxFloatParameter sharpenMinMaxDepth

Restricts sharpen to a scene depth range. Default: new Vector2(0, 0.999f). Range: 0 to 1.1f.

ClampedFloatParameter sharpenMinMaxDepthFallOff

Depth Range FallOff parameter for Sharpen. Default: 0f. Range: 0f to 1f. Note: declared/serialized but not referenced by runtime code outside Beautify.cs..

ClampedFloatParameter sharpenMotionRestoreSpeed

The speed at which the sharpen intensity restores when camera stops moving. Default: 0.5f. Range: 0.01f to 5f.

ClampedFloatParameter sharpenMotionSensibility

Reduces sharpen gracefully when camera moves or rotates. This setting reduces flickering while contributes to a motion blur sense. Default: 0.5f. Range: 0 to 1f.

ClampedFloatParameter sharpenRelaxation

Reduces sharpen intensity based on area brightness. Default: 0.08f. Range: 0 to 0.2f.

Edge Anti-aliasing

FloatParameter antialiasDepthAttenuation

Reduces antialias effect on the distance. Default: 0.

ClampedFloatParameter antialiasDepthThreshold

Minimum difference in depth between neighbor pixels to determine if edge antialiasing should be applied. Default: 0.000001f. Range: 0 to 0.001f.

ClampedFloatParameter antialiasSpread

The maximum extent of antialiasing. Default: 3f. Range: 0.1f to 8f.

ClampedFloatParameter antialiasStrength

Strength of the integrated edge antialiasing. A value of 0 disables this feature. Default: 0. Range: 0 to 20.

Tonemapping & Color Grading

White Balance

ClampedFloatParameter colorTemp

Temperature parameter for White Balance. Default: 6550f. Range: 1000f to 40000f.

ClampedFloatParameter colorTempBlend

Blend parameter for White Balance. Default: 0f. Range: 0f to 1f.

LUT

BoolParameter lut

Enable LUT for LUT. Default: false.

ClampedFloatParameter lutIntensity

Controls the intensity of LUT. Default: 0f. Range: 0 to 1f.

TextureParameter lutTexture

LUT Texture parameter for LUT. Default: null.

Misc

ClampedFloatParameter brightness

brightness parameter for Misc. Default: 1.0f. Range: 0f to 2f.

ClampedFloatParameter contrast

contrast parameter for Misc. Default: 1.0f. Range: 0.5f to 1.5f.

ClampedFloatParameter daltonize

daltonize parameter for Misc. Default: 0f. Range: 0f to 2f.

ClampedFloatParameter saturate

saturate parameter for Misc. Default: 0f. Range: -2f to 3f.

ClampedFloatParameter sepia

sepia parameter for Misc. Default: 0f. Range: 0f to 1f.

ColorParameter tintColor

tint Color parameter for Misc. Default: new Color(1, 1, 1, 0).

BeautifyTonemapOperatorParameter tonemap

tonemap parameter for Misc. Default: TonemapOperator.Linear.

FloatParameter tonemapAGXGamma

Gamma applied to the AGX tonemapper. Default: 2.5f. Range: 0 to 5f.

FloatParameter tonemapBrightnessPost

Brightness multiplier after applying tonemap operator. Default: 1f.

FloatParameter tonemapExposurePre

Brightness multiplier before applying tonemap operator. Default: 1f.

FloatParameter tonemapMaxInputBrightness

Clamps input image brightness to avoid artifacts due to NaN or out of range pixel values. Default: 1000f.

Lens & Lighting Effects

Bloom

BoolParameter bloomAntiflicker

Toggles Bloom: Antiflicker. Default: false.

ClampedFloatParameter bloomBoost0

Layer 1 Boost parameter for Bloom. Default: 0f. Range: 0 to 3f.

ClampedFloatParameter bloomBoost1

Layer 2 Boost parameter for Bloom. Default: 0f. Range: 0 to 3f.

ClampedFloatParameter bloomBoost2

Layer 3 Boost parameter for Bloom. Default: 0f. Range: 0 to 3f.

ClampedFloatParameter bloomBoost3

Layer 4 Boost parameter for Bloom. Default: 0f. Range: 0 to 3f.

ClampedFloatParameter bloomBoost4

Layer 5 Boost parameter for Bloom. Default: 0f. Range: 0 to 3f.

ClampedFloatParameter bloomBoost5

Layer 6 Boost parameter for Bloom. Default: 0f. Range: 0 to 3f.

BoolParameter bloomConservativeThreshold

A convervative threshold keeps the ratio of the rgb values after applying the thresholding Default: false.

BoolParameter bloomCustomize

Toggles Bloom: Customize. Default: false.

FloatParameter bloomDepthAtten

Depth Attenuation parameter for Bloom. Default: 0f.

BoolParameter bloomExcludeLayers

Use Layers for Bloom. Default: false.

BeautifyLayerMaskParameter bloomExclusionLayerMask

Layers parameter for Bloom. Default: 0.

FloatParameter bloomIntensity

Controls the intensity of Bloom. Default: 0.

BeautifyBloomLayersFilterMethodParameter bloomLayersFilterMethod

Choose if bloom should be applied only to specified layers or if bloom should be excluded from the specified layers. Default: BloomLayersFilterMethod.ExcludeSelectedLayers.

FloatParameter bloomMaxBrightness

Max Brightness parameter for Bloom. Default: 1000f.

FloatParameter bloomNearAtten

Near Attenuation parameter for Bloom. Default: 0f.

BoolParameter bloomQuickerBlur

Toggles Bloom: Quicker Blur. Default: false.

ClampedIntParameter bloomResolution

Resolution parameter for Bloom. Default: 1. Range: 1 to 10.

ClampedFloatParameter bloomSpread

Spread parameter for Bloom. Default: 0.5f. Range: 0 to 1.

FloatParameter bloomThreshold

Controls the threshold used by Bloom. Default: 0.75f.

ColorParameter bloomTint

Use Alpha channel to blend original bloom color with the tinted color. Default: new Color(0.5f, 0.5f, 1f, 0f).

ColorParameter bloomTint0

Tint color setting used by Bloom. Default: Color.white.

ColorParameter bloomTint1

Tint color setting used by Bloom. Default: Color.white.

ColorParameter bloomTint2

Tint color setting used by Bloom. Default: Color.white.

ColorParameter bloomTint3

Tint color setting used by Bloom. Default: Color.white.

ColorParameter bloomTint4

Tint color setting used by Bloom. Default: Color.white.

ColorParameter bloomTint5

Tint color setting used by Bloom. Default: Color.white.

ClampedFloatParameter bloomWeight0

Layer 1 Weight parameter for Bloom. Default: 0.5f. Range: 0 to 1f.

ClampedFloatParameter bloomWeight1

Layer 2 Weight parameter for Bloom. Default: 0.5f. Range: 0 to 1f.

ClampedFloatParameter bloomWeight2

Layer 3 Weight parameter for Bloom. Default: 0.5f. Range: 0 to 1f.

ClampedFloatParameter bloomWeight3

Layer 4 Weight parameter for Bloom. Default: 0.5f. Range: 0 to 1f.

ClampedFloatParameter bloomWeight4

Layer 5 Weight parameter for Bloom. Default: 0.5f. Range: 0 to 1f.

ClampedFloatParameter bloomWeight5

Layer 6 Weight parameter for Bloom. Default: 0.5f. Range: 0 to 1f.

Anamorphic Flares

BoolParameter anamorphicFlaresAntiflicker

Toggles Anamorphic Flares: Antiflicker. Default: false.

BoolParameter anamorphicFlaresConservativeThreshold

A convervative threshold keeps the ratio of the rgb values after applying the thresholding Default: false.

FloatParameter anamorphicFlaresDepthAtten

Depth Attenuation parameter for Anamorphic Flares. Default: 0f.

BoolParameter anamorphicFlaresExcludeLayers

Use Layers for Anamorphic Flares. Default: false.

BeautifyLayerMaskParameter anamorphicFlaresExclusionLayerMask

Layers parameter for Anamorphic Flares. Default: 0.

FloatParameter anamorphicFlaresIntensity

Controls the intensity of Anamorphic Flares. Default: 0f.

BeautifyBloomLayersFilterMethodParameter anamorphicFlaresLayersFilterMethod

Choose if the effect should be applied only on the specified layers or if it should be excluded instead. Default: BloomLayersFilterMethod.ExcludeSelectedLayers.

FloatParameter anamorphicFlaresMaxBrightness

Max Brightness parameter for Anamorphic Flares. Default: 1000f.

FloatParameter anamorphicFlaresNearAtten

Near Attenuation parameter for Anamorphic Flares. Default: 0f.

BoolParameter anamorphicFlaresQuickerBlur

Toggles Anamorphic Flares: Quicker Blur. Default: false.

ClampedIntParameter anamorphicFlaresResolution

Resolution parameter for Anamorphic Flares. Default: 1. Range: 1 to 10.

ClampedFloatParameter anamorphicFlaresSpread

Spread parameter for Anamorphic Flares. Default: 1f. Range: 0.1f to 2f.

FloatParameter anamorphicFlaresThreshold

Controls the threshold used by Anamorphic Flares. Default: 0.75f.

ColorParameter anamorphicFlaresTint

Ignore all Beautify effects. This option overrides any existing profile. Default: new Color(0.5f, 0.5f, 1f, 0f).

BoolParameter anamorphicFlaresVertical

Toggles Anamorphic Flares: Vertical. Default: false.

Sun Flares

FloatParameter sunFlaresAttenSpeed

Controls a speed parameter used by Sun Flares. Default: 30f.

ClampedFloatParameter sunFlaresCoronaRays1AngleOffset

Angle Offset parameter for Sun Flares. Default: 0f. Range: 0 to 2f * Mathf.PI.

ClampedFloatParameter sunFlaresCoronaRays1Length

Length parameter for Sun Flares. Default: 0.02f. Range: 0 to 0.2f.

ClampedFloatParameter sunFlaresCoronaRays1Spread

Spread parameter for Sun Flares. Default: 0.001f. Range: 0 to 0.1f.

ClampedIntParameter sunFlaresCoronaRays1Streaks

Streaks parameter for Sun Flares. Default: 12. Range: 2 to 30.

ClampedFloatParameter sunFlaresCoronaRays2AngleOffset

Angle Offset parameter for Sun Flares. Default: 0f. Range: 0 to 2f * Mathf.PI.

ClampedFloatParameter sunFlaresCoronaRays2Length

Length parameter for Sun Flares. Default: 0.05f. Range: 0 to 0.2f.

ClampedFloatParameter sunFlaresCoronaRays2Spread

Spread parameter for Sun Flares. Default: 0.1f. Range: 0 to 0.1f.

ClampedIntParameter sunFlaresCoronaRays2Streaks

Streaks parameter for Sun Flares. Default: 12. Range: 2 to 30.

BeautifySunFlaresDepthOcclusionModeParameter sunFlaresDepthOcclusionMode

None = no depth buffer checking. Simple = sample depth buffer at Sun position. Smooth = sample 4 positions around Sun position and interpolate value across frames. Default: SunFlaresDepthOcclusionMode.Simple.

ClampedFloatParameter sunFlaresDepthOcclusionThreshold

Occlusion Threshold parameter for Sun Flares. Default: 0.5f. Range: 0 to 1f.

ClampedIntParameter sunFlaresDownsampling

Downsampling parameter for Sun Flares. Default: 1. Range: 1 to 5.

ClampedFloatParameter sunFlaresGhosts1Brightness

Brightness parameter for Sun Flares. Default: 0.037f. Range: 0f to 1f.

ClampedFloatParameter sunFlaresGhosts1Offset

Offset parameter for Sun Flares. Default: 1.04f. Range: -3f to 3f.

ClampedFloatParameter sunFlaresGhosts1Size

Size parameter for Sun Flares. Default: 0.03f. Range: 0f to 1f.

ClampedFloatParameter sunFlaresGhosts2Brightness

Brightness parameter for Sun Flares. Default: 0.03f. Range: 0f to 1f.

ClampedFloatParameter sunFlaresGhosts2Offset

Offset parameter for Sun Flares. Default: 0.71f. Range: -3f to 3f.

ClampedFloatParameter sunFlaresGhosts2Size

Size parameter for Sun Flares. Default: 0.1f. Range: 0f to 1f.

ClampedFloatParameter sunFlaresGhosts3Brightness

Brightness parameter for Sun Flares. Default: 0.025f. Range: 0f to 1f.

ClampedFloatParameter sunFlaresGhosts3Offset

Offset parameter for Sun Flares. Default: 0.31f. Range: -3f to 3f.

ClampedFloatParameter sunFlaresGhosts3Size

Size parameter for Sun Flares. Default: 0.24f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresGhosts4Brightness

Brightness parameter for Sun Flares. Default: 0.017f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresGhosts4Offset

Offset parameter for Sun Flares. Default: 0f. Range: -3f to 3f.

ClampedFloatParameter sunFlaresGhosts4Size

Size parameter for Sun Flares. Default: 0.016f. Range: 0f to 1f.

ClampedFloatParameter sunFlaresHaloAmplitude

Amplitude parameter for Sun Flares. Default: 15.1415f. Range: 0 to 50f.

ClampedFloatParameter sunFlaresHaloIntensity

Controls the intensity of Sun Flares. Default: 0.01f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresHaloOffset

Offset parameter for Sun Flares. Default: 0.22f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresIntensity

Global Intensity parameter for Sun Flares. Default: 0.0f. Range: 0 to 1f.

BeautifyLayerMaskParameter sunFlaresLayerMask

Occluding Layer Mask parameter for Sun Flares. Default: -1.

BoolParameter sunFlaresRotationDeadZone

Toggles Sun Flares: Rotation Dead Zone. Default: false.

ClampedFloatParameter sunFlaresSolarWindSpeed

Controls a speed parameter used by Sun Flares. Default: 0.01f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresSunDiskSize

Disk Size parameter for Sun Flares. Default: 0.05f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresSunIntensity

Controls the intensity of Sun Flares. Default: 0.1f. Range: 0 to 1f.

ClampedFloatParameter sunFlaresSunRayDiffractionIntensity

Diffraction Intensity parameter for Sun Flares. Default: 3.5f. Range: 0 to 25f.

ClampedFloatParameter sunFlaresSunRayDiffractionThreshold

Diffraction Threshold parameter for Sun Flares. Default: 0.13f. Range: 0 to 1f.

ColorParameter sunFlaresTint

Tint color setting used by Sun Flares. Default: new Color(1, 1, 1).

BoolParameter sunFlaresUseLayerMask

Specifies if occluding objects will be detected by raycasting. Default: false.

Lens Dirt

FloatParameter lensDirtIntensity

Controls the intensity of Lens Dirt. Default: 0f.

ClampedIntParameter lensDirtSpread

Spread parameter for Lens Dirt. Default: 3. Range: 3 to 5.

TextureParameter lensDirtTexture

Dirt Texture parameter for Lens Dirt. Default: null.

ClampedFloatParameter lensDirtThreshold

Controls the threshold used by Lens Dirt. Default: 0.5f. Range: 0 to 1f.

Chromatic Aberration

FloatParameter chromaticAberrationIntensity

Controls the intensity of Chromatic Aberration. Default: 0f. Range: 0f to 0.1f.

BoolParameter chromaticAberrationSeparatePass

Toggles Chromatic Aberration: Separate Pass. Default: false.

ClampedFloatParameter chromaticAberrationShift

Hue Shift parameter for Chromatic Aberration. Default: 0. Range: -1 to 1.

FloatParameter chromaticAberrationSmoothing

Smoothing parameter for Chromatic Aberration. Default: 0f. Range: 0f to 32f.

Depth of Field

BoolParameter depthOfField

Enable for Depth of Field. Default: false.

BoolParameter depthOfFieldAffectsBloom

When enabled, bloom and anamorphic flares will be computed after depth of field is applied Default: false.

BoolParameter depthOfFieldAlphaTestDoubleSided

When enabled, transparent geometry is rendered with cull off. Default: false.

BeautifyLayerMaskParameter depthOfFieldAlphaTestLayerMask

Layer Mask parameter for Depth of Field. Default: 1.

BoolParameter depthOfFieldAlphaTestSupport

When enabled, transparent materials using alpha clipping will be included in the transparent mask Default: false.

FloatParameter depthOfFieldAperture

Aperture parameter for Depth of Field. Default: 2.8f.

FloatParameter depthOfFieldAutofocusDistanceShift

Custom distance adjustment (positive or negative) Default: 0.

BeautifyLayerMaskParameter depthOfFieldAutofocusLayerMask

Layer Mask parameter for Depth of Field. Default: -1.

FloatParameter depthOfFieldAutofocusMaxDistance

Max Distance parameter for Depth of Field. Default: 10000.

FloatParameter depthOfFieldAutofocusMinDistance

Min Distance parameter for Depth of Field. Default: 0.

Vector2Parameter depthOfFieldAutofocusViewportPoint

Viewport Point parameter for Depth of Field. Default: new Vector2Parameter(new Vector2(0.5f, 0.5f)).

BoolParameter depthOfFieldBokeh

Toggles Depth of Field: Bokeh Effect. Default: true.

BeautifyDoFBokehCompositionParameter depthOfFieldBokehComposition

Specifies if the pass to compute bokeh is integrated (faster) or separated (stronger) Default: DoFBokehComposition.Integrated.

ClampedFloatParameter depthOfFieldBokehIntensity

Controls the intensity of Depth of Field. Default: 2f. Range: 0 to 8f.

ClampedFloatParameter depthOfFieldBokehThreshold

Controls the threshold used by Depth of Field. Default: 1f. Range: 0f to 3f.

BeautifyDoFCameraSettingsParameter depthOfFieldCameraSettings

Camera Lens Settings parameter for Depth of Field. Default: DoFCameraSettings.Classic.

FloatParameter depthOfFieldDistance

Distance parameter for Depth of Field. Default: 10f.

ClampedIntParameter depthOfFieldDownsampling

Downsampling parameter for Depth of Field. Default: 2. Range: 1 to 5.

ClampedFloatParameter depthOfFieldFallbackFadeDuration

Duration in seconds to gracefully fade out/in the DoF effect when target is not visible Default: 0.5f. Range: 0.01f to 3f.

BeautifyDoFFilterModeParameter depthOfFieldFilterMode

Filter Mode parameter for Depth of Field. Default: FilterMode.Bilinear.

ClampedFloatParameter depthOfFieldFocalLength

Focal Length parameter for Depth of Field. Default: 0.050f. Range: 0.005f to 0.5f.

ClampedFloatParameter depthOfFieldFocalLengthReal

The distance between the lens center and the camera's sensor in mm. Default: 50. Range: 1 to 300.

BeautifyDoFFocusModeParameter depthOfFieldFocusMode

Focus Mode parameter for Depth of Field. Default: DoFFocusMode.FixedDistance.

Vector3Parameter depthOfFieldFocusPosition

World position to focus on Default: new Vector3Parameter(Vector3.zero).

ClampedFloatParameter depthOfFieldFocusSpeed

Controls a speed parameter used by Depth of Field. Default: 1f. Range: 0.001f to 5f.

BoolParameter depthOfFieldForegroundBlur

Toggles Depth of Field: Foreground Blur. Default: true.

BoolParameter depthOfFieldForegroundBlurHQ

Toggles Depth of Field: Blur HQ. Default: false.

ClampedFloatParameter depthOfFieldForegroundBlurHQSpread

Blur Spread parameter for Depth of Field. Default: 4. Range: 0 to 32.

FloatParameter depthOfFieldForegroundDistance

Distance parameter for Depth of Field. Default: 0.25f.

ClampedFloatParameter depthOfFieldFStop

The F-stop or F-number is the relation between the focal length and the diameter of the aperture Default: 2. Range: 0.3f to 32.

ClampedFloatParameter depthOfFieldImageSensorHeight

Represents the height of the virtual image sensor. By default, it uses a 24mm image sensor of a classic full-frame camera Default: 24. Range: 1 to 48.

FloatParameter depthOfFieldMaxBlurRadius

Max Blur Radius parameter for Depth of Field. Default: 1000f.

FloatParameter depthOfFieldMaxBrightness

Max Brightness parameter for Depth of Field. Default: 1000f.

ClampedFloatParameter depthOfFieldMaxDistance

Max Depth parameter for Depth of Field. Default: 1f. Range: 0 to 1f.

ClampedIntParameter depthOfFieldMaxSamples

Sample Count parameter for Depth of Field. Default: 6. Range: 2 to 16.

DoFTargetFallbackParameter depthOfFieldPositionFallback

Focus behavior if position is not visible on the screen Default: DoFTargetFallback.KeepCurrentFocalDistance.

BoolParameter depthOfFieldResolutionInvariant

Adjusts circle of confusion radius based on screen resolution. Default: false.

DoFTargetFallbackParameter depthOfFieldTargetFallback

Focus behavior if object is not visible on the screen Default: DoFTargetFallback.KeepCurrentFocalDistance.

FloatParameter depthOfFieldTargetFallbackFixedDistance

Distance parameter for Depth of Field. Default: 1000f.

BoolParameter depthOfFieldTransparentDoubleSided

When enabled, transparent geometry is rendered with cull off. Default: false.

BeautifyLayerMaskParameter depthOfFieldTransparentLayerMask

Layer Mask parameter for Depth of Field. Default: 1.

BoolParameter depthOfFieldTransparentSupport

Toggles Depth of Field: Transparency Support. Default: false.

BoolParameter depthOfFieldUsePhysicalCamera

When enabled, uses the focal length, f-stop and image sensor size from the current physical camera settings Default: false.

Eye Adaptation

BoolParameter eyeAdaptation

Enable for Eye Adaptation. Default: false.

ClampedFloatParameter eyeAdaptationCenterWeight

Controls the strength of center-weighted metering (if no mask is used). 0 = uniform, higher values bias metering toward the screen center. Default: 1f. Range: 0f to 8f.

TextureParameter eyeAdaptationMask

When assigned, eye adaptation will be applied only to the pixels within the mask (red channel) Default: null.

ClampedFloatParameter eyeAdaptationMaxExposure

Max Exposure parameter for Eye Adaptation. Default: 5f. Range: 1f to 100f.

BeautifyEyeAdaptationMeteringModeParameter eyeAdaptationMeteringMode

Metering Mode parameter for Eye Adaptation. Default: EyeAdaptationMeteringMode.FullFrame.

ClampedFloatParameter eyeAdaptationMiddleGray

The 'neutral' brightness your auto‑exposure targets or roughly how bright an average surface should look. Lower values make scenes appear darker; higher values make them appear brighter. Default: 0.18f. Range: 0.001f to 0.5f.

FloatParameter eyeAdaptationMinCameraDistance

Minimum object depth in meters to consider for eye adaptation Default: 0f.

ClampedFloatParameter eyeAdaptationMinExposure

Min Exposure parameter for Eye Adaptation. Default: 0.2f. Range: 0 to 1.

FloatParameter eyeAdaptationSpeedToDark

Controls a speed parameter used by Eye Adaptation. Default: 0.2f.

FloatParameter eyeAdaptationSpeedToLight

Controls a speed parameter used by Eye Adaptation. Default: 0.4f.

Purkinje Shift

BoolParameter purkinje

Enable for Purkinje Shift. Default: false.

ClampedFloatParameter purkinjeAmount

Shift Amount parameter for Purkinje Shift. Default: 1f. Range: 0f to 5f.

ClampedFloatParameter purkinjeLuminanceThreshold

Controls the threshold used by Purkinje Shift. Default: 0.15f. Range: 0f to 1f.

Artistic Choices

Vignette

ClampedFloatParameter vignettingAspectRatio

Aspect Ratio parameter for Vignette. Default: 1f. Range: 0 to 1f.

ClampedFloatParameter vignettingBlink

Blink parameter for Vignette. Default: 0f. Range: 0 to 1.

BeautifyBlinkStyleParameter vignettingBlinkStyle

Blink Style parameter for Vignette. Default: BlinkStyle.Cutscene.

Vector2Parameter vignettingCenter

Center parameter for Vignette. Default: new Vector2Parameter(new Vector2(0.5f, 0.5f)).

BoolParameter vignettingCircularShape

Toggles Vignette: Circular Shape. Default: false.

BeautifyVignetteFitModeParameter vignettingCircularShapeFitMode

Fit Mode parameter for Vignette. Default: VignetteFitMode.FitToWidth.

ColorParameter vignettingColor

Tint color setting used by Vignette. Default: new Color(0f, 0f, 0f, 1f).

ClampedFloatParameter vignettingFade

Fade parameter for Vignette. Default: 0. Range: 0 to 1f.

ClampedFloatParameter vignettingInnerRing

Inner Ring parameter for Vignette. Default: 0. Range: 0 to 1f.

TextureParameter vignettingMask

Texture Mask parameter for Vignette. Default: null.

ClampedFloatParameter vignettingOuterRing

Outer Ring parameter for Vignette. Default: 0f. Range: -2f to 1f.

Outline

BoolParameter outline

outline parameter for Outline. Default: false.

BoolParameter outlineBlurDownscale

Toggles Outline: Downscale Blur. Default: false.

ClampedIntParameter outlineBlurPassCount

Blur Count parameter for Outline. Default: 1. Range: 1 to 5.

ColorParameter outlineColor

Color setting used by Outline. Default: new Color(0, 0, 0, 0.8f).

BoolParameter outlineCustomize

Toggles Outline: Customize. Default: false.

FloatParameter outlineDistanceFade

Maximum distance in meters from the camera Default: 0.

ClampedFloatParameter outlineIntensityMultiplier

Intensity Multiplier parameter for Outline. Default: 1. Range: 0 to 8.

LayerMaskParameter outlineLayerMask

Optionally specify which objects should receive the outline effect Default: new LayerMaskParameter(-1).

ClampedFloatParameter outlineMinDepthThreshold

Minimum depth difference between neighboring pixels to detect an edge. Higher values require larger depth discontinuities. Default: 0.0005f. Range: 0f to 0.01f.

ClampedIntParameter outlineMinSeparation

Minimum Separation parameter for Outline. Default: 1. Range: 1 to 5.

BoolParameter outlineOuterOnly

Toggles Outline: Outer Only. Default: false.

ClampedFloatParameter outlineSaturationDiffThreshold

Minimum color saturation difference between neighboring pixels to detect an edge. Higher values require more distinct color changes. Default: 0.015f. Range: 0f to 0.5f.

ClampedFloatParameter outlineSpread

Spread parameter for Outline. Default: 1f. Range: 0 to 1.3f.

BeautifyOutlineStageParameter outlineStageParameter

Render Stage parameter for Outline. Default: OutlineStage.BeforeBloom.

BeautifyOutlineTechniqueParameter outlineTechnique

Depth: uses scene depth to find edges. Per Object Id: performs a custom pre-pass which renders meshes id to identify independent objects. Default: OutlineTechnique.Depth.

ClampedFloatParameter outlineThreshold

Threshold for normal angle difference. Lower values detect sharper surface angle changes. Based on dot product of computed normals. Default: 0.2f. Range: 0f to 0.5f.

BoolParameter outlineUsesOptimizedShader

Uses a depth-only custom shader which should be faster. This option is only used when outline technique is set to Depth. If the scene uses shaders that transform the vertices coordinates, you may want to disable this option. Default: false.

Night Vision

BoolParameter nightVision

Enable for Night Vision. Default: false.

ColorParameter nightVisionColor

Color setting used by Night Vision. Default: new Color(0.5f, 1f, 0.5f, 0.5f).

FloatParameter nightVisionDepth

Max Visible Depth parameter for Night Vision. Default: 100000.

ClampedFloatParameter nightVisionDepthFallOff

Max Visible Depth Fall Off parameter for Night Vision. Default: 1. Range: 0.01f to 10.

Thermal Vision

BoolParameter thermalVision

Enable for Thermal Vision. Default: false.

ClampedFloatParameter thermalVisionDistortionAmount

Distortion Amount parameter for Thermal Vision. Default: 9f. Range: 0 to 100f.

BoolParameter thermalVisionScanLines

Toggles Thermal Vision: Scan Lines. Default: true.

Film Grain & Artifacts

ClampedFloatParameter filmGrainDirtSpotsAmount

Controls the frequency of dirt spots appearing on the film. Default: 0.0f. Range: 0 to 1f.

ClampedFloatParameter filmGrainDirtSpotsIntensity

Controls the visibility/brightness of dirt spots. Default: 0.2f. Range: 0 to 1f.

BoolParameter filmGrainEnabled

Enable for Film Grain & Artifacts. Default: false.

ClampedFloatParameter filmGrainIntensity

Grain Intensity parameter for Film Grain & Artifacts. Default: 0. Range: 0 to 1.

ClampedFloatParameter filmGrainLumaAttenuation

Controls how much grain is visible on bright areas. 0 for equally noise on all areas, 1 for reduced noise on bright areas. Default: 0.8f. Range: 0 to 1f.

ClampedFloatParameter filmGrainResolution

Resolution parameter for Film Grain & Artifacts. Default: 0.85f. Range: 0.001f to 1f.

ClampedFloatParameter filmGrainScratchesAmount

Controls the frequency of scratches appearing on the film. Default: 0.0f. Range: 0 to 1f.

ClampedFloatParameter filmGrainScratchesIntensity

Controls the visibility/brightness of scratches. Default: 0.3f. Range: 0 to 1f.

Creative Blur

Vector2Parameter blurCenter

Center parameter for Creative Blur. Default: new Vector2Parameter(new Vector2(0.5f, 0.5f)).

ClampedFloatParameter blurDesaturation

Reduces color saturation based on blur intensity. Default: 0f. Range: 0f to 1f.

ClampedFloatParameter blurIntensity

Controls the intensity of Creative Blur. Default: 0f. Range: 0f to 64f.

BoolParameter blurKeepSourceOnTop

Toggles Creative Blur: Keep Source On Top. Default: false.

TextureParameter blurMask

Mask parameter for Creative Blur. Default: null.

ClampedFloatParameter blurRadialBlurFalloff

Falloff parameter for Creative Blur. Default: 0.35f. Range: 0f to 1f.

ClampedFloatParameter blurRadialBlurRadius

Radius parameter for Creative Blur. Default: 0.2f. Range: 0f to 1f.

BoolParameter blurShowMask

Toggles Creative Blur: Show Mask. Default: false.

FloatParameter blurSourceEdgeBlendStrength

Edge Blending Strength parameter for Creative Blur. Default: 20.

ClampedFloatParameter blurSourceEdgeBlendWidth

Edge Blending Width parameter for Creative Blur. Default: 0. Range: 0 to 1.

Vector4Parameter blurSourceRect

Rect parameter for Creative Blur. Default: new Vector4Parameter(new Vector4(0.1f, 0.1f, 0.8f, 0.8f)).

BeautifyCreativeBlurStyleParameter blurStyle

Style parameter for Creative Blur. Default: CreativeBlurStyle.ScreenBlur.

ClampedFloatParameter blurTiltShiftFalloff

Falloff parameter for Creative Blur. Default: 0.2f. Range: 0f to 1f.

ClampedFloatParameter blurTiltShiftWidth

Width parameter for Creative Blur. Default: 0.2f. Range: 0f to 1f.

Frame

BoolParameter frame

Enable for Frame. Default: false.

ClampedFloatParameter frameBandHorizontalSize

Horizontal Bands Size parameter for Frame. Default: 0. Range: 0 to 0.5f.

ClampedFloatParameter frameBandHorizontalSmoothness

Horizontal Bands Smoothness parameter for Frame. Default: 0. Range: 0 to 1.

ClampedFloatParameter frameBandVerticalSize

Vertical Bands Size parameter for Frame. Default: 0.1f. Range: 0 to 0.5f.

ClampedFloatParameter frameBandVerticalSmoothness

Vertical Bands Smoothness parameter for Frame. Default: 0. Range: 0 to 1.

ColorParameter frameColor

Color setting used by Frame. Default: new Color(1, 1, 1, 1).

TextureParameter frameMask

Texture Mask parameter for Frame. Default: null.

ClampedFloatParameter frameSharpness

Sharpness parameter for Frame. Default: 50f. Range: 1f to 255f.

BeautifyFrameStyleParameter frameStyle

Style parameter for Frame. Default: FrameStyle.Border.

ClampedFloatParameter frameThickness

Thickness parameter for Frame. Default: 0.047f. Range: 0 to 1.

BeautifySettings Class (Runtime API)

BeautifySettings is a MonoBehaviour that provides a convenience singleton for quick access to the Beautify volume profile at runtime. It also manages the depth-of-field follow target, sun reference, and transition effects like blink.

Note: See Getting Started above for the difference between the singleton shortcut and direct Volume access.

Static Properties

static BeautifySettings instance { get; }

Returns a reference to the BeautifySettings component. If none exists, it auto-creates one on the first Volume GameObject that has a Beautify profile. Use this to access instance fields like depthOfFieldTarget and event delegates.

static Beautify sharedSettings { get; }

Returns a reference to the Beautify override in the volume's shared profile. Changes affect all volumes sharing that profile (like sharedMaterial in Unity). Equivalent to volume.sharedProfile.TryGet<Beautify>().

static Beautify settings { get; }

Returns a reference to the Beautify override in an instance copy of the volume profile. Instantiates the profile on first access so changes only affect this volume (like material vs sharedMaterial). Equivalent to volume.profile.TryGet<Beautify>(). This is the property used in FAQ examples.

static VolumeProfile currentProfile { get; }

Returns the shared VolumeProfile of the volume where Beautify was found.

static float depthOfFieldCurrentFocalPointDistance

The current computed focal-point distance (read-only at runtime). Useful for debugging or HUD display.

Instance Fields

Transform sun

Assign the directional light transform used for sun flares.

Transform depthOfFieldTarget

The transform tracked when depth-of-field Focus Mode is set to Follow Target.

Static Methods

static void Blink(float duration, float maxValue = 1)

Triggers a vignette-based blink animation (close then open) over the given duration in seconds.

// Trigger a half-second blink
BeautifySettings.Blink(0.5f);
static void UnloadBeautify()

Resets all cached internal references (instance, volume, settings). Call this when switching scenes if Beautify settings are not properly reset. Also called automatically on SceneManager.sceneLoaded.

BeautifySettings.UnloadBeautify();
SceneManager.LoadScene("NewScene");
static void UpdateAlphaClipRenderers()

Forces a refresh of the internal list of alpha-clip renderers. Call this after instantiating new alpha-clipped objects at runtime.

BeautifySettings Events

The BeautifySettings component (add to your camera) exposes the following delegate fields for depth-of-field hooks:

OnBeforeFocusEvent OnBeforeFocus(float currentFocusDistance)

Fired before the depth-of-field focus distance is applied. Your handler receives the current focus distance and returns the (optionally modified) distance to use.

// Delegate: float OnBeforeFocusEvent(float currentFocusDistance)

settings.OnBeforeFocus = (float distance) => {
    return Mathf.Clamp(distance, 1f, 100f);
};
OnCameraBeforeFocusEvent OnCameraBeforeFocus(Camera camera, ref float currentFocusDistance)

Fired before the depth-of-field focus distance is applied, providing the camera reference. Modify currentFocusDistance via ref to override the focus distance for that camera.

// Delegate: void OnCameraBeforeFocusEvent(Camera camera, ref float currentFocusDistance)

settings.OnCameraBeforeFocus = (Camera cam, ref float dist) => {
    if (cam == Camera.main) dist = 5f;
};
OnCameraBeforeAutofocusEvent OnCameraBeforeAutofocus(Camera camera, ref Transform target)

Fired before autofocus selects a target. Modify target via ref to override which transform the autofocus system tracks for that camera.

// Delegate: void OnCameraBeforeAutofocusEvent(Camera camera, ref Transform target)

settings.OnCameraBeforeAutofocus = (Camera cam, ref Transform t) => {
    t = myCustomTarget;
};
Was this page helpful?