API reference

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

I

interfaceLitMaterialOptions

@codexo/exojs-lighting / lighting / stable

Construction options for LitMaterial.

5
props
0
methods
0
events
Import
import { LitMaterialOptions } from '@codexo/exojs-lighting'

Construction options for LitMaterial.

Properties5
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…
Blend mode for sprites drawn with this material.
emissive?: number
How much light the surface emits of its own, as a multiplier on its albedo. 0 emits nothing, 1 makes the surface as bright as full white light would, above 1 pushes it past what a light could - which is what a filter in post keyed on a threshold is there to catch. It is added to the light term rather than to the colour, so a transparent pixel stays transparent and emission scales the albedo the way a light does: a black pixel emits nothing however high this is. Defaults to 0.
lighting: LightingWhat a lighting system does with lights, materials and occluders, whichever renderer turns them into pixels. ```ts const lighting = new LightmapLighting(app, {…
The system whose lights this material shades against.
normals?: NormalSourceWhere a LitMaterial takes its surface normals from. An object rather than a name, so a source carries its own parameters and a user can add one: anything that…
Where the surface normals come from. Omitted, the surface is flat and lit as a plane - which is the point: a scene with no authored normal maps is lit rather than black, and normals are an upgrade instead of an entry fee.
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
Sampler for the base texture.
Source
packages/exojs-lighting/src/LitMaterial.ts