Overload  1.1
Game engine with editor
Public Attributes | Static Public Attributes | List of all members
OvWindowing::Settings::WindowSettings Struct Reference

#include <WindowSettings.h>

Public Attributes

std::string title
 
uint16_t width
 
uint16_t height
 
int16_t minimumWidth = DontCare
 
int16_t minimumHeight = DontCare
 
int16_t maximumWidth = DontCare
 
int16_t maximumHeight = DontCare
 
bool fullscreen = false
 
bool decorated = true
 
bool resizable = true
 
bool focused = true
 
bool maximized = false
 
bool floating = false
 
bool visible = true
 
bool autoIconify = true
 
int32_t refreshRate = WindowSettings::DontCare
 
Cursor::ECursorMode cursorMode = Cursor::ECursorMode::NORMAL
 
Cursor::ECursorShape cursorShape = Cursor::ECursorShape::ARROW
 
uint32_t samples = 4
 

Static Public Attributes

static const int32_t DontCare = -1
 

Detailed Description

Contains window settings

Member Data Documentation

◆ autoIconify

bool OvWindowing::Settings::WindowSettings::autoIconify = true

Specifies whether the full screen window will automatically iconify and restore the previous video mode on input focus loss. This hint is ignored for windowed mode windows

◆ cursorMode

Cursor::ECursorMode OvWindowing::Settings::WindowSettings::cursorMode = Cursor::ECursorMode::NORMAL

Specifies the default cursor mode of the window

◆ cursorShape

Cursor::ECursorShape OvWindowing::Settings::WindowSettings::cursorShape = Cursor::ECursorShape::ARROW

Specifies the default cursor shape of the window

◆ decorated

bool OvWindowing::Settings::WindowSettings::decorated = true

Specifies whether the windowed mode window will have window decorations such as a border, a close widget, etc. An undecorated window may still allow the user to generate close events on some platforms. This hint is ignored for full screen windows.

◆ DontCare

const int32_t OvWindowing::Settings::WindowSettings::DontCare = -1
static

A simple constant used to ignore a value setting (Let the program decide for you)

Note
You can you WindowSettings::DontCare only where it is indicated

◆ floating

bool OvWindowing::Settings::WindowSettings::floating = false

Specifies whether the windowed mode window will be floating above other regular windows, also called topmost or always-on-top. This is intended primarily for debugging purposes and cannot be used to implement proper full screen windows. This hint is ignored for full screen windows.

◆ focused

bool OvWindowing::Settings::WindowSettings::focused = true

Specifies whether the windowed mode window will be given input focus when created. This hint is ignored for full screen and initially hidden windows.

◆ fullscreen

bool OvWindowing::Settings::WindowSettings::fullscreen = false

Specifies if the window is by default in fullscreen or windowed mode

◆ height

uint16_t OvWindowing::Settings::WindowSettings::height

Height in pixels of the window

◆ maximized

bool OvWindowing::Settings::WindowSettings::maximized = false

Specifies whether the windowed mode window will be maximized when created. This hint is ignored for full screen windows.

◆ maximumHeight

int16_t OvWindowing::Settings::WindowSettings::maximumHeight = DontCare

Maximum height of the window. Use WindowSettings::DontCare to disable limit

◆ maximumWidth

int16_t OvWindowing::Settings::WindowSettings::maximumWidth = DontCare

Maximum width of the window. Use WindowSettings::DontCare to disable limit

◆ minimumHeight

int16_t OvWindowing::Settings::WindowSettings::minimumHeight = DontCare

Minimum height of the window. Use WindowSettings::DontCare to disable limit

◆ minimumWidth

int16_t OvWindowing::Settings::WindowSettings::minimumWidth = DontCare

Minimum width of the window. Use WindowSettings::DontCare to disable limit

◆ refreshRate

int32_t OvWindowing::Settings::WindowSettings::refreshRate = WindowSettings::DontCare

Specifies the desired refresh rate for full screen windows. If set to WindowSettings::DontCare, the highest available refresh rate will be used. This hint is ignored for windowed mode windows.

◆ resizable

bool OvWindowing::Settings::WindowSettings::resizable = true

specifies whether the windowed mode window will be resizable by the user. The window will still be resizable using the "SetSize(uint16_t, uint16_t)" method of the "Window" class. This hint is ignored for full screen windows

◆ samples

uint32_t OvWindowing::Settings::WindowSettings::samples = 4

Defines the number of samples to use (For anti-aliasing)

◆ title

std::string OvWindowing::Settings::WindowSettings::title

Title of the window (Displayed in the title bar)

◆ visible

bool OvWindowing::Settings::WindowSettings::visible = true

Specifies whether the windowed mode window will be initially visible. This hint is ignored for full screen windows.

◆ width

uint16_t OvWindowing::Settings::WindowSettings::width

Width in pixels of the window


The documentation for this struct was generated from the following file: