filament/io.github.erkko68.filament/PlatformGap

PlatformGap

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class PlatformGap(val platforms: Array<FilamentPlatform>, val behavior: String)

Marks a common API whose platform binding is missing or degraded on the listed platforms.

The API exists in commonMain so shared code compiles everywhere, but the platform actual cannot reach the underlying engine feature — usually because upstream filament.js (embind, jsbindings.cpp) does not register it. behavior states exactly what the call does there: throws UnsupportedOperationException, is a silent no-op, or returns a placeholder.

The full per-platform coverage table lives in Platform Notes.

Properties

behavior

val behavior: String

What calling the API does on those platforms.

platforms

val platforms: Array<FilamentPlatform>

Platforms on which the binding is missing or degraded.