Forward render
Per-entity forward renderer features: instancing, image-based lighting, occlusion, reflections and volumetrics.
Namespace: caffeine.forwardrender
ensure#
Lua: caffeine.forwardrender.ensure
ensure(entity) -> boolean
Adds the forward-render features component to the entity if missing. The setters below do nothing without it.
| Parameters | Type | Description |
|---|---|---|
entity | number | Entity id. |
Returns: boolean. false if the entity is invalid.
Example
caffeine.forwardrender.ensure(cam)
setInstancing#
Lua: caffeine.forwardrender.setInstancing
setInstancing(entity, enabled, maxBatch)
Configures GPU instancing.
| Parameters | Type | Description |
|---|---|---|
entity | number | Entity id. |
enabled | boolean | Turns the feature on or off. |
maxBatch | number | Maximum instances per batch. Optional. |
Returns: none
Example
caffeine.forwardrender.setInstancing(cam, true, 256)
setIbl#
Lua: caffeine.forwardrender.setIbl
setIbl(entity, enabled, diffuse, specular)
Configures image-based lighting.
| Parameters | Type | Description |
|---|---|---|
entity | number | Entity id. |
enabled | boolean | Turns the feature on or off. |
diffuse | number | Diffuse strength. Optional. |
specular | number | Specular strength. Optional. |
Returns: none
Example
caffeine.forwardrender.setIbl(cam, true, 1.0, 1.0)
setOcclusion#
Lua: caffeine.forwardrender.setOcclusion
setOcclusion(entity, enabled)
Turns occlusion on or off.
| Parameters | Type | Description |
|---|---|---|
entity | number | Entity id. |
enabled | boolean | Turns the feature on or off. |
Returns: none
Example
caffeine.forwardrender.setOcclusion(cam, true)
setReflections#
Lua: caffeine.forwardrender.setReflections
setReflections(entity, enabled, mode)
Configures reflections and their mode.
| Parameters | Type | Description |
|---|---|---|
entity | number | Entity id. |
enabled | boolean | Turns the feature on or off. |
mode | number | 0 Off, 1 Planar, 2 ScreenSpace, 3 Probe; clamped to 0..3. Optional. |
Returns: none
Example
caffeine.forwardrender.setReflections(cam, true, 2)
setVolumetrics#
Lua: caffeine.forwardrender.setVolumetrics
setVolumetrics(entity, enabled, quality)
Configures volumetric fog and its quality.
| Parameters | Type | Description |
|---|---|---|
entity | number | Entity id. |
enabled | boolean | Turns the feature on or off. |
quality | number | 0 Off, 1 Low, 2 Medium, 3 High; clamped to 0..3. Optional. |
Returns: none
Example
caffeine.forwardrender.setVolumetrics(cam, true, 2)