Caffeine

Forward render

Reference Rendering Last updated: Lua 6 · Dryad 0

Per-entity forward renderer features: instancing, image-based lighting, occlusion, reflections and volumetrics.

All namespaces

Namespace: caffeine.forwardrender

ensure#

Lua: caffeine.forwardrender.ensure

text
ensure(entity) -> boolean

Adds the forward-render features component to the entity if missing. The setters below do nothing without it.

ParametersTypeDescription
entitynumberEntity id.

Returns: boolean. false if the entity is invalid.

Example

lua
caffeine.forwardrender.ensure(cam)

setInstancing#

Lua: caffeine.forwardrender.setInstancing

text
setInstancing(entity, enabled, maxBatch)

Configures GPU instancing.

ParametersTypeDescription
entitynumberEntity id.
enabledbooleanTurns the feature on or off.
maxBatchnumberMaximum instances per batch. Optional.

Returns: none

Example

lua
caffeine.forwardrender.setInstancing(cam, true, 256)

setIbl#

Lua: caffeine.forwardrender.setIbl

text
setIbl(entity, enabled, diffuse, specular)

Configures image-based lighting.

ParametersTypeDescription
entitynumberEntity id.
enabledbooleanTurns the feature on or off.
diffusenumberDiffuse strength. Optional.
specularnumberSpecular strength. Optional.

Returns: none

Example

lua
caffeine.forwardrender.setIbl(cam, true, 1.0, 1.0)

setOcclusion#

Lua: caffeine.forwardrender.setOcclusion

text
setOcclusion(entity, enabled)

Turns occlusion on or off.

ParametersTypeDescription
entitynumberEntity id.
enabledbooleanTurns the feature on or off.

Returns: none

Example

lua
caffeine.forwardrender.setOcclusion(cam, true)

setReflections#

Lua: caffeine.forwardrender.setReflections

text
setReflections(entity, enabled, mode)

Configures reflections and their mode.

ParametersTypeDescription
entitynumberEntity id.
enabledbooleanTurns the feature on or off.
modenumber0 Off, 1 Planar, 2 ScreenSpace, 3 Probe; clamped to 0..3. Optional.

Returns: none

Example

lua
caffeine.forwardrender.setReflections(cam, true, 2)

setVolumetrics#

Lua: caffeine.forwardrender.setVolumetrics

text
setVolumetrics(entity, enabled, quality)

Configures volumetric fog and its quality.

ParametersTypeDescription
entitynumberEntity id.
enabledbooleanTurns the feature on or off.
qualitynumber0 Off, 1 Low, 2 Medium, 3 High; clamped to 0..3. Optional.

Returns: none

Example

lua
caffeine.forwardrender.setVolumetrics(cam, true, 2)