public

Description

The Property struct is used to parameterize the creation of a window.

Public Types

   
   
enum RenderingAPI {GL_ES_1, GL_ES_2, GL_ES_3, GL}
The title string commonly displayed in the title bar of the window.

Public Attributes

   
   
bool borderless
   
bool debug
The window should not have a border.
   
bool compatibilityProfile
Create a rendering context with debugging support.
   
bool fullscreen
Create a rendering context with a compatibility profile.
   
bool multisampled
Create a fullscreen window.
   
bool positioned
Create a rendering context with a multisample buffer.
   
bool resizable
The window’s location is determined by the given posX,posY value.
   
bool shareContext
The window should be resizable.
   
uint32_t clientAreaWidth
Share the window’s gl context if there is already one available.
   
uint32_t clientAreaHeight
   
int32_t posX
The size of the client area of the window.
   
int32_t posY
   
uint32_t multisamples
(if positioned == true) The position of the upper left corner of the window
   
uint32_t contextVersionMajor
(if multisampled == true) Number of samples used for multisampling; default is 4.
   
uint32_t contextVersionMinor
The major rendering API version that the created context must be compatible with.
   
std::string title
The minor rendering API version that the created context must be compatible with.
   
enum Util::UI::Window::Properties::RenderingAPI renderingAPI

Public Functions

   
   
  Properties()

Documentation

enum
Util::UI::Window::Properties::RenderingAPI

public
 
 
enum RenderingAPI
Enumerator   Description
Enumerator   Description
GL_ES_1   OpenGL ES 1.
GL_ES_2   OpenGL ES 2.
GL_ES_3   OpenGL ES 3.
GL   OpenGL (all versions)

The title string commonly displayed in the title bar of the window.

Defined in Util/UI/Window.h:50


variable
Util::UI::Window::Properties::borderless

public
 
 
bool borderless

Defined in Util/UI/Window.h:35


variable
Util::UI::Window::Properties::debug

public
 
 
bool debug

The window should not have a border.

Defined in Util/UI/Window.h:36


variable
Util::UI::Window::Properties::compatibilityProfile

public
 
 
bool compatibilityProfile

Create a rendering context with debugging support.

Defined in Util/UI/Window.h:37


variable
Util::UI::Window::Properties::fullscreen

public
 
 
bool fullscreen

Create a rendering context with a compatibility profile.

Defined in Util/UI/Window.h:38


variable
Util::UI::Window::Properties::multisampled

public
 
 
bool multisampled

Create a fullscreen window.

Defined in Util/UI/Window.h:39


variable
Util::UI::Window::Properties::positioned

public
 
 
bool positioned

Create a rendering context with a multisample buffer.

Defined in Util/UI/Window.h:40


variable
Util::UI::Window::Properties::resizable

public
 
 
bool resizable

The window’s location is determined by the given posX,posY value.

Defined in Util/UI/Window.h:41


variable
Util::UI::Window::Properties::shareContext

public
 
 
bool shareContext

The window should be resizable.

Defined in Util/UI/Window.h:42


variable
Util::UI::Window::Properties::clientAreaWidth

public
 
 
uint32_t clientAreaWidth

Share the window’s gl context if there is already one available.

Defined in Util/UI/Window.h:43


variable
Util::UI::Window::Properties::clientAreaHeight

public
 
 
uint32_t clientAreaHeight

Defined in Util/UI/Window.h:43


variable
Util::UI::Window::Properties::posX

public
 
 
int32_t posX

The size of the client area of the window.

Defined in Util/UI/Window.h:44


variable
Util::UI::Window::Properties::posY

public
 
 
int32_t posY

Defined in Util/UI/Window.h:44


variable
Util::UI::Window::Properties::multisamples

public
 
 
uint32_t multisamples

(if positioned == true) The position of the upper left corner of the window

Defined in Util/UI/Window.h:45


variable
Util::UI::Window::Properties::contextVersionMajor

public
 
 
uint32_t contextVersionMajor

(if multisampled == true) Number of samples used for multisampling; default is 4.

Defined in Util/UI/Window.h:46


variable
Util::UI::Window::Properties::contextVersionMinor

public
 
 
uint32_t contextVersionMinor

The major rendering API version that the created context must be compatible with.

Defined in Util/UI/Window.h:47


variable
Util::UI::Window::Properties::title

public
 
 
std::string title

The minor rendering API version that the created context must be compatible with.

Defined in Util/UI/Window.h:49


variable
Util::UI::Window::Properties::renderingAPI

public
 
 
enum Util::UI::Window::Properties::RenderingAPI renderingAPI

Defined in Util/UI/Window.h:55


function
Util::UI::Window::Properties::Properties

public inline
   
   
Properties( )

Defined in Util/UI/Window.h:56