Material

const Material: object

Type Declaration

compileShader()

compileShader(esshaderSource, features?): number

Compiles a .esshader material shader through the engine’s ShaderParser, which generates the std140 MaterialConstants block from its #pragma param declarations and registers the param layout. Use this (not createShader) for materials whose parameters should reach the GPU. Returns a shader handle, or 0 on failure.

Parameters

esshaderSource

string

features?

string[] = []

Returns

number

create()

create(options): number

Creates a material with a shader and optional settings.

Parameters

options

MaterialOptions

Material creation options

Returns

number

Material handle

createFromAsset()

createFromAsset(data, shaderHandle, parentHandle?): number

Creates a material from asset data. When

Parameters

data

MaterialAssetData

shaderHandle

number

parentHandle?

number

Returns

number

P

parentHandle is given (the asset’s instanceOf resolved to a loaded parent), builds a Material Instance carrying only the asset’s overrides — properties and any present render-state fields. Otherwise builds a base material on

P

shaderHandle.

createInstance()

createInstance(source): number

Creates a material instance (UE MaterialInstanceConstant): it inherits

Parameters

source

number

Parent material (a base material or another instance)

Returns

number

New instance handle

P

source’s shader, render state and parameters, and stores only the diffs you later set on it. Editing the parent propagates to every non-overriding instance. Use this for cheap variants (“the same material, but red”) instead of duplicating the whole material.

createShader()

createShader(vertexSrc, fragmentSrc): number

Creates a shader from vertex and fragment source code.

Parameters

vertexSrc

string

GLSL vertex shader source

fragmentSrc

string

GLSL fragment shader source

Returns

number

Shader handle, or 0 on failure

get()

get(material): MaterialData | undefined

Gets material data by handle.

Parameters

material

number

Material handle

Returns

MaterialData | undefined

Material data or undefined

getBlendMode()

getBlendMode(material): BlendMode

Gets the blend mode of a material.

Parameters

material

number

Material handle

Returns

BlendMode

Blend mode

getShader()

getShader(material): number

Gets the shader handle for a material.

Parameters

material

number

Material handle

Returns

number

Shader handle

getSwitch()

getSwitch(material, name): boolean

Gets an enabled static switch (false when unset).

Parameters

material

number

name

string

Returns

boolean

getUniform()

getUniform(material, name): UniformValue | undefined

Gets a uniform value from a material.

Parameters

material

number

Material handle

name

string

Uniform name

Returns

UniformValue | undefined

Uniform value or undefined

getUniforms()

getUniforms(material): Map<string, UniformValue>

Gets all uniforms from a material.

Parameters

material

number

Material handle

Returns

Map<string, UniformValue>

Map of uniform names to values

isValid()

isValid(material): boolean

Checks if a material exists.

Parameters

material

number

Material handle

Returns

boolean

True if material exists

release()

release(material): void

Releases a material (does not release the shader).

Parameters

material

number

Material handle

Returns

void

releaseAll()

releaseAll(): void

Returns

void

releaseShader()

releaseShader(shader): void

Releases a shader.

Parameters

shader

number

Shader handle to release

Returns

void

renderPreview()

renderPreview(material, w, h): Promise<ImageData | null>

Render a material to an offscreen

Parameters

material

number

w

number

h

number

Returns

Promise<ImageData | null>

P

w×@p h target and resolve with its pixels (a “material ball” thumbnail). Reuses the real viewport render path — a unit quad lit by one directional light — so the preview matches how the material looks in-scene. The readback rides the engine’s async seam: immediate on GL, resolved when the staging-buffer map lands on WebGPU — one awaited call either way. Null if the engine isn’t ready or the readback fails.

setBlendMode()

setBlendMode(material, mode): void

Sets the blend mode for a material.

Parameters

material

number

Material handle

mode

BlendMode

Blend mode

Returns

void

setCull()

setCull(material, cull): void

Sets the triangle culling mode.

Parameters

material

number

cull

CullMode

Returns

void

setDepthTest()

setDepthTest(material, enabled): void

Sets depth test enabled for a material.

Parameters

material

number

Material handle

enabled

boolean

Whether depth test is enabled

Returns

void

setDepthWrite()

setDepthWrite(material, enabled): void

Enables/disables depth writes (default on, matching the engine’s 2D state).

Parameters

material

number

enabled

boolean

Returns

void

setSwitch()

setSwitch(material, name, on): void

Sets a static switch on the record. The shader permutation is chosen at compile time, so a change takes effect when the material’s shader is next (re)compiled — callers that need it live recompile the shader with the new switch set.

Parameters

material

number

name

string

on

boolean

Returns

void

setUniform()

setUniform(material, name, value): void

Sets a uniform value on a material.

Parameters

material

number

Material handle

name

string

Uniform name

value

UniformValue

Uniform value

Returns

void

tex()

tex(textureId, slot?): TextureRef

Parameters

textureId

number

slot?

number

Returns

TextureRef

toAssetData()

toAssetData(material, shaderPath, parentPath?): MaterialAssetData | null

Exports material to serializable asset data.

Parameters

material

number

Material handle

shaderPath

string

Shader file path for asset reference

parentPath?

string

Returns

MaterialAssetData | null

Material asset data