Class RendererData

The RendererData class is used to manage the lighting settings of a scene.
It is created and used within the Needle Engine Context.

Index

Constructors

Accessors

environmentIntensity sceneLightSettings timeVec4

Methods

disable disableCurrent enable

Constructors

constructor

new RendererData(context): RendererData
Parameters
- context: Context
Returns RendererData

Accessors

environmentIntensity

get environmentIntensity(): number
the current environment intensity

Returns number

sceneLightSettings

get sceneLightSettings(): undefined | IterableIterator<SceneLightSettings>
Get all currently registered scene light settings

Returns undefined | IterableIterator<SceneLightSettings>

timeVec4

get timeVec4(): Vector4
Time data used for custom shaders x: time y: sin(time) z: cos(time) w: deltaTime

Returns Vector4

Methods

disable

disable(sourceId): boolean
disable the lighting of a specific scene, will only have any effect if it is currently active
Parameters
- sourceId: string | AssetReference
Returns boolean

disableCurrent

disableCurrent(): null | string
Disables the currently active scene lighting (if any), returns the id of the previously active lighting

Returns null | string

enable

enable(sourceId): boolean
set the scene lighting from a specific scene. Will disable any previously enabled lighting settings
Parameters
- sourceId: string | AssetReference
Returns boolean