filament/io.github.erkko68.filament/View/SoftShadowOptions

SoftShadowOptions

actual class SoftShadowOptions

View-level options for DPCF and PCSS (soft) shadowing.

Warning: This API is still experimental and subject to change.

expect class SoftShadowOptions

View-level options for DPCF and PCSS (soft) shadowing.

Warning: This API is still experimental and subject to change.

actual class SoftShadowOptions

View-level options for DPCF and PCSS (soft) shadowing.

Warning: This API is still experimental and subject to change.

actual class SoftShadowOptions

View-level options for DPCF and PCSS (soft) shadowing.

Warning: This API is still experimental and subject to change.

actual class SoftShadowOptions

View-level options for DPCF and PCSS (soft) shadowing.

Warning: This API is still experimental and subject to change.

Constructors

Link copied to clipboard
actual constructor()
expect constructor()
actual constructor()
actual constructor()
constructor()

Properties

Link copied to clipboard
actual var maxPenumbraRatio: Float

Caps the penumbra ratio used by PCSS contact hardening, applied as a smooth asymptotic squash rather than a hard clamp. Limits how soft a shadow can get as the occluder moves away from the receiver. Default: 10.0.

@PlatformGap(platforms = [FilamentPlatform.WEB], behavior = "tracked locally only — the wasm registers the field but the vendored externals do not declare it, so it never reaches the engine.")
expect var maxPenumbraRatio: Float

Caps the penumbra ratio used by PCSS contact hardening, applied as a smooth asymptotic squash rather than a hard clamp. Limits how soft a shadow can get as the occluder moves away from the receiver. Default: 10.0.

actual var maxPenumbraRatio: Float

Caps the penumbra ratio used by PCSS contact hardening, applied as a smooth asymptotic squash rather than a hard clamp. Limits how soft a shadow can get as the occluder moves away from the receiver. Default: 10.0.

actual var maxPenumbraRatio: Float

Caps the penumbra ratio used by PCSS contact hardening, applied as a smooth asymptotic squash rather than a hard clamp. Limits how soft a shadow can get as the occluder moves away from the receiver. Default: 10.0.

actual var maxPenumbraRatio: Float

Caps the penumbra ratio used by PCSS contact hardening, applied as a smooth asymptotic squash rather than a hard clamp. Limits how soft a shadow can get as the occluder moves away from the receiver. Default: 10.0.

Link copied to clipboard
actual var maxSearchRadius: Float

Limits the physical footprint, in world units, of the PCSS blocker search. Acts as a global ceiling on the per-light LightManager.ShadowOptions.maxSearchRadius. Default: 1.0.

@PlatformGap(platforms = [FilamentPlatform.WEB], behavior = "tracked locally only — the wasm registers the field but the vendored externals do not declare it, so it never reaches the engine.")
expect var maxSearchRadius: Float

Limits the physical footprint, in world units, of the PCSS blocker search. Acts as a global ceiling on the per-light LightManager.ShadowOptions.maxSearchRadius. Default: 1.0.

actual var maxSearchRadius: Float

Limits the physical footprint, in world units, of the PCSS blocker search. Acts as a global ceiling on the per-light LightManager.ShadowOptions.maxSearchRadius. Default: 1.0.

actual var maxSearchRadius: Float

Limits the physical footprint, in world units, of the PCSS blocker search. Acts as a global ceiling on the per-light LightManager.ShadowOptions.maxSearchRadius. Default: 1.0.

actual var maxSearchRadius: Float

Limits the physical footprint, in world units, of the PCSS blocker search. Acts as a global ceiling on the per-light LightManager.ShadowOptions.maxSearchRadius. Default: 1.0.

Link copied to clipboard
actual var penumbraRatioScale: Float

Globally scales the computed penumbra ratio of all DPCF and PCSS shadows. This effectively controls the strength of contact hardening effect and is useful for artistic purposes. Higher values make the shadows become softer faster. Acceptable values are equal to or greater than 1. Default: 1.0.

expect var penumbraRatioScale: Float

Globally scales the computed penumbra ratio of all DPCF and PCSS shadows. This effectively controls the strength of contact hardening effect and is useful for artistic purposes. Higher values make the shadows become softer faster. Acceptable values are equal to or greater than 1. Default: 1.0.

actual var penumbraRatioScale: Float

Globally scales the computed penumbra ratio of all DPCF and PCSS shadows. This effectively controls the strength of contact hardening effect and is useful for artistic purposes. Higher values make the shadows become softer faster. Acceptable values are equal to or greater than 1. Default: 1.0.

actual var penumbraRatioScale: Float

Globally scales the computed penumbra ratio of all DPCF and PCSS shadows. This effectively controls the strength of contact hardening effect and is useful for artistic purposes. Higher values make the shadows become softer faster. Acceptable values are equal to or greater than 1. Default: 1.0.

actual var penumbraRatioScale: Float

Globally scales the computed penumbra ratio of all DPCF and PCSS shadows. This effectively controls the strength of contact hardening effect and is useful for artistic purposes. Higher values make the shadows become softer faster. Acceptable values are equal to or greater than 1. Default: 1.0.

Link copied to clipboard
actual var penumbraScale: Float

Globally scales the penumbra of all DPCF and PCSS shadows. Acceptable values are greater than 0. Default: 1.0.

expect var penumbraScale: Float

Globally scales the penumbra of all DPCF and PCSS shadows. Acceptable values are greater than 0. Default: 1.0.

actual var penumbraScale: Float

Globally scales the penumbra of all DPCF and PCSS shadows. Acceptable values are greater than 0. Default: 1.0.

actual var penumbraScale: Float

Globally scales the penumbra of all DPCF and PCSS shadows. Acceptable values are greater than 0. Default: 1.0.

actual var penumbraScale: Float

Globally scales the penumbra of all DPCF and PCSS shadows. Acceptable values are greater than 0. Default: 1.0.

Generated by Dokka
© 2026 Copyright