Caffeine

Render forward

Reference Rendering Última atualização: Lua 6 · Dryad 0

Funcionalidades do renderer forward por entidade: instancing, iluminação baseada em imagem, oclusão, reflexos e volumétricos.

Todos os namespaces

Namespace: caffeine.forwardrender

ensure#

Lua: caffeine.forwardrender.ensure

text
ensure(entity) -> boolean

Adiciona à entidade o componente de funcionalidades do render forward, se faltar. Os setters abaixo não fazem nada sem ele.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: boolean. false se a entidade for inválida.

Exemplo

lua
caffeine.forwardrender.ensure(cam)

setInstancing#

Lua: caffeine.forwardrender.setInstancing

text
setInstancing(entity, enabled, maxBatch)

Configura o instancing na GPU.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanLiga ou desliga a funcionalidade.
maxBatchnumberMáximo de instâncias por lote. Opcional.

Devolve: nada

Exemplo

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

setIbl#

Lua: caffeine.forwardrender.setIbl

text
setIbl(entity, enabled, diffuse, specular)

Configura a iluminação baseada em imagem.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanLiga ou desliga a funcionalidade.
diffusenumberIntensidade difusa. Opcional.
specularnumberIntensidade especular. Opcional.

Devolve: nada

Exemplo

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

setOcclusion#

Lua: caffeine.forwardrender.setOcclusion

text
setOcclusion(entity, enabled)

Liga ou desliga a oclusão.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanLiga ou desliga a funcionalidade.

Devolve: nada

Exemplo

lua
caffeine.forwardrender.setOcclusion(cam, true)

setReflections#

Lua: caffeine.forwardrender.setReflections

text
setReflections(entity, enabled, mode)

Configura os reflexos e o respetivo modo.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanLiga ou desliga a funcionalidade.
modenumber0 Off, 1 Planar, 2 ScreenSpace, 3 Probe; limitado a 0..3. Opcional.

Devolve: nada

Exemplo

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

setVolumetrics#

Lua: caffeine.forwardrender.setVolumetrics

text
setVolumetrics(entity, enabled, quality)

Configura o nevoeiro volumétrico e a respetiva qualidade.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanLiga ou desliga a funcionalidade.
qualitynumber0 Off, 1 Low, 2 Medium, 3 High; limitado a 0..3. Opcional.

Devolve: nada

Exemplo

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