Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::NativeWindowProperties Struct Reference

Properties for a window. More...

#include <kanzi/core.ui/platform/windowing/common/window_properties.hpp>

Public Types

enum  WindowPositionSpecifiers { WindowPositionUnspecified }
 Special values for NativeWindowProperties::x, NativeWindowProperties::y and NativeWindowProperties::order. More...
 
enum  WindowSizeSpecifiers { WindowSizeUnspecified, WindowSizeFullscreen }
 Special values for NativeWindowProperties::width and NativeWindowProperties::height. More...
 

Public Member Functions

void log () const
 Outputs the window properties to the log. More...
 
 NativeWindowProperties ()
 Constructor. More...
 

Public Attributes

unsigned int bufferCount
 Number of window buffers to be requested from windowing system at native window initialization. More...
 
size_t defaultDisplayIndex
 Index of default display for full-screen windows. More...
 
kanzi::optional< kanzi::string > groupName
 Window group name. More...
 
unsigned int height
 Height of the window (in pixels). More...
 
bool initializePlatform
 Controls whether the application should try to to do platform-specific initializations like starting graphics-driver or displays. Only applicable on some platforms. More...
 
int order
 Z order of the window (target platform specific value). Use WindowPositionUnspecified to let the system choose the position. More...
 
enum KzsWindowStyle style
 Style properties of the window. More...
 
SystemConfiguration systemConfiguration
 Platform specific arguments. More...
 
int usageFlags
 Platform specific usage flags. More...
 
unsigned int width
 Width of the window (in pixels). More...
 
int x
 X position of the window (in pixels). Use WindowPositionUnspecified to let the system choose the position. More...
 
int y
 Y position of the window (in pixels). Use WindowPositionUnspecified to let the system choose the position. More...
 

Detailed Description

Properties for a window.

Position is defined as the distance from the top-left corner of the desktop to the top-left corner of the window, measured towards the center of the desktop. If style is set to KZS_WINDOW_STYLE_FULL_SCREEN, the window position is ignored and the primary screen resolution is changed to match the requested window size. If both width and height is set to zero, no change of resolution is attempted.

Member Enumeration Documentation

Special values for NativeWindowProperties::x, NativeWindowProperties::y and NativeWindowProperties::order.

Enumerator
WindowPositionUnspecified 

Lets system specify position for a window.

Special values for NativeWindowProperties::width and NativeWindowProperties::height.

Enumerator
WindowSizeUnspecified 

Lets system specify size for a window.

WindowSizeFullscreen 

Automatically sizes the window to fill visible screen.

Constructor & Destructor Documentation

kanzi::NativeWindowProperties::NativeWindowProperties ( )
explicit

Constructor.

Member Function Documentation

void kanzi::NativeWindowProperties::log ( ) const

Outputs the window properties to the log.

Member Data Documentation

int kanzi::NativeWindowProperties::x

X position of the window (in pixels). Use WindowPositionUnspecified to let the system choose the position.

int kanzi::NativeWindowProperties::y

Y position of the window (in pixels). Use WindowPositionUnspecified to let the system choose the position.

int kanzi::NativeWindowProperties::order

Z order of the window (target platform specific value). Use WindowPositionUnspecified to let the system choose the position.

unsigned int kanzi::NativeWindowProperties::width

Width of the window (in pixels).

Use WindowSizeFullscreen to use the maximum width available on the primary screen. Use WindowSizeUnspecified to let the system choose the size.

unsigned int kanzi::NativeWindowProperties::height

Height of the window (in pixels).

Use WindowSizeFullscreen to use the maximum height available on the primary screen. Use WindowSizeUnspecified to let the system choose the size.

unsigned int kanzi::NativeWindowProperties::bufferCount

Number of window buffers to be requested from windowing system at native window initialization.

Use 0 to let the system choose the target platform specific default value.

int kanzi::NativeWindowProperties::usageFlags

Platform specific usage flags.

SystemConfiguration kanzi::NativeWindowProperties::systemConfiguration

Platform specific arguments.

enum KzsWindowStyle kanzi::NativeWindowProperties::style

Style properties of the window.

size_t kanzi::NativeWindowProperties::defaultDisplayIndex

Index of default display for full-screen windows.

kanzi::optional<kanzi::string> kanzi::NativeWindowProperties::groupName

Window group name.

Not all windowing systems use the group name.

bool kanzi::NativeWindowProperties::initializePlatform

Controls whether the application should try to to do platform-specific initializations like starting graphics-driver or displays. Only applicable on some platforms.


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