Kanzi  3.9.8
Kanzi Engine C++ API
kanzi::win32::DefaultWin32WGLGraphicsOutputProperties Struct Reference

Structure that represents the default Win32 WGL graphics output properties. More...

#include <kanzi/core.ui/platform/graphics_output/win32_wgl/default_win32_wgl_graphics_output_properties.hpp>

Public Member Functions

 DefaultWin32WGLGraphicsOutputProperties ()=default
 Default constructor. More...
 
 DefaultWin32WGLGraphicsOutputProperties (const kanzi::SystemConfiguration &configuration)
 Constructor. More...
 

Public Attributes

optional< int > bitsAlpha
 Exact size of the alpha channel bits. If not specified, nullopt. More...
 
optional< int > bitsColorB
 Exact size of the blue color channel bits. If not specified, nullopt. More...
 
optional< int > bitsColorG
 Exact size of the green color channel bits. If not specified, nullopt. More...
 
optional< int > bitsColorR
 Exact size of the red color channel bits. If not specified, nullopt. More...
 
optional< int > bitsDepth
 Exact size of the depth channel bits. If not specified, nullopt. More...
 
optional< unsigned int > displayIndex
 Display index for the window. If not specified, nullopt. More...
 
optional< int > graphicsFormatID
 WGL graphics format ID. If not specified, nullopt. More...
 
SurfaceColorSpace surfaceColorSpace
 Surface color space mode. More...
 
string windowClassName
 Default window class name for the graphics output. More...
 
unsigned int windowOrder
 Window z order. More...
 
NativeWindowProperties windowProperties
 Default window properties for the graphics output. More...
 
windowing::Region windowRegion
 Window region. More...
 
WindowStyle windowStyle
 Default window style for the graphics output. More...
 
string windowTitle
 Default window title for the graphics output. More...
 

Detailed Description

Structure that represents the default Win32 WGL graphics output properties.

Since
Kanzi 3.9.7

Constructor & Destructor Documentation

kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::DefaultWin32WGLGraphicsOutputProperties ( )
explicitdefault

Default constructor.

kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::DefaultWin32WGLGraphicsOutputProperties ( const kanzi::SystemConfiguration configuration)
explicit

Constructor.

Parameters
configurationConfiguration parameters for the default Win32 WGL graphics output.

Member Data Documentation

windowing::Region kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::windowRegion

Window region.

unsigned int kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::windowOrder

Window z order.

NativeWindowProperties kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::windowProperties

Default window properties for the graphics output.

WindowStyle kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::windowStyle

Default window style for the graphics output.

string kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::windowTitle

Default window title for the graphics output.

string kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::windowClassName

Default window class name for the graphics output.

optional<int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::graphicsFormatID

WGL graphics format ID. If not specified, nullopt.

optional<unsigned int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::displayIndex

Display index for the window. If not specified, nullopt.

SurfaceColorSpace kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::surfaceColorSpace

Surface color space mode.

optional<int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::bitsColorR

Exact size of the red color channel bits. If not specified, nullopt.

optional<int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::bitsColorG

Exact size of the green color channel bits. If not specified, nullopt.

optional<int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::bitsColorB

Exact size of the blue color channel bits. If not specified, nullopt.

optional<int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::bitsAlpha

Exact size of the alpha channel bits. If not specified, nullopt.

optional<int> kanzi::win32::DefaultWin32WGLGraphicsOutputProperties::bitsDepth

Exact size of the depth channel bits. If not specified, nullopt.


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