TSL Docs

LightingModel

Last modified: Feb 19, 2025

Abstract class for implementing lighting models. The module defines multiple methods that concrete lighting models can implement. These methods are executed at different points during the light evaluation process.

Method Type Modifiers

start (builder: NodeBuilder) => void —

This method is intended for setting up lighting model and context data which are later used in the evaluation process.

Parameter	Type	Default Value
builder	`NodeBuilder`	—

Returns

void

finish () => void —

This method is intended for executing final tasks like final updates to the outgoing light.

Returns

void

direct () => void —

This method is intended for implementing the direct light term and executed during the build process of directional, point and spot light nodes.

Returns

void

directRectArea () => void —

This method is intended for implementing the direct light term for rect area light nodes.

Returns

void

indirect () => void —

This method is intended for implementing the indirect light term.

Returns

void

ambientOcclusion () => void —

This method is intended for implementing the ambient occlusion term. Unlike other methods, this method must be called manually by the lighting model in its indirect term.

Returns

void