Pós-processamento
Efeitos de pós-processamento por entidade, como bloom, vinheta, correção de cor e nevoeiro, com presets e acesso a campos por caminho.
Namespace: caffeine.postprocess
has#
Lua: caffeine.postprocess.has
has(entity) -> boolean
Verifica se a entidade tem um componente de pós-processamento.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
Devolve: boolean. true se a entidade tiver um componente de pós-processamento.
Exemplo
if caffeine.postprocess.has(cam) then print('ok') end
add#
Lua: caffeine.postprocess.add
add(entity) -> boolean
Adiciona um componente de pós-processamento à entidade, se ainda não tiver.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
Devolve: boolean. false se a entidade não estiver viva.
Exemplo
caffeine.postprocess.add(cam)
remove#
Lua: caffeine.postprocess.remove
remove(entity)
Remove o componente de pós-processamento da entidade, se existir.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
Devolve: nada
Exemplo
caffeine.postprocess.remove(cam)
get#
Lua: caffeine.postprocess.get
get(entity) -> table
Devolve uma tabela com o estado completo de pós-processamento.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id 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
local s = caffeine.postprocess.get(cam)
print(s.bloom.intensity)
set#
Lua: caffeine.postprocess.set
set(entity, values) -> boolean
Aplica uma tabela de valores ao estado de pós-processamento.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
values | table | Tabela 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
caffeine.postprocess.set(cam, { bloom = { intensity = 0.8 } })
getValue#
Lua: caffeine.postprocess.getValue
getValue(entity, path) -> number|boolean|nil
Lê um campo pelo seu caminho.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
path | string | Caminho 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
print(caffeine.postprocess.getValue(cam, 'bloom.intensity'))
setValue#
Lua: caffeine.postprocess.setValue
setValue(entity, path, value) -> boolean
Escreve um campo pelo seu caminho.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
path | string | Caminho do campo, por exemplo "bloom.intensity". |
value | number|boolean | Novo valor. |
Devolve: boolean. true se o campo foi alterado.
Exemplo
caffeine.postprocess.setValue(cam, 'bloom.threshold', 1.0)
effects#
Lua: caffeine.postprocess.effects
effects() -> table
Lista os nomes dos efeitos de pós-processamento disponíveis.
Devolve: table. Lista de nomes de efeitos.
Exemplo
for _, name in ipairs(caffeine.postprocess.effects()) do print(name) end
fields#
Lua: caffeine.postprocess.fields
fields(effect) -> table
Lista os campos de um efeito com os respetivos intervalos e tipos.
| Parâmetros | Tipo | Descrição |
|---|---|---|
effect | string | Nome do efeito, por exemplo "bloom". |
Devolve: table. Lista de tabelas com name, min, max e type ("bool", "int" ou "number").
Exemplo
for _, f in ipairs(caffeine.postprocess.fields('bloom')) do print(f.name, f.min, f.max) end
setEnabled#
Lua: caffeine.postprocess.setEnabled
setEnabled(entity, enabled)
Liga ou desliga todo o componente de pós-processamento.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Interruptor geral. |
Devolve: nada
Exemplo
caffeine.postprocess.setEnabled(cam, false)
enableEffect#
Lua: caffeine.postprocess.enableEffect
enableEffect(entity, effect, enabled) -> boolean
Liga ou desliga um único efeito.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
effect | string | Nome do efeito, por exemplo "bloom". |
enabled | boolean | Se o efeito fica ligado. |
Devolve: boolean. true se o efeito existir.
Exemplo
caffeine.postprocess.enableEffect(cam, 'bloom', true)
isEffectEnabled#
Lua: caffeine.postprocess.isEffectEnabled
isEffectEnabled(entity, effect) -> boolean
Verifica se um efeito está ligado.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
effect | string | Nome do efeito, por exemplo "bloom". |
Devolve: boolean. true se o efeito estiver ligado; false se estiver desligado ou for desconhecido.
Exemplo
print(caffeine.postprocess.isEffectEnabled(cam, 'bloom'))
applyPreset#
Lua: caffeine.postprocess.applyPreset
applyPreset(entity, name) -> boolean
Aplica um preset de pós-processamento incluído.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
name | string | Um de "cinematic", "horror", "arcade", "reset" (ou "default"). |
Devolve: boolean. false para um preset desconhecido ou componente em falta.
Exemplo
caffeine.postprocess.applyPreset(cam, 'cinematic')
blend#
Lua: caffeine.postprocess.blend
blend(entity, from, to, t) -> boolean
Interpola entre duas tabelas de valores (cada uma aplicada sobre o estado atual) e guarda o resultado.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
from | table | Tabela de valores para o estado inicial. |
to | table | Tabela de valores para o estado final. |
t | number | Fator de mistura, limitado a 0..1. |
Devolve: boolean. false se a entidade não tiver o componente.
Exemplo
caffeine.postprocess.blend(cam, { bloom = { intensity = 0 } }, { bloom = { intensity = 1 } }, 0.5)
setExposure#
Lua: caffeine.postprocess.setExposure
setExposure(entity, exposure)
Define a exposição da correção de cor e ativa-a.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
exposure | number | Valor de exposição. |
Devolve: nada
Exemplo
caffeine.postprocess.setExposure(cam, 1.2)
setColorGrading#
Lua: caffeine.postprocess.setColorGrading
setColorGrading(entity, contrast, saturation, temperature, tint)
Define valores de correção de cor e ativa-a.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
contrast | number | Contraste. |
saturation | number | Saturação. |
temperature | number | Temperatura de cor. Opcional. |
tint | number | Matiz. Opcional. |
Devolve: nada
Exemplo
caffeine.postprocess.setColorGrading(cam, 1.1, 0.9)
setBloom#
Lua: caffeine.postprocess.setBloom
setBloom(entity, intensity, threshold)
Define a intensidade do bloom e, opcionalmente, o limiar.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade do bloom; o efeito fica ativo acima de 0.001. |
threshold | number | Limiar de brilho. Opcional. |
Devolve: nada
Exemplo
caffeine.postprocess.setBloom(cam, 0.6, 1.0)
setVignette#
Lua: caffeine.postprocess.setVignette
setVignette(entity, intensity)
Define a intensidade da vinheta.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade; ativo acima de 0.001. |
Devolve: nada
Exemplo
caffeine.postprocess.setVignette(cam, 0.4)
setChromaticAberration#
Lua: caffeine.postprocess.setChromaticAberration
setChromaticAberration(entity, intensity)
Define a intensidade da aberração cromática.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade; ativo acima de 0.001. |
Devolve: nada
Exemplo
caffeine.postprocess.setChromaticAberration(cam, 0.2)
setGrain#
Lua: caffeine.postprocess.setGrain
setGrain(entity, intensity)
Define a intensidade do grão de película.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade; ativo acima de 0.001. |
Devolve: nada
Exemplo
caffeine.postprocess.setGrain(cam, 0.1)
setLensDistortion#
Lua: caffeine.postprocess.setLensDistortion
setLensDistortion(entity, intensity)
Define a intensidade da distorção de lente.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade; ativo quando o valor absoluto é superior a 0.001. |
Devolve: nada
Exemplo
caffeine.postprocess.setLensDistortion(cam, -0.1)
setMotionBlur#
Lua: caffeine.postprocess.setMotionBlur
setMotionBlur(entity, intensity)
Define a intensidade do desfoque de movimento.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade; ativo acima de 0.001. |
Devolve: nada
Exemplo
caffeine.postprocess.setMotionBlur(cam, 0.5)
setDepthOfField#
Lua: caffeine.postprocess.setDepthOfField
setDepthOfField(entity, focusDistance, aperture)
Define o foco e a abertura da profundidade de campo e ativa o efeito.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
focusDistance | number | Distância de foco. |
aperture | number | Abertura. |
Devolve: nada
Exemplo
caffeine.postprocess.setDepthOfField(cam, 10, 2.8)
setFog#
Lua: caffeine.postprocess.setFog
setFog(entity, density, r, g, b)
Define a densidade do nevoeiro diferido e, opcionalmente, a cor.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
density | number | Densidade do nevoeiro; ativo acima de 0.001. |
r | number | Vermelho; a cor só é aplicada se r, g e b forem todos indicados. Opcional. |
g | number | Verde. Opcional. |
b | number | Azul. Opcional. |
Devolve: nada
Exemplo
caffeine.postprocess.setFog(cam, 0.02, 0.6, 0.7, 0.8)
setAmbientOcclusion#
Lua: caffeine.postprocess.setAmbientOcclusion
setAmbientOcclusion(entity, intensity, radius)
Define a intensidade da oclusão ambiente e, opcionalmente, o raio.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
intensity | number | Intensidade; ativo acima de 0.001. |
radius | number | Raio de amostragem. Opcional. |
Devolve: nada
Exemplo
caffeine.postprocess.setAmbientOcclusion(cam, 1.0, 0.5)
setAntiAliasing#
Lua: caffeine.postprocess.setAntiAliasing
setAntiAliasing(entity, mode)
Seleciona o modo de anti-aliasing; "off" e "none" desativam-no.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
mode | string | "fxaa", "off" ou "none"; qualquer outro valor seleciona o modo que não é FXAA. |
Devolve: nada
Exemplo
caffeine.postprocess.setAntiAliasing(cam, 'fxaa')
setAutoExposure#
Lua: caffeine.postprocess.setAutoExposure
setAutoExposure(entity, enabled, compensation)
Liga ou desliga a exposição automática e, opcionalmente, define a compensação.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
enabled | boolean | Liga ou desliga a exposição automática. |
compensation | number | Compensação de exposição. Opcional. |
Devolve: nada
Exemplo
caffeine.postprocess.setAutoExposure(cam, true, 0.5)
setCustomScript#
Lua: caffeine.postprocess.setCustomScript
setCustomScript(entity, path)
Define o script de efeito personalizado da entidade.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
path | string | Caminho do script de efeito personalizado. |
Devolve: nada
Exemplo
caffeine.postprocess.setCustomScript(cam, 'scripts/fx.lua')
handle#
Lua: caffeine.postprocess.handle
handle(entity) -> table
Devolve um handle por entidade, do mesmo tipo passado a onPostProcess, para que as chamadas não precisem do id.
| Parâmetros | Tipo | Descrição |
|---|---|---|
entity | number | Id da entidade. |
Devolve: table. Tabela com entity, get, set, enable, isEnabled, snapshot, apply e preset, todas ligadas à entidade.
Exemplo
local h = caffeine.postprocess.handle(cam)
h.set('bloom.intensity', 0.5)