Class SkinnedLitProgram

The skinned Lambert-lit pipeline (§54, §57, §68; RFC 0003) — LitProgram's contract plus the palette. Lights, punctual set, and §69 shadow state are the same shared uniform classes the lit and standard pipelines use, so the skip rules cannot drift.

Implements

Index

Accessors

Methods

dispose setAmbientLight setColor setDirectionalLight setFeatures setHemisphereLight setJointMatrices setModel setPunctualLights setReceivesShadow setShadow setViewProjection use create

Accessors

disposed

get disposed(): boolean
Whether SkinnedLitProgram.dispose has run.

Returns boolean
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:97

Methods

dispose

dispose(): void
Deletes the GL program (§83). Idempotent; live context only.

Returns void
Implementation of Disposable.dispose
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:115

setAmbientLight

setAmbientLight(color: readonly [number, number, number]): void
Uploads the scene ambient term (§68).
Parameters
- color: readonly [number, number, number]
Returns void
Implementation of SkinnedLitPipeline.setAmbientLight
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:102

setColor

setColor(
color: readonly [number, number, number, number],
opacity?: number,
): void
Parameters
- color: readonly [number, number, number, number]
- Optionalopacity: number
Returns void
Implementation of SkinnedLitPipeline.setColor
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:101

setDirectionalLight

setDirectionalLight(
direction: { x: number; y: number; z: number },
color: readonly [number, number, number],
): void
Uploads the directional light (§68).
Parameters
- direction: { x: number; y: number; z: number }
- color: readonly [number, number, number]
Returns void
Implementation of SkinnedLitPipeline.setDirectionalLight
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:103

setFeatures

setFeatures(useMap: boolean): void
Selects whether this draw samples the bound albedo texture.
Parameters
- useMap: boolean
Returns void
Implementation of SkinnedLitPipeline.setFeatures
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:112

setHemisphereLight

setHemisphereLight(lights: SceneLights): void
Uploads the frame's hemisphere, or nothing (§68).
Parameters
- lights: SceneLights
Returns void
Implementation of SkinnedLitPipeline.setHemisphereLight
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:109

setJointMatrices

setJointMatrices(palette: Float32Array): void
Parameters
- palette: Float32Array
Returns void
Implementation of SkinnedLitPipeline.setJointMatrices
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:113

setModel

setModel(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Implementation of SkinnedLitPipeline.setModel
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:100

setPunctualLights

setPunctualLights(lights: SceneLights): void
Uploads the frame's point and spot lights, or nothing (§68, R-17).
Parameters
- lights: SceneLights
Returns void
Implementation of SkinnedLitPipeline.setPunctualLights
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:108

setReceivesShadow

setReceivesShadow(receiving: boolean): void
Switches the shadow comparison per draw (§49's receiveShadow).
Parameters
- receiving: boolean
Returns void
Implementation of SkinnedLitPipeline.setReceivesShadow
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:111

setShadow

setShadow(lights: SceneLights): void
Uploads the frame's shadow state, or nothing (§69, R-18).
Parameters
- lights: SceneLights
Returns void
Implementation of SkinnedLitPipeline.setShadow
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:110

setViewProjection

setViewProjection(matrix: Matrix4): void
Parameters
- matrix: Matrix4
Returns void
Implementation of SkinnedLitPipeline.setViewProjection
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:99

use

use(): void
Returns void
Implementation of SkinnedLitPipeline.use
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:98

`Static`create

create(gl: WebglContext): SkinnedLitProgram
Compiles and links the program — LitProgram.create's contract (§89).
Parameters
- gl: WebglContext
Returns SkinnedLitProgram
- Defined in packages/render-webgl/dist/gl-skinning.d.ts:95