Overlay Component Role Parameters

Detailed Description

Collaboration diagram for Overlay Component Role Parameters:

Variables
constexpr const char *	makVre::OverlayComponentConfig::channelName = "channelName"
constexpr const char *	makVre::OverlayComponentConfig::elements = "elements"
constexpr const char *	makVre::OverlayComponentConfig::windowName = "windowName"

Variable Documentation

channelName

const char* makVre::OverlayComponentConfig::channelName = "channelName"

constexpr

Parameter Name	channelName
Parameter Description	Name of the render channel where the overlay should be displayed.
Parameter Type	string
Parameter Default	"Channel 1"
Required?	No

Example Role Config Usage:

["overlayComponent"] = { 
   ... 
   channelName = "Channel 1"; 
   ... 
};

elements

const char* makVre::OverlayComponentConfig::elements = "elements"

constexpr

Parameter Name	elements
Parameter Description	Table defining the HUD elements to be created and displayed in the overlay.
Parameter Type	table
Parameter Default	""
Required?	No

Example Role Config Usage:

["overlayComponent"] = { 
   ... 
   elements = ""; 
   ... 
};

windowName

const char* makVre::OverlayComponentConfig::windowName = "windowName"

constexpr

Parameter Name	windowName
Parameter Description	Name of the window where the overlay should be rendered.
Parameter Type	string
Parameter Default	"Window 1"
Required?	No

Example Role Config Usage:

["overlayComponent"] = { 
   ... 
   windowName = "Window 1"; 
   ... 
};