Lysa  0.0
Lysa 3D Engine
Renderer Class Referenceabstract

Detailed Description

Abstract base type for the active 3-D renderer (forward or deferred).

Lua full name: lysa.Renderer

Public Member Functions

nil add_postprocessing (pass: PostProcessingCompute)
 Appends a full-screen compute post-processing pass to the chain. Passes execute after bloom and before AA. More...
 
nil remove_postprocessing (pass: PostProcessingCompute)
 Removes a previously added post-processing pass. More...
 
nil remove_postprocessing (comp_shader_name: string)
 Removes a previously added post-processing pass by its compute shader file name. More...
 
nil add_render_pass (phase: integer, pass: CustomRenderpass)
 Registers a custom render pass to be executed at the given RenderingPhase, after the built-in ShaderMaterialPass for that phase. The caller retains ownership; the pass must outlive the Renderer. More...
 
nil remove_render_pass (phase: integer, pass: CustomRenderpass)
 Removes a previously registered custom render pass from the given phase. Silently ignored if the pass was not registered for that phase. More...
 

Properties

vireo.ImageFormat output_format
 Final output pixel format produced after the tonemapping pass. (read-only)
 
vireo.Extent extent
 Current rendering extent (width × height). May differ from the swap-chain extent when a fixed rendering resolution is configured. (read-only)
 

Member Function Documentation

nil add_postprocessing ( PostProcessingCompute  pass)

Appends a full-screen compute post-processing pass to the chain. Passes execute after bloom and before AA.

Parameters
passPostProcessingCompute
nil remove_postprocessing ( PostProcessingCompute  pass)

Removes a previously added post-processing pass.

Parameters
passPostProcessingCompute
nil remove_postprocessing ( string  comp_shader_name)

Removes a previously added post-processing pass by its compute shader file name.

Parameters
comp_shader_namestring
nil add_render_pass ( integer  phase,
CustomRenderpass  pass)

Registers a custom render pass to be executed at the given RenderingPhase, after the built-in ShaderMaterialPass for that phase. The caller retains ownership; the pass must outlive the Renderer.

Parameters
phaseinteger
passCustomRenderpass
nil remove_render_pass ( integer  phase,
CustomRenderpass  pass)

Removes a previously registered custom render pass from the given phase. Silently ignored if the pass was not registered for that phase.

Parameters
phaseinteger
passCustomRenderpass

Property Documentation

vireo.ImageFormat output_format

Final output pixel format produced after the tonemapping pass. (read-only)

vireo.Extent extent

Current rendering extent (width × height). May differ from the swap-chain extent when a fixed rendering resolution is configured. (read-only)