Caffeine

Pós-processamento

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

Efeitos de pós-processamento por entidade, como bloom, vinheta, correção de cor e nevoeiro, com presets e acesso a campos por caminho.

Todos os namespaces

Namespace: caffeine.postprocess

has#

Lua: caffeine.postprocess.has

text
has(entity) -> boolean

Verifica se a entidade tem um componente de pós-processamento.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: boolean. true se a entidade tiver um componente de pós-processamento.

Exemplo

lua
if caffeine.postprocess.has(cam) then print('ok') end

add#

Lua: caffeine.postprocess.add

text
add(entity) -> boolean

Adiciona um componente de pós-processamento à entidade, se ainda não tiver.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: boolean. false se a entidade não estiver viva.

Exemplo

lua
caffeine.postprocess.add(cam)

remove#

Lua: caffeine.postprocess.remove

text
remove(entity)

Remove o componente de pós-processamento da entidade, se existir.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: nada

Exemplo

lua
caffeine.postprocess.remove(cam)

get#

Lua: caffeine.postprocess.get

text
get(entity) -> table

Devolve uma tabela com o estado completo de pós-processamento.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: table. Uma tabela com grupos de efeitos (por exemplo bloom, vignette) e os seus campos, mais enabled, customEffectScript e os aliases exposure, vignetteIntensity, bloomIntensity. Vazia se a entidade não tiver o componente.

Exemplo

lua
local s = caffeine.postprocess.get(cam)
print(s.bloom.intensity)

set#

Lua: caffeine.postprocess.set

text
set(entity, values) -> boolean

Aplica uma tabela de valores ao estado de pós-processamento.

ParâmetrosTipoDescrição
entitynumberId da entidade.
valuestableTabela com o formato do resultado de `get`; só as chaves presentes são aplicadas.

Devolve: boolean. false se a entidade não tiver o componente.

Exemplo

lua
caffeine.postprocess.set(cam, { bloom = { intensity = 0.8 } })

getValue#

Lua: caffeine.postprocess.getValue

text
getValue(entity, path) -> number|boolean|nil

Lê um campo pelo seu caminho.

ParâmetrosTipoDescrição
entitynumberId da entidade.
pathstringCaminho do campo, por exemplo "bloom.intensity".

Devolve: number|boolean|nil. O valor do campo, ou nil se a entidade ou o campo não existirem.

Exemplo

lua
print(caffeine.postprocess.getValue(cam, 'bloom.intensity'))

setValue#

Lua: caffeine.postprocess.setValue

text
setValue(entity, path, value) -> boolean

Escreve um campo pelo seu caminho.

ParâmetrosTipoDescrição
entitynumberId da entidade.
pathstringCaminho do campo, por exemplo "bloom.intensity".
valuenumber|booleanNovo valor.

Devolve: boolean. true se o campo foi alterado.

Exemplo

lua
caffeine.postprocess.setValue(cam, 'bloom.threshold', 1.0)

effects#

Lua: caffeine.postprocess.effects

text
effects() -> table

Lista os nomes dos efeitos de pós-processamento disponíveis.

Devolve: table. Lista de nomes de efeitos.

Exemplo

lua
for _, name in ipairs(caffeine.postprocess.effects()) do print(name) end

fields#

Lua: caffeine.postprocess.fields

text
fields(effect) -> table

Lista os campos de um efeito com os respetivos intervalos e tipos.

ParâmetrosTipoDescrição
effectstringNome do efeito, por exemplo "bloom".

Devolve: table. Lista de tabelas com name, min, max e type ("bool", "int" ou "number").

Exemplo

lua
for _, f in ipairs(caffeine.postprocess.fields('bloom')) do print(f.name, f.min, f.max) end

setEnabled#

Lua: caffeine.postprocess.setEnabled

text
setEnabled(entity, enabled)

Liga ou desliga todo o componente de pós-processamento.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanInterruptor geral.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setEnabled(cam, false)

enableEffect#

Lua: caffeine.postprocess.enableEffect

text
enableEffect(entity, effect, enabled) -> boolean

Liga ou desliga um único efeito.

ParâmetrosTipoDescrição
entitynumberId da entidade.
effectstringNome do efeito, por exemplo "bloom".
enabledbooleanSe o efeito fica ligado.

Devolve: boolean. true se o efeito existir.

Exemplo

lua
caffeine.postprocess.enableEffect(cam, 'bloom', true)

isEffectEnabled#

Lua: caffeine.postprocess.isEffectEnabled

text
isEffectEnabled(entity, effect) -> boolean

Verifica se um efeito está ligado.

ParâmetrosTipoDescrição
entitynumberId da entidade.
effectstringNome do efeito, por exemplo "bloom".

Devolve: boolean. true se o efeito estiver ligado; false se estiver desligado ou for desconhecido.

Exemplo

lua
print(caffeine.postprocess.isEffectEnabled(cam, 'bloom'))

applyPreset#

Lua: caffeine.postprocess.applyPreset

text
applyPreset(entity, name) -> boolean

Aplica um preset de pós-processamento incluído.

ParâmetrosTipoDescrição
entitynumberId da entidade.
namestringUm de "cinematic", "horror", "arcade", "reset" (ou "default").

Devolve: boolean. false para um preset desconhecido ou componente em falta.

Exemplo

lua
caffeine.postprocess.applyPreset(cam, 'cinematic')

blend#

Lua: caffeine.postprocess.blend

text
blend(entity, from, to, t) -> boolean

Interpola entre duas tabelas de valores (cada uma aplicada sobre o estado atual) e guarda o resultado.

ParâmetrosTipoDescrição
entitynumberId da entidade.
fromtableTabela de valores para o estado inicial.
totableTabela de valores para o estado final.
tnumberFator de mistura, limitado a 0..1.

Devolve: boolean. false se a entidade não tiver o componente.

Exemplo

lua
caffeine.postprocess.blend(cam, { bloom = { intensity = 0 } }, { bloom = { intensity = 1 } }, 0.5)

setExposure#

Lua: caffeine.postprocess.setExposure

text
setExposure(entity, exposure)

Define a exposição da correção de cor e ativa-a.

ParâmetrosTipoDescrição
entitynumberId da entidade.
exposurenumberValor de exposição.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setExposure(cam, 1.2)

setColorGrading#

Lua: caffeine.postprocess.setColorGrading

text
setColorGrading(entity, contrast, saturation, temperature, tint)

Define valores de correção de cor e ativa-a.

ParâmetrosTipoDescrição
entitynumberId da entidade.
contrastnumberContraste.
saturationnumberSaturação.
temperaturenumberTemperatura de cor. Opcional.
tintnumberMatiz. Opcional.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setColorGrading(cam, 1.1, 0.9)

setBloom#

Lua: caffeine.postprocess.setBloom

text
setBloom(entity, intensity, threshold)

Define a intensidade do bloom e, opcionalmente, o limiar.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade do bloom; o efeito fica ativo acima de 0.001.
thresholdnumberLimiar de brilho. Opcional.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setBloom(cam, 0.6, 1.0)

setVignette#

Lua: caffeine.postprocess.setVignette

text
setVignette(entity, intensity)

Define a intensidade da vinheta.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade; ativo acima de 0.001.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setVignette(cam, 0.4)

setChromaticAberration#

Lua: caffeine.postprocess.setChromaticAberration

text
setChromaticAberration(entity, intensity)

Define a intensidade da aberração cromática.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade; ativo acima de 0.001.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setChromaticAberration(cam, 0.2)

setGrain#

Lua: caffeine.postprocess.setGrain

text
setGrain(entity, intensity)

Define a intensidade do grão de película.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade; ativo acima de 0.001.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setGrain(cam, 0.1)

setLensDistortion#

Lua: caffeine.postprocess.setLensDistortion

text
setLensDistortion(entity, intensity)

Define a intensidade da distorção de lente.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade; ativo quando o valor absoluto é superior a 0.001.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setLensDistortion(cam, -0.1)

setMotionBlur#

Lua: caffeine.postprocess.setMotionBlur

text
setMotionBlur(entity, intensity)

Define a intensidade do desfoque de movimento.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade; ativo acima de 0.001.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setMotionBlur(cam, 0.5)

setDepthOfField#

Lua: caffeine.postprocess.setDepthOfField

text
setDepthOfField(entity, focusDistance, aperture)

Define o foco e a abertura da profundidade de campo e ativa o efeito.

ParâmetrosTipoDescrição
entitynumberId da entidade.
focusDistancenumberDistância de foco.
aperturenumberAbertura.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setDepthOfField(cam, 10, 2.8)

setFog#

Lua: caffeine.postprocess.setFog

text
setFog(entity, density, r, g, b)

Define a densidade do nevoeiro diferido e, opcionalmente, a cor.

ParâmetrosTipoDescrição
entitynumberId da entidade.
densitynumberDensidade do nevoeiro; ativo acima de 0.001.
rnumberVermelho; a cor só é aplicada se r, g e b forem todos indicados. Opcional.
gnumberVerde. Opcional.
bnumberAzul. Opcional.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setFog(cam, 0.02, 0.6, 0.7, 0.8)

setAmbientOcclusion#

Lua: caffeine.postprocess.setAmbientOcclusion

text
setAmbientOcclusion(entity, intensity, radius)

Define a intensidade da oclusão ambiente e, opcionalmente, o raio.

ParâmetrosTipoDescrição
entitynumberId da entidade.
intensitynumberIntensidade; ativo acima de 0.001.
radiusnumberRaio de amostragem. Opcional.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setAmbientOcclusion(cam, 1.0, 0.5)

setAntiAliasing#

Lua: caffeine.postprocess.setAntiAliasing

text
setAntiAliasing(entity, mode)

Seleciona o modo de anti-aliasing; "off" e "none" desativam-no.

ParâmetrosTipoDescrição
entitynumberId da entidade.
modestring"fxaa", "off" ou "none"; qualquer outro valor seleciona o modo que não é FXAA.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setAntiAliasing(cam, 'fxaa')

setAutoExposure#

Lua: caffeine.postprocess.setAutoExposure

text
setAutoExposure(entity, enabled, compensation)

Liga ou desliga a exposição automática e, opcionalmente, define a compensação.

ParâmetrosTipoDescrição
entitynumberId da entidade.
enabledbooleanLiga ou desliga a exposição automática.
compensationnumberCompensação de exposição. Opcional.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setAutoExposure(cam, true, 0.5)

setCustomScript#

Lua: caffeine.postprocess.setCustomScript

text
setCustomScript(entity, path)

Define o script de efeito personalizado da entidade.

ParâmetrosTipoDescrição
entitynumberId da entidade.
pathstringCaminho do script de efeito personalizado.

Devolve: nada

Exemplo

lua
caffeine.postprocess.setCustomScript(cam, 'scripts/fx.lua')

handle#

Lua: caffeine.postprocess.handle

text
handle(entity) -> table

Devolve um handle por entidade, do mesmo tipo passado a onPostProcess, para que as chamadas não precisem do id.

ParâmetrosTipoDescrição
entitynumberId da entidade.

Devolve: table. Tabela com entity, get, set, enable, isEnabled, snapshot, apply e preset, todas ligadas à entidade.

Exemplo

lua
local h = caffeine.postprocess.handle(cam)
h.set('bloom.intensity', 0.5)