API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
classSpriteMaterial
@codexo/exojs / rendering / stable
Material specialization for Sprite drawables. The base texture stays on the sprite and is sampled through the engine's `sampleBase(slot, uv)` helper, which preserves batching and resolves the backend's premultiplied-alpha convention. The material supplies the custom fragment program, uniforms, additional texture bindings, and blend mode.
9
props
6
methods
0
events
Import
import { SpriteMaterial } from '@codexo/exojs'Material specialization for Sprite drawables.
The base texture stays on the sprite and is sampled through the engine's `sampleBase(slot, uv)` helper, which preserves batching and resolves the backend's premultiplied-alpha convention. The material supplies the custom fragment program, uniforms, additional texture bindings, and blend mode.
Constructors1
Methods6
destroy(): voidRelease GPU resources cached against this material on every backend that has compiled it. Safe to call multiple times. After destroy, the material can still be re-used - renderers recompile on next draw - but typical usage is to drop the reference.
onDispose(callback: () => void): voidHook for renderers to register a per-material-instance cleanup callback (release compiled program, pipeline, or bind groups). The callback fires on destroy; renderers MUST also tolerate the material being garbage-collected without destroy ever being called. Part of the renderer SDK contract for extension renderers.
setTexture(name: string, texture: RenderTextureAn off-screen render target that can also be sampled as a texture. Combines RenderTarget (framebuffer attachment) with the sampler parameters of a Texture (sca… | 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 (…): thisReplace the texture behind a declared slot, returning this for chaining.
setUniform(name: MaterialRawUniformNameA uniform name the raw path accepts; `never` once a schema is declared.<F, B>, value: UniformValueValue accepted by a material uniform on a shader source that declares no uniform schema. Scalars and small tuples auto-marshal to the appropriate `Float32Array…): thisReplace a declared uniform value, returning this for chaining. Unknown names and scalar↔texture kind changes are rejected. Only available on a material whose shader source declares no uniform schema; a typed material writes through uniforms instead.
from(source: ShaderImmutable shader source pair shared by Material instances. `Shader` owns only the GLSL/WGSL text and its stable identity; it carries no uniform/texture state (…<F, B>, options?: Omit<MaterialOptionsConstruction options shared by every Material. Only `shader` is required. What `uniforms` means follows from the shader source: on a source that declares a uni…<F, B>, "shader">): SpriteMaterial<F, B>Build a SpriteMaterial from an existing Shader. Equivalent to new SpriteMaterial({ shader, ...options }).
from(glslVertex: string, glslFragment: string, options?: { blendMode?: BlendModesCompositing blend modes applied when drawing a Drawable over the current render target. Modes 0-4 are implemented as fixed-function GPU blend equations (no tex…; sampler?: SamplerOptionsGPU sampling state: how a texture is filtered and how UV coordinates outside `[0, 1]` are resolved. Sampling state is independent of a texture's pixel content,… | null; uniforms?: Record<string, UniformValueValue accepted by a material uniform on a shader source that declares no uniform schema. Scalars and small tuples auto-marshal to the appropriate `Float32Array…>; wgsl?: string }): SpriteMaterialBuild a SpriteMaterial from raw GLSL vertex and fragment source strings. Wraps them in a new Shader; pass options.wgsl to also cover the WebGPU backend.
Properties9
Compositing blend mode applied when drawing with this material.
Filter/wrap override for the drawable's base texture, or null to inherit it.
GLSL/WGSL source pair backing this material.
target: "sprite"Which drawable class this material can serve; renderers check compatibility.
bindKey: numberStable bind key: identical ⇒ same bindings (textures unchanged). Derived from this material's identity, base-texture sampler override, and the identities of its bound textures. Changes when a texture is swapped or sampler state changes; drives bind-group/slot reuse.
pipelineKey: numberStable pipeline key: identical ⇒ same GPU pipeline/program can be used. Derived from shader identity and blend mode, and is independent of the owning material instance so identically configured materials share a pipeline. Drives grouping and the pipeline cache.
textures: Record<string, RenderTextureAn off-screen render target that can also be sampled as a texture. Combines RenderTarget (framebuffer attachment) with the sampler parameters of a Texture (sca… | 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 (…>Live identities behind the fixed named texture slots.
The declared named uniform blocks, each owning its own values.
The typed accessors of the declared uniform block, or - on a source without a schema - the live user uniform values, where construction declares the fixed set of names and each name's scalar/texture kind: material.uniforms.u_time = performance.now() / 1000; material.uniforms.u_color = [1, 0.5, 0, 1];
Source