tecs.gfx.lighting

Bloomrecord#

record Bloom
    threshold: number
    knee: number
    intensity: number
end

The bloom tuning a frame is drawn with.

Fields

threshold: number

knee: number

intensity: number

BloomSpectype#

type BloomSpec = {
    threshold: number?,
    knee: number?,
    intensity: number?
}

What a caller passes to setBloom. Every field is optional.

DropShadow2Dstruct#

struct DropShadow2D
    height: number
end

Casts a stretched copy of the entity along the ground, away from light.

This darkens everything a light left, including ambient light, which Occluder2D cannot do. It blocks no light in return: a crowd of light-blocking silhouettes merges under the mask into one flat mat of darkness, so the thing that wants a contact shadow is exactly the thing that must not be an occluder. An entity carrying both is an occluder.

The nearest few lights by weight throw the copy. Adding a distant light does not move an established shadow.

Fields

height: number

Occluder2Dstruct#

struct Occluder2D
    height: number
end

Blocks light from reaching what lies behind the entity.

The renderer adds the silhouette to the occluder mask every light samples, so one entity blocks every light at the cost of one drawing of itself rather than one per light. It blocks each light's contribution, not ambient light. DropShadow2D handles ambient darkening.

Coverage is the silhouette the material already decided, so a circle, a rounded box, or a glyph casts the shape it draws with no threshold of its own to set.

Fields

height: number

PointLight2Dstruct#

struct PointLight2D
    height: number
    radius: number
    r: number
    g: number
    b: number
    intensity: number
end

Represents a light the deferred resolve accumulates.

Fields

height: number

radius: number

r: number

g: number

b: number

intensity: number

Shadowsrecord#

record Shadows
    steps: number
    margin: number
    height: number
    dropOpacity: number
    dropLength: number
end

The shadow tuning a frame is drawn with.

Fields

steps: number

margin: number

height: number

dropOpacity: number

dropLength: number

ShadowSpectype#

type ShadowSpec = {
    steps: number?,
    margin: number?,
    height: number?,
    dropOpacity: number?,
    dropLength: number?
}

What a caller passes to setShadows. Every field is optional.

ambientfunction#

function ambient(): number, number, number

Returns the ambient light every surface receives.

Returns

bloomfunction#

function bloom(): Bloom?

Returns the bloom tuning a frame is drawn with.

Returns

resetfunction#

function reset(): nil

Forgets every setting and returns to the engine's own defaults.

A test uses this so one suite's tuning does not reach the next.

Returns

setAmbientfunction#

function setAmbient(r: number, g: number, b: number): nil

Sets the light every surface receives before any light entity is counted.

Authored ambient occlusion reaches this term and nothing else: a point light is a directionally known contribution and is not hidden by a baked ambient value.

Arguments

Returns

Raises

• when a channel is negative or not finite

setBloomfunction#

function setBloom(spec: BloomSpec?): nil

Enables bloom and sets its tuning, or disables it.

Arguments

Returns

Raises

• when a field is not finite or falls outside its range

setShadowsfunction#

function setShadows(spec: ShadowSpec?): nil

Enables shadows and sets their tuning, or disables them.

Passing nil turns off the occluder mask, its blur, and the drop-shadow target, and the frame then runs neither those passes nor the draws that fill them.

Arguments

Returns

Raises

• when a field is not finite or falls outside its range

shadowsfunction#

function shadows(): Shadows?

Returns the shadow tuning a frame is drawn with.

Returns

CAST_FANOUTvariable#

const CAST_FANOUT: integer

Cast-list entries one caster occupies, whether or not that many lights reach it.

One per light a drop shadow is thrown by: four lights is more than any one character stands in, and the fourth is already fainter than a viewer picks out. It is uniform across casters, including the occluders that throw no copy at all, which is what makes an entry's rank its position modulo this and saves carrying one.

DropShadow2DComponentvariable#

const DropShadow2DComponent: components.FFIComponent<DropShadow2D>

The process-wide DropShadow2D component definition.

LIGHT_FLOATSvariable#

const LIGHT_FLOATS: integer

Floats one light occupies on the wire: position and radius, then color and intensity.

LIGHT_STRIDEvariable#

const LIGHT_STRIDE: integer

Bytes one light occupies on the wire.

MAX_LIGHTSvariable#

const MAX_LIGHTS: integer

Lights one frame resolves. Past this the remainder is dropped rather than reported, because the alternative is a frame that raises over a light nobody would have picked out of the image.

Occluder2DComponentvariable#

const Occluder2DComponent: components.FFIComponent<Occluder2D>

The process-wide Occluder2D component definition.

PointLight2DComponentvariable#

const PointLight2DComponent: components.FFIComponent<PointLight2D>

The process-wide PointLight2D component definition.

TILE_SLOTSvariable#

const TILE_SLOTS: integer

Lights one tile holds. A tile reached by more than this keeps the ones earliest in the light buffer, which is a stated choice rather than whichever the device happened to write first.

TILESvariable#

const TILES: integer

Tiles the view is divided into on each axis, so a fragment consults the lights that reach its tile rather than every light in the scene.

A count rather than a size in pixels, so the two tile buffers are allocated once and never replaced while a frame in flight is reading them. The same number appears in assets/shaders/wgsl/lighting.wgsl and the pair only works while they agree.