Back to Filament

ShadowOptions

docs/android/dokka/filament-android/com.google.android.filament/-light-manager/-shadow-options/index.md

1.75.05.9 KB
Original Source

//filament-android/com.google.android.filament/LightManager/ShadowOptions

ShadowOptions

[main]
open class ShadowOptions

Control the quality / performance of the shadow map associated to this light

Constructors

ShadowOptions[main]
constructor()

Properties

NameSummary
blurWidth[main]
open var blurWidth: Float
Blur width for the VSM blur.
cascadeSplitPositions[main]
open var cascadeSplitPositions: Array<Float>
The split positions for shadow cascades.
constantBias[main]
open var constantBias: Float
Constant bias in world units (e.g.
elvsm[main]
open var elvsm: Boolean
When elvsm is set to true, "Exponential Layered VSM without Layers" are used.
lispsm[main]
open var lispsm: Boolean
LiSPSM, or light-space perspective shadow-mapping is a technique allowing to better optimize the use of the shadow-map texture.
mapSize[main]
open var mapSize: Int
Size of the shadow map in texels.
maxPenumbraRatio[main]
open var maxPenumbraRatio: Float
Sets a light-specific maximum geometric ratio applied to Percentage-Closer Soft Shadows (PCSS), overriding the global default.
maxSearchRadius[main]
open var maxSearchRadius: Float
Sets a light-specific maximum world-space radius used during the PCSS blocker search, overriding the global default.
maxShadowDistance[main]
open var maxShadowDistance: Float
Maximum shadow-occluder distance for screen-space contact shadows (world units).
normalBias[main]
open var normalBias: Float
Amount by which the maximum sampling error is scaled.
penumbraRatioScale[main]
open var penumbraRatioScale: Float
Sets a light-specific scale factor applied to the PCSS geometric ratio before clamping.
penumbraScale[main]
open var penumbraScale: Float
Sets a light-specific scale factor applied to the final penumbra size of PCSS shadows.
screenSpaceContactShadows[main]
open var screenSpaceContactShadows: Boolean
Whether screen-space contact shadows are used.
shadowBulbRadius[main]
open var shadowBulbRadius: Float
Light bulb radius used for soft shadows.
shadowCascades[main]
open var shadowCascades: Int
Number of shadow cascades to use for this light.
shadowFar[main]
open var shadowFar: Float
Distance from the camera after which shadows are clipped.
shadowFarHint[main]
open var shadowFarHint: Float
Optimize the quality of shadows in front of this distance from the camera.
shadowNearHint[main]
open var shadowNearHint: Float
Optimize the quality of shadows from this distance from the camera.
stable[main]
open var stable: Boolean
Controls whether the shadow map should be optimized for resolution or stability.
stepCount[main]
open var stepCount: Int
Number of ray-marching steps for screen-space contact shadows (8 by default).
transform[main]
open var transform: Array<Float>
Transforms the shadow direction.