Documentation - v19.16.0-dev
    Preparing search index...

    The settings of the sprites (SpriteController): how they are stored and drawn, hidden, read at the creation of the scene or of its renderer.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    alphaTest: NumberController = ...

    Pixels of a sprite image less opaque than this are not drawn (alpha test).

    capacity: NumberController = ...

    Initial capacity of the SpriteTable, in sprites (48 bytes each); it grows by doubling.

    icon: "sprites" = 'sprites'

    Drawn by an interface before its title.

    imageSize: NumberController = ...

    Side of a sprite image, in pixels: each image is drawn to this square (its aspect kept), a layer of the images' texture array (64 KB at 128, its mipmaps a third more).

    initialImages: NumberController = ...

    Sprite images the texture array holds at first; it grows by doubling.

    maxImages: NumberController = ...

    Images at most: the layers of a texture array every WebGL2 device has are 256 at least, most have 2,048 (128 MB of images at 128 pixels).

    title: "Sprites" = 'Sprites'

    Shown by an interface above its settings.

    Methods

    • Sets the settings config gives, each validated (see ValueController.validate): a value refused is skipped with a warning, the others set. The keys that are not settings are ignored (e.g. of a config saved by another version).

      Parameters

      Returns void

    • Disconnects every listener of the settings: they are not used after.

      Returns void

    • Sets the settings saved under key in the local storage (saveToLocalStorage); none saved: unchanged. A value refused (e.g. by a later version) is skipped with a warning, the others set (see applyConfig); saved settings that cannot be read are ignored with a warning.

      Parameters

      • key: string

      Returns void

    • Sets every setting back to its default.

      Returns void

    • Saves the values changed from their default under key in the local storage, the key removed when none is: the others follow the defaults of the next versions.

      Parameters

      • key: string

      Returns void