filament-compose/io.github.erkko68.filament.compose.scene

Package-level declarations

Types

data class AmbientOcclusion(val radius: Float = 0.3f, val bias: Float = 0.01f, val intensity: Float = 1.0f, val quality: View.Quality = View.Quality.LOW)

Screen-space ambient occlusion (SSAO).

AnimationMixer

@Stable

class AnimationMixer

A weighted, auto-advancing blend of several glTF clips — a blend tree. Each AnimationTrack contributes its pose by AnimationTrack.weight; weights are normalized so they need not sum to 1.

AnimationState

@Stable

class AnimationState

Hoisted, observable playback state for a single glTF Animator, created with rememberAnimationState and passed to GltfInstance. It auto-advances on every frame and drives the animator each frame in one of two modes:

AnimationTrack

class AnimationTrack

One weighted clip in an AnimationMixer, created with AnimationMixer.addTrack (or rememberAnimationTrack). Mutate weight to blend it in or out, index to swap the clip, or speed/loop for playback. The read-only time, progress and isFinished update every frame.

AntiAliasing

@Immutable

data class AntiAliasing(val msaaEnabled: Boolean = false, val msaaSampleCount: Int = 4, val fxaaEnabled: Boolean = true, val taaEnabled: Boolean = false)

Anti-aliasing: MSAA (hardware), FXAA (post-process), and TAA (temporal).

Bloom

@Immutable

data class Bloom(val strength: Float = 0.1f, val thresholdEnabled: Boolean = true, val quality: View.Quality = View.Quality.LOW, val resolution: Int = 0, val levels: Int = 6)

Bloom — "glow" around bright areas.

CameraState

@Stable

class CameraState

Hoisted, observable camera state. Create with rememberCameraState and pass to io.github.erkko68.filament.compose.FilamentView for full control over the camera.

ColorGrade

@Immutable

data class ColorGrade(val exposure: Float = 0.0f, val contrast: Float = 1.0f, val vibrance: Float = 1.0f, val saturation: Float = 1.0f, val whiteBalanceTemperature: Float = 0.0f, val whiteBalanceTint: Float = 0.0f, val toneMapping: ToneMapping = ToneMapping.ACES)

Color grading — exposure, white balance, contrast, tone mapping, etc.

DepthOfField

@Immutable

data class DepthOfField(val cocScale: Float = 1.0f, val maxApertureDiameter: Float = 0.01f, val filter: View.DepthOfFieldOptions.Filter = View.DepthOfFieldOptions.Filter.MEDIAN, val nativeResolution: Boolean = false)

Depth-of-field (bokeh). The camera's focus distance and aperture control the focal plane.

Direction

@Immutable

data class Direction(val x: Float, val y: Float, val z: Float)

A direction / displacement vector in 3-D space. See Position for the rationale behind the distinct type and the Float3 interop story.

Dithering

@Immutable

data class Dithering(val mode: View.Dithering = View.Dithering.TEMPORAL)

Dithering applied at tonemap time. View.Dithering.TEMPORAL (Filament's native default) hides 8-bit banding in dark gradients and bloom halos.

DynamicResolution

@Immutable

data class DynamicResolution(val minScale: Float = 0.5f, val maxScale: Float = 1.0f, val sharpness: Float = 0.9f, val quality: View.Quality = View.Quality.LOW, val homogeneousScaling: Boolean = false)

Dynamic resolution scaling — lowers internal resolution under GPU load and upscales.

Environment

@Stable

class Environment

A loaded image-based-lighting environment: the indirectLightState that lights the scene and an optional skyboxState background. Obtain via rememberKTXEnvironment (pre-baked KTX) or rememberHDREnvironment (raw .hdr) and feed the two states straight into io.github.erkko68.filament.compose.rememberFilamentScene:

Exposure

@Immutable

data class Exposure(val aperture: Float = 16.0f, val shutterSpeed: Float = 1f / 125f, val sensitivity: Float = 100.0f)

Photographic exposure (aperture / shutter-speed / ISO triangle).

Fog

@Immutable

data class Fog(val distance: Float = 0.0f, val density: Float = 0.1f, val height: Float = 0.0f, val heightFalloff: Float = 1.0f, val color: LinearColor = LinearColor(0f, 0f, 0f))

Height-based and volumetric fog.

GltfAsset

@Stable

class GltfAsset

A loaded glTF asset whose GPU resources are ready. Obtain via rememberGltfAsset.

GltfInstanceScope

interface GltfInstanceScope

Scope for interacting with a specific glTF instance via low-level Filament APIs.

IndirectLightState

@Stable

class IndirectLightState

Hoisted, observable Image-Based Lighting (IBL) state. Pass to io.github.erkko68.filament.compose.rememberFilamentScene via indirectLightState = ....

LensScaling

@Immutable

data class LensScaling(val x: Float, val y: Float)

Projection scaling — multiplies the projection along each axis. 2 on one axis zooms that axis in; unequal values give an anamorphic squeeze.

LensShift

@Immutable

data class LensShift(val x: Float, val y: Float)

Lens shift — moves the projection off-axis without rotating the camera, in units of half the viewport (1 shifts by a full half-width/height). Used for tilt-shift looks, and for keeping verticals parallel in architectural shots.

LightIntensity

@Immutable

sealed interface LightIntensity

A light's brightness as a value type, bundling the amount with how it's interpreted — one variant per intensity setter on the core LightManager.Builder, so unit-specific extras (Watts' efficiency) are unrepresentable with the other units.

LinearColor

@Immutable

data class LinearColor(val r: Float, val g: Float, val b: Float)

An RGB color (linear or sRGB depending on the consuming API). Distinct from the spatial vectors so a LinearColor can't be passed as a Position. Components are r/g/b.

Position

@Immutable

data class Position(val x: Float, val y: Float, val z: Float)

A point in 3-D space.

PostProcessing

@Immutable

data class PostProcessing(val enabled: Boolean = true, val bloom: Bloom? = null, val vignette: Vignette? = null, val fog: Fog? = null, val ambientOcclusion: AmbientOcclusion? = null, val antiAliasing: AntiAliasing? = null, val screenSpaceReflections: ScreenSpaceReflections? = null, val colorGrade: ColorGrade? = null, val depthOfField: DepthOfField? = null, val dynamicResolution: DynamicResolution? = null, val dithering: Dithering? = null, val renderQuality: RenderQuality? = null)

Per-view visual configuration: post-processing effects plus render-quality options. Pass to io.github.erkko68.filament.compose.FilamentView via postProcessing = ....

Projection

@Immutable

sealed class Projection

Camera projection. Pass an instance as the Camera.projection argument.

RenderQuality

@Immutable

data class RenderQuality(val hdrColorBuffer: View.Quality = View.Quality.HIGH)

Precision of the view's HDR color buffer. View.Quality.HIGH (the native default) is RGBA16F where supported — needed for emissive values above 1.0 to survive into bloom.

Rotation

@Immutable

data class Rotation(val x: Float, val y: Float, val z: Float, val w: Float)

A 3-D rotation, stored as a unit quaternion. See Position for the rationale behind the distinct type — the same one applies doubly here, since filament-utils' Quaternion has mutable components and so is an unstable Compose input.

Scale

@Immutable

data class Scale(val x: Float, val y: Float, val z: Float)

A per-axis scale factor. See Position for the rationale behind the distinct type.

ScreenSpaceReflections

@Immutable

data class ScreenSpaceReflections(val thickness: Float = 0.1f, val bias: Float = 0.01f, val maxDistance: Float = 3.0f)

Screen-space reflections (SSR).

ShadowConfig

@Immutable

data class ShadowConfig(val mapSize: Int = 1024, val constantBias: Float = 0.001f, val normalBias: Float = 1.0f, val shadowFar: Float = 0.0f, val shadowNearHint: Float = 1.0f, val shadowFarHint: Float = 100.0f, val stable: Boolean = false, val lispsm: Boolean = false, val cascades: Int = 1, val cascadeSplits: List<Float>? = null, val contactShadows: Boolean = false, val contactShadowDistance: Float = 0.3f, val contactShadowSteps: Int = 8, val bulbRadius: Float = 0.02f, val blurWidth: Float = 0.0f, val elvsm: Boolean = false, val transform: Rotation? = null)

Per-light shadow-map quality, mapping onto the core LightManager.ShadowOptions. Pass a non-null shadow to a DirectionalLight/SunLight/SpotLight/FocusedSpotLight to make it cast shadows; null disables them. (Point lights cannot cast shadows.)

Shadows

@Immutable

sealed interface Shadows

View-wide shadow technique, passed to a view via FilamentView(shadows = …) (or FilamentSceneView(shadows = …)). Each subtype is one of Filament's shadow algorithms and carries only the tuning that algorithm actually uses — so there are no silently-ignored fields. Passing null for the view's shadows disables shadowing entirely. See ShadowConfig for the per-light counterpart that sets each caster's map quality.

SkyboxSource

@Immutable

sealed class SkyboxSource

Source for a SkyboxState: either a solid color or a cubemap texture.

SkyboxState

@Stable

class SkyboxState

Hoisted, observable skybox state. Pass to io.github.erkko68.filament.compose.rememberFilamentScene via skyboxState = .... A null source removes the skybox entirely.

SphericalHarmonics

@Immutable

data class SphericalHarmonics(val bands: Int, val coefficients: FloatArray)

Spherical harmonics coefficients for diffuse irradiance.

SpotCone

@Immutable

data class SpotCone(val innerAngle: Float = 0.5f, val outerAngle: Float = 0.6f)

Spot / focused-spot cone angles (half-angles in radians). innerAngle must be ≤ outerAngle.

StandardMaterial

enum StandardMaterial : Enum<StandardMaterial>

The built-in materials shipped with filament-compose — precompiled .filamat blobs embedded in the library, so the common "colour a primitive" case needs no .mat authoring, no matc, and no asset shipping on any target (including Web, where runtime material compilation isn't available).

SunParams

@Immutable

data class SunParams(val angularRadius: Float = 1.9f, val haloSize: Float = 10.0f, val haloFalloff: Float = 80.0f)

Sun-disk appearance parameters for SunLight.

ToneMapping

@Immutable

sealed interface ToneMapping

Tone mapping operator selection for ColorGrade, as a value: every variant compares structurally, so two ColorGrades built with the same settings are equal and don't force a ColorGrading rebuild (the native ToneMapper instances have identity equality, which would re-bake the grading LUT on every recomposition). The native operator is constructed only when the configuration is actually applied.

Vignette

@Immutable

data class Vignette(val midPoint: Float = 0.5f, val roundness: Float = 0.5f, val feather: Float = 0.5f, val color: LinearColor = LinearColor(0f, 0f, 0f))

Vignette — darkens the corners of the viewport.

Package-level declarations

Types

Functions