API reference

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

interfaceMaterialOptions

@codexo/exojs / rendering / stable

Construction options shared by every Material. Only `shader` is required. What `uniforms` means follows from the shader source: on a source that declares a uniform schema it carries starting values for the declared fields, and textures must go in `textures`; on a source without one it is the mutable value record, where texture-valued entries also claim a texture binding.

props

methods

events

Import

import { MaterialOptions } from '@codexo/exojs'

Construction options shared by every Material.

Only `shader` is required. What `uniforms` means follows from the shader source: on a source that declares a uniform schema it carries starting values for the declared fields, and textures must go in `textures`; on a source without one it is the mutable value record, where texture-valued entries also claim a texture binding.

Properties6

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…

Compositing blend mode; defaults to BlendModes.Normal.

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

Filter/wrap override for the drawable's base texture, or null to inherit that texture's sampler. Additional material textures keep their own sampler state. Defaults to null.

shader: 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>

GLSL/WGSL source pair backing this material.

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 (…>

Declared texture slots claimed in addition to the drawable's own texture.

uniformBlocks?: B extends undefined ? never : UniformBlockInitialValuesPer-block starting values accepted when an instance is constructed.<Extract<B, Readonly<Record<string, UniformBlockOne explicitly named uniform block. Use this only with `uniformBlocks`, where the record key supplies both the shader-visible instance name and the runtime nam…<Readonly<Record<string, UniformFieldDeclarationOne entry of a UniformFields record.>>>>>>>

Starting values per named block, for a source declaring uniformBlocks.

uniforms?: MaterialUniformValuesStarting values accepted for the declared uniforms.<F, B>

Starting values for the declared uniforms, or - on a source without a schema - the declared uniform slots and their initial values, whose names and scalar/texture kinds form a fixed construction-time schema.

Source

src/rendering/material/Material.ts