Render forward
Funcionalidades do renderer forward por entidade: instancing, iluminação baseada em imagem, oclusão, reflexos e volumétricos.
Namespace: caffeine.forwardrender
ensure#
Lua: caffeine.forwardrender.ensure
ensure(entity) -> boolean
Adiciona à entidade o componente de funcionalidades do render forward, se faltar. Os setters abaixo não fazem nada sem ele.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
Devolve: boolean. false se a entidade for inválida.
Exemplo
caffeine.forwardrender.ensure(cam)
setInstancing#
Lua: caffeine.forwardrender.setInstancing
setInstancing(entity, enabled, maxBatch)
Configura o instancing na GPU.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Liga ou desliga a funcionalidade. |
maxBatch | number | Máximo de instâncias por lote. Opcional. |
Devolve: nada
Exemplo
caffeine.forwardrender.setInstancing(cam, true, 256)
setIbl#
Lua: caffeine.forwardrender.setIbl
setIbl(entity, enabled, diffuse, specular)
Configura a iluminação baseada em imagem.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Liga ou desliga a funcionalidade. |
diffuse | number | Intensidade difusa. Opcional. |
specular | number | Intensidade especular. Opcional. |
Devolve: nada
Exemplo
caffeine.forwardrender.setIbl(cam, true, 1.0, 1.0)
setOcclusion#
Lua: caffeine.forwardrender.setOcclusion
setOcclusion(entity, enabled)
Liga ou desliga a oclusão.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Liga ou desliga a funcionalidade. |
Devolve: nada
Exemplo
caffeine.forwardrender.setOcclusion(cam, true)
setReflections#
Lua: caffeine.forwardrender.setReflections
setReflections(entity, enabled, mode)
Configura os reflexos e o respetivo modo.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Liga ou desliga a funcionalidade. |
mode | number | 0 Off, 1 Planar, 2 ScreenSpace, 3 Probe; limitado a 0..3. Opcional. |
Devolve: nada
Exemplo
caffeine.forwardrender.setReflections(cam, true, 2)
setVolumetrics#
Lua: caffeine.forwardrender.setVolumetrics
setVolumetrics(entity, enabled, quality)
Configura o nevoeiro volumétrico e a respetiva qualidade.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Liga ou desliga a funcionalidade. |
quality | number | 0 Off, 1 Low, 2 Medium, 3 High; limitado a 0..3. Opcional. |
Devolve: nada
Exemplo
caffeine.forwardrender.setVolumetrics(cam, true, 2)