Class ScreenMetadata

Defines properties and message types for Screen.

Inherits properties and message types from Node2DMetadata.

Property Types

See also PropertyType
ScreenMetadata.MetricsTypeProperty

Defines the type of the coordinate system for the window metrics.

ScreenMetadata.WidthProperty

When Metrics Type is set to:

  • Relative, a relative width of the window in the range [0,1]
  • Absolute, the width of the window in pixels.
ScreenMetadata.HeightProperty

When Metrics Type is set to:

  • Relative, a relative height of the window in the range [0,1]
  • Absolute, the height of the window in pixels.
ScreenMetadata.OrientationProperty

Sets the orientation of the application window.

ScreenMetadata.HostNameProperty

Contains the name of the host the node originates from.

ScreenMetadata.ClearColorProperty

If screen has a clear color, screen will be cleared with the specified color before all other rendering. Depth will be cleared to 1.0f and stencil will be cleared to 0.

Message Types

See also MessageType
ScreenMetadata.ActivateThemeMessage

Activates a specified theme from a theme group.

Arguments: ScreenMetadata.ActivateThemeMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

ScreenMetadata.ActivateThemeMessageArguments

ThemeProperty

Theme to activate

Example
local value = arguments:getThemeProperty()
arguments:setThemeProperty(value)