Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::WindowStyleMasks Struct Reference

A simple structure to encapsulate different native window style masks. More...

#include <NativeWindow.h>

Public Member Functions

 WindowStyleMasks ()=default
 Default constructor.
 
 WindowStyleMasks (const uint32_t platformAgnosticStyleMask, const uint32_t platformSpecificStyleMask=0)
 

Public Attributes

uint32_t m_platformAgnosticStyleMask = 0
 
uint32_t m_platformSpecificStyleMask = 0
 

Static Public Attributes

static constexpr uint32_t WINDOW_STYLE_BORDERED = 0x0001
 Platform agnostic window style bitmasks.
 
static constexpr uint32_t WINDOW_STYLE_RESIZEABLE = 0x0002
 Should the window be resizeable? (Implies WINDOW_STYLE_BORDERED)
 
static constexpr uint32_t WINDOW_STYLE_TITLED = 0x0004
 Should the window have a title bar? (Implies WINDOW_STYLE_BORDERED)
 
static constexpr uint32_t WINDOW_STYLE_TITLED_MENU = 0x0008
 Should the window have a title bar with a menu? (Implies WINDOW_STYLE_TITLED)
 
static constexpr uint32_t WINDOW_STYLE_CLOSABLE = 0x0010
 Should the window have a close button? (Implies WINDOW_STYLE_TITLED_MENU)
 
static constexpr uint32_t WINDOW_STYLE_MAXIMIZE = 0x0020
 Should the window have a maximize button? (Implies WINDOW_STYLE_TITLED_MENU)
 
static constexpr uint32_t WINDOW_STYLE_MINIMIZE = 0x0040
 Should the window have a minimize button? (Implies WINDOW_STYLE_TITLED_MENU)
 

Detailed Description

A simple structure to encapsulate different native window style masks.

Constructor & Destructor Documentation

◆ WindowStyleMasks()

AzFramework::WindowStyleMasks::WindowStyleMasks ( const uint32_t  platformAgnosticStyleMask,
const uint32_t  platformSpecificStyleMask = 0 
)
inline

Constructor (deliberately not explicit).

Parameters
[in]platformAgnosticStyleMaskBitmask of platform agnostic window style flags.
[in]platformSpecificStyleMaskBitmask of platform specific window style flags.

Member Data Documentation

◆ m_platformAgnosticStyleMask

uint32_t AzFramework::WindowStyleMasks::m_platformAgnosticStyleMask = 0

Bitmask of platform agnostic window style flags that will be translated to their equivalent platform specific window style flags (if it exists), and then combined with m_platformSpecificStyleMask before being applied.

◆ m_platformSpecificStyleMask

uint32_t AzFramework::WindowStyleMasks::m_platformSpecificStyleMask = 0

Bitmask of platform specific window style flags that will be combined with any flags from m_platformAgnosticStyleMask before being applied.

◆ WINDOW_STYLE_BORDERED

constexpr uint32_t AzFramework::WindowStyleMasks::WINDOW_STYLE_BORDERED = 0x0001
staticconstexpr

Platform agnostic window style bitmasks.

Should the window have a border?


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