API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
classCompressedTexture
@codexo/exojs / rendering / stable
A Texture constructed directly from a compressed payload. Convenience only: a compressed payload is something a plain `Texture` can carry, so anything accepting a `Texture` accepts one of these, and a texture loaded from a container arrives as a plain `Texture` with Texture.compressed set. Code that needs to tell the difference reads that property rather than testing the class.
23
props
12
methods
0
events
Import
import { CompressedTexture } from '@codexo/exojs'A Texture constructed directly from a compressed payload.
Convenience only: a compressed payload is something a plain `Texture` can carry, so anything accepting a `Texture` accepts one of these, and a texture loaded from a container arrives as a plain `Texture` with Texture.compressed set. Code that needs to tell the difference reads that property rather than testing the class.
Constructors1
new(__namedParameters: CompressedTextureOptionsConstruction options for CompressedTexture.): CompressedTextureMethods12
addDestroyListener(listener: () => void): thisRegister a callback to be invoked just before this texture is destroyed. Useful for backends to release their GPU-side texture objects.
destroy(): voidremoveDestroyListener(listener: () => void): thisInstall a compressed payload, replacing any pixel source, and resize to its base level. Pass null to drop it. Bumps version, so backends re-create their GPU texture - a format change cannot be patched into an existing one.
setGenerateMipMap(generateMipMap: boolean): thissetPremultiplyAlpha(premultiplyAlpha: boolean): thissetSize(width: number, height: number): thisupdateSource(): thisRefresh the size from the current source and bump the version. Call after mutating the source's pixel data in place (e.g. drawing to a canvas) to notify backends that a re-upload is needed.
fromColor(color: Color32-bit RGBA color value with channel-wise accessors. Red, green, and blue are integers in 0..255; alpha is a float in 0..1. Out-of-range values are saturated o… | string, size: number): 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 (…Create a solid-colour texture of the given square size (default 1×1). Accepts a Color instance or any CSS colour string; a Color with alpha below 1 is rendered with that alpha. Generalizes the fixed Texture.black/Texture.white helpers.
Properties23
Hardware-compressed payload this texture uploads instead of a pixel source, or null for the ordinary case. Mutually exclusive with source: installing one clears the other, so a texture is never ambiguous about what it uploads. A handle that arrives empty from the loader can become either, which is what lets an asset variant swap a PNG for a KTX2 file without changing what a caller holds.
destroyed: booleantrue once destroy has run - a destroyed texture must not be bound.
error: Error | nullThe error the last load failed with, or null outside 'failed'.
flipY: booleangenerateMipMap: booleanheight: numberloaded: Promise<this>Promise that settles with this texture once its payload has loaded - resolved immediately for 'ready' textures, rejected with the load error for 'failed' ones. Re-materialized when a failed load is retried, so read it fresh from this getter rather than caching it across load cycles.
Load lifecycle of this texture. Directly constructed textures are 'ready'; deferred handles returned by loader.get('hero.png') / loader.get(Asset.type('texture', src)) start 'loading' and become 'ready' once the payload fills in, or 'failed' (showing the Texture.missing checker) when the load errors.
powerOfTwo: booleanWhether both dimensions are powers of two. Non-power-of-two textures may have limited wrap-mode support on some hardware.
premultiplyAlpha: booleanready: booleantrue exactly when state is 'ready'.
Load lifecycle: 'idle' | 'loading' | 'ready' | 'failed'.
version: numberMonotonically increasing version counter. Incremented by any mutation that requires a GPU re-upload: a source, size, or upload-parameter change. Filter and wrap changes do not bump it - backends resolve sampling state separately, so changing it costs no upload.
width: numberShared 8×8 magenta/black checkerboard shown in place of assets that failed to load - a visible error beats an invisible hole, in production too. Lazily created; every access returns the same instance.
Source