Lysa.ui  0.0
Lysa 3D Engine
WindowManager Class Referenceabstract

Detailed Description

The central manager for all UI windows attached to a rendering target.

Lua full name: lysa.ui.WindowManager

Public Member Functions

Window create (rect: lysa.Rect)
 Creates and registers a new UI window with the given position and size. More...
 
Window add (window: Window)
 Registers an existing UI window with this manager so it receives update and render calls. More...
 
nil remove (window: Window)
 Unregisters and destroys the given UI window (effective at the start of the next frame). More...
 
nil set_enable_window_resizing (enable: boolean)
 Globally enables or disables user-driven window resizing by dragging borders. More...
 

Properties

lysa.Font default_font
 The default font loaded at manager creation, applied to new windows that do not specify their own. (read-only)
 
number default_font_scale
 The default font scale applied to new windows that do not specify their own.
 
lysa.float4 default_text_color
 The default text RGBA color applied to new windows that do not specify their own.
 
number aspect_ratio
 The aspect ratio of the rendering window this manager is attached to. (read-only)
 
number resize_delta
 Pixel distance from a window border within which a drag starts a resize operation (default 5.0). (read-only)
 

Member Function Documentation

Window create ( lysa.Rect  rect)

Creates and registers a new UI window with the given position and size.

Parameters
rectlysa.Rect
Returns
Window
Window add ( Window  window)

Registers an existing UI window with this manager so it receives update and render calls.

Parameters
windowWindow
Returns
Window
nil remove ( Window  window)

Unregisters and destroys the given UI window (effective at the start of the next frame).

Parameters
windowWindow
nil set_enable_window_resizing ( boolean  enable)

Globally enables or disables user-driven window resizing by dragging borders.

Parameters
enableboolean

Property Documentation

lysa.Font default_font

The default font loaded at manager creation, applied to new windows that do not specify their own. (read-only)

number default_font_scale

The default font scale applied to new windows that do not specify their own.

lysa.float4 default_text_color

The default text RGBA color applied to new windows that do not specify their own.

number aspect_ratio

The aspect ratio of the rendering window this manager is attached to. (read-only)

number resize_delta

Pixel distance from a window border within which a drag starts a resize operation (default 5.0). (read-only)