Lysa  0.0
Lysa 3D Engine
RenderTarget Class Referenceabstract

Detailed Description

A GPU surface that accumulates render views and drives the frame loop.

Lua full name: lysa.RenderTarget

Public Member Functions

nil add_view (view: RenderView)
 Adds a render view to this target. More...
 
nil update_view (view: RenderView)
 Updates an existing render view (e.g. after viewport changes). More...
 
nil remove_view (view: RenderView)
 Removes a render view from this target. More...
 
nil add_scene_renderer (renderer: Vector3DRenderer)
 Registers a 3-D scene renderer to be executed each frame. More...
 
nil remove_scene_renderer (renderer: Vector3DRenderer)
 Unregisters a previously added 3-D scene renderer. More...
 
nil add_ui_renderer (renderer: Vector2DRenderer)
 Registers a 2-D UI renderer to be executed each frame. More...
 
nil remove_ui_renderer (renderer: Vector2DRenderer)
 Unregisters a previously added 2-D UI renderer. More...
 
nil wait_idle ()
 Blocks the calling thread until the GPU has finished all pending work for this target. More...
 
nil set_gamma_correction_parameters (gamma: number, exposure: number)
 Sets the gamma and exposure values for the tonemapping/gamma-correction pass applied to the 3-D scene. More...
 
nil set_vector_gamma_correction_parameters (gamma: number, exposure: number)
 Sets the gamma and exposure values applied specifically to vector (2-D/3-D overlay) renderers. More...
 

Properties

integer id
 Unique render target identifier.
 
number aspect_ratio
 Aspect ratio (width / height). (read-only)
 
number width
 Render target width in pixels. (read-only)
 
number height
 Render target height in pixels. (read-only)
 
boolean paused
 Whether the render loop is paused.
 
boolean display_physics_debug
 Whether physics debug overlays are displayed (only available in debug builds with physics enabled).
 
integer frames_in_flight
 Number of frames in flight for this target. (read-only)
 
integer current_frame_index
 Index of the current frame in flight (0-based). (read-only)
 
vireo.ImageFormat image_format
 The swapchain image format. (read-only)
 
RendererConfiguration renderer_configuration
 The renderer configuration used to create this target. (read-only)
 
Renderer renderer
 The active 3-D renderer attached to this target. (read-only)
 

Member Function Documentation

nil add_view ( RenderView  view)

Adds a render view to this target.

Parameters
viewRenderView
nil update_view ( RenderView  view)

Updates an existing render view (e.g. after viewport changes).

Parameters
viewRenderView
nil remove_view ( RenderView  view)

Removes a render view from this target.

Parameters
viewRenderView
nil add_scene_renderer ( Vector3DRenderer  renderer)

Registers a 3-D scene renderer to be executed each frame.

Parameters
rendererVector3DRenderer
nil remove_scene_renderer ( Vector3DRenderer  renderer)

Unregisters a previously added 3-D scene renderer.

Parameters
rendererVector3DRenderer
nil add_ui_renderer ( Vector2DRenderer  renderer)

Registers a 2-D UI renderer to be executed each frame.

Parameters
rendererVector2DRenderer
nil remove_ui_renderer ( Vector2DRenderer  renderer)

Unregisters a previously added 2-D UI renderer.

Parameters
rendererVector2DRenderer
nil wait_idle ( )

Blocks the calling thread until the GPU has finished all pending work for this target.

nil set_gamma_correction_parameters ( number  gamma,
number  exposure)

Sets the gamma and exposure values for the tonemapping/gamma-correction pass applied to the 3-D scene.

Parameters
gammanumber
exposurenumber
nil set_vector_gamma_correction_parameters ( number  gamma,
number  exposure)

Sets the gamma and exposure values applied specifically to vector (2-D/3-D overlay) renderers.

Parameters
gammanumber
exposurenumber

Property Documentation

integer id

Unique render target identifier.

number aspect_ratio

Aspect ratio (width / height). (read-only)

number width

Render target width in pixels. (read-only)

number height

Render target height in pixels. (read-only)

boolean paused

Whether the render loop is paused.

boolean display_physics_debug

Whether physics debug overlays are displayed (only available in debug builds with physics enabled).

integer frames_in_flight

Number of frames in flight for this target. (read-only)

integer current_frame_index

Index of the current frame in flight (0-based). (read-only)

vireo.ImageFormat image_format

The swapchain image format. (read-only)

RendererConfiguration renderer_configuration

The renderer configuration used to create this target. (read-only)

Renderer renderer

The active 3-D renderer attached to this target. (read-only)