API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

I

interfaceUIAnimatedBackground

@codexo/exojs / ui / stable

Clip-driven background: an atlas, the clips cut from it, and the one that plays. Stretched over the widget box, so it suits a flat animated panel face or a progress bar's fill rather than a frame with corners to preserve - a nine-slice does not animate, and tiling would need a repeating sprite, which does not either. Playback runs through the application's animation system as soon as the widget is in a scene tree, and costs nothing while no clip is running. A ProgressBar on `fillMode: 'clip'` plays the frame at full size and cuts it to the value, which is what makes an animated bar read correctly.

5
props
0
methods
0
events
Import
import { UIAnimatedBackground } from '@codexo/exojs'

Clip-driven background: an atlas, the clips cut from it, and the one that plays. Stretched over the widget box, so it suits a flat animated panel face or a progress bar's fill rather than a frame with corners to preserve - a nine-slice does not animate, and tiling would need a repeating sprite, which does not either.

Playback runs through the application's animation system as soon as the widget is in a scene tree, and costs nothing while no clip is running. A ProgressBar on `fillMode: 'clip'` plays the frame at full size and cuts it to the value, which is what makes an animated bar read correctly.

Properties5
clip: string
Name of the clip to play; must be one of UIAnimatedBackground.clips.
clips: Readonly<Record<string, AnimatedSpriteClipDefinitionDefinition for a single animation clip registered on an AnimatedSprite.>>
fit?: "stretch"
Reserved for a second fill rule; 'stretch' is the only one an animated surface has.
kind: "animated"
texture: TextureA static GPU texture sourced from an image, canvas, or video element. Holds the pixel source, its sampling state (ScaleModes, WrapModes) and its upload state (…
Source
src/ui/theme.ts