EngineWindow Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Then, by using methods of the EngineWindow class, you can specify the window appearance (for example, set a title, an icon, change opacity, add borders, and so on), and properties (whether the window can be nested, or whether it can become a group), define its style (system or engine), change the window state (whether it is shown/hidden, minimized/maximized, focused, etc.), manage window intersections and events.

Setting Up Position and Size#

In UNIGINE, the window size and position coordinates are measured in both units and pixels:

The size and position in units don't depend on the DPI scale and always remain the same. You can change the window and client area size via setSize and setClientSize , adjust the minimum and maximum size and set the window and client position via the corresponding methods. All of them work with units.
The size and position in pixels are calculated by multiplying the size in units by the current DPI scale. You can get it using one of the RenderSize-related methods/properties (e.g., getRenderSize , and so on). When the DPI scale is 100%, 1 unit corresponds to 1 pixel.

Notice
DPI scaling is applied only when the auto_dpi_scalingflag is enabled. You can check the current flag value via the console or by using WindowManager.isAutoDpiScaling .
To determine how the OS handles the DPI scale, specify the DPI awareness mode.

You should consider this information when resizing textures, calculating mouse intersections, etc. The window size and position should be set individually, depending on the situation.

Notice

If necessary, you can convert the size and position coordinates from units to pixels and visa versa:

Use one of the toRenderSize or toUnitSize to convert the size.
Use globalToLocalUnitPosition to transform the coordinates in pixels into units or localUnitToGlobalPosition to do the opposite.

In the following example, the positions of the window and client area (in units) change to the mouse cursor when you press the P or C respectively:

Adjusting Visual Representation#

The window visual representation includes all available window parameters such as title and title bar, icon, borders, opacity, and window style (the engine or system one).

Here are some window examples:

A system-style window	A window (either system or engine style), borders and title bar disabled
An engine-style window, borders disabled	An engine-style window, borders enabled

The system and engine style windows have the same component layout except the sizing border: in the engine style, it is in the visual part of the window.

The ability to customize the window style makes it possible to create a standard set of window settings for different systems and frameworks.

Setting Up Order#

In the following example, the order of the window under the cursor changes when you press the specific button: T to make the window appear on top of all other windows, A to always render the window above the other windows.

Changing Behavior#

With the set of behavior-related functions, you can do the following:

Force the engine to stop operating while the engine window is opened.
Ignore or allow using the OS methods for windows closing.
Specify whether the window is resizable.
Specify the sizing border size.
Control rendering of the engine window - show, hide, focus, minimize, maximize, restore, or close.

Working with Modal Windows#

The following example demonstrates how to create modal windows and add modal children to the main window. Additionally, the main window includes a message that informs the user whether they can close the window or not.

Methods:

Name	Description View: Sort by:
getGui	Returns the current parent Gui for a window.
getDisplayIndex	Returns the current number of the display, on which the window is currently displayed.
isNested	Returns the current value indicating if this is a nested window or group of windows.
isSeparate	Returns the current value indicating if this is a separate window or group of windows.
getSelfGui	Returns the current Gui instance for a window.
setPosition	Setter and Getter for the position of the top left corner of the window in the screen coordinates.
getPosition
setClientPosition	Setter and Getter for the position of the top left corner of the client (the window content area without the top bar and borders) in the screen coordinates.
getClientPosition
getClientLocalPosition	Returns the current position of the top left corner of the client (the window content area without the top bar and borders) relative to the window position.
setSize	Setter and Getter for the engine window size in units (including the sizing border).
getSize
setClientSize	Setter and Getter for the size of the window client (content) area in units.
getClientSize
setMinSize	Setter and Getter for the minimum possible window size in units when resizing the window.
getMinSize
setMaxSize	Setter and Getter for the maximum possible window size in units when resizing the window.
getMaxSize
setTitle	Setter and Getter for the text of the title for the window.
getTitle	Setter and Getter for the text of the title for the window.
setOpacity	Setter and Getter for the opacity for the window.
getOpacity	Setter and Getter for the opacity for the window.
setBordersEnabled	Setter and Getter for the value indicating if the borders are enabled for the engine window.
isBordersEnabled
setBorderSize	Setter and Getter for the engine window border size.
getBorderSize	Setter and Getter for the engine window border size.
setResizable	Setter and Getter for the value indicating if the engine window is resizable by the mouse.
isResizable
isShown	Returns the current value indicating if the engine window is rendered.
isHidden	Returns the current value indicating if the engine window isn't rendered.
isFocused	Returns the current value indicating if the engine window is in focus.
isMinimized	Returns the current value indicating if the engine window is minimized.
isMaximized	Returns the current value indicating if the engine window is maximized.
getOrder	Returns the current order of the window.
getParentGroup	Returns the current group into which the current window is nested, or NULL if it is a separate window.
getGlobalParentGroup	Returns the current top group of the hierarchy into which the current window is nested, or NULL if it is a separate window.
getNumDroppedItems	Returns the current total number of files and/or folders dropped to the window.
getNumModalWindows	Returns the current total number of modal windows for this window.
getModalParent	Returns the current modal parent of the window.
isModalParent	Returns the current value indicating if the window is parent for any modal window.
isModal	Returns the current value indicating if the window is modal.
setIgnoreSystemClose	Setter and Getter for the value indicating if closing the window using the OS methods is ignored (ALT+F4 or cross in the top-right corner of the window).
isIgnoreSystemClose
setHoldEngine	Setter and Getter for the value indicating if the engine operation can't be stopped while this window is open.
isHoldEngine
getID	Returns the current ID of the engine window, which is unchanged during the whole lifecycle of the window.
setAlwaysOnTop	Setter and Getter for the value indicating if the window is always rendered above the other windows.
isAlwaysOnTop
isHiddenByTab	Returns the current value indicating if the window is overlapped by any other tab (either by switching to another tab or resizing this window to have zero client area).
setCanCreateGroup	Setter and Getter for the value indicating if the engine window can become a group.
isCanCreateGroup
setCanBeNested	Setter and Getter for the value indicating if the engine window can be used as a nested window.
isCanBeNested
isSystemFocused	Returns the current value indicating if the engine window is currently in focus.
setSizingBorderSize	Setter and Getter for the size of the border in the widget that is manipulated to resize the window.
getSizingBorderSize
setEngineStyle	Setter and Getter for the value indicating if the engine style or the default system style is set for the engine window.
isEngineStyle
setSystemStyle	Setter and Getter for the value indicating if the default system style or the engine style is set for the engine window.
isSystemStyle
setTitleBarHeight	Setter and Getter for the height of the window title bar.
getTitleBarHeight	Setter and Getter for the height of the window title bar.
setTitleBarEnabled	Setter and Getter for the value indicating if the title bar is enabled for the engine window.
isTitleBarEnabled
getTypeName	Returns the current name of the engine window type as a string.
getType	Returns the current type of the engine window.
getDpiScale	Returns the current DPI scale applied to the elements inside the window.
getDpi	Returns the current DPI level for the window.
getMaxRenderSize	Returns the current maximum window size in pixels.
getMinRenderSize	Returns the current minimum window size in pixels.
getClientRenderSize	Returns the current client area size in pixels.
getRenderSize	Returns the current engine window frame size in pixels.
getEventUnstack	The event triggered when when the window is unstacked.
getEventStack	The event triggered when the window is stacked.
getEventUnstackMove	The event triggered when the window is unstacked and moved.
getEventItemDrop	The event triggered when an item is dropped to the window.
getEventClose	The event triggered when the window is closed.
getEventRestored	The event triggered when the window is restored.
getEventMaximized	The event triggered when the window is maximized.
getEventMinimized	The event triggered when the window is minimized.
getEventHidden	The event triggered when the window is hidden.
getEventShown	The event triggered when the window is shown.
getEventMouseLeave	The event triggered when the mouse leaves the window area.
getEventMouseEnter	The event triggered when the mouse enters the window area.
getEventUnfocused	The event triggered when the window loses the focus.
getEventFocused	The event triggered when the window gains the focus.
getEventResized	The event triggered when the window is resized.
getEventMoved	The event triggered when the window is moved.
getEventFuncSwap	The event triggered before calling the window swap.
getEventFuncEndRender	The event triggered after the window rendering has ended.
getEventFuncEndRenderGui	The event triggered after the GUI rendering has ended.
getEventFuncBeginRenderGui	The event triggered when the GUI rendering has begun.
getEventFuncRender	The event triggered after the window rendering function.
getEventFuncBeginRender	The event triggered when the window rendering has begun.
getEventFuncUpdate	The event triggered after the window update.
getEventWindowEvent	The event triggered on the window event.
moveToCenter	Positions the window so that the client center coincides with the center of the current display.
setMinAndMaxSize	Sets the minimum and maximum possible window size when resizing the window.
setIcon	Sets the icon for the window.
getIcon	Returns the icon for the engine window.
show	Enables rendering of the engine window.
hide	Disables rendering of the engine window.
setFocus	Sets the focus to the window.
setSystemFocus	Sets the focus to the engine window.
minimize	Minimizes the engine window to an iconic representation.
maximize	Makes the engine window as large as possible.
restore	Restores the size and position of the minimized or maximized engine window via the system proxy.
getHitTestResult	Returns a value indicating in which area of the engine window the mouse is located.
getHitTestResultName	Returns the string representation of the hit test result value.
toTop	Makes the window appear on top of all other windows.
isGlobalChildOf	Returns the value specifying if the current window is a part of a hierarchy of the specified window.
updateGuiHierarchy	Updates the hierarchy for all widgets — the widgets are arranged, expanded to the required sizes and then their positions are updated.
getDroppedItem	Returns the absolute path to the file or folder dropped to the window.
screenshot	Creates a screenshot after the rendering stage is completed.
setModal	Sets the current window modal to the specified parent window.
addModalWindow	Adds the argument window as modal to the current window.
removeModalWindow	Removes the argument modal window from this window.
getModalWindow	Returns the modal window for this window by its index.
unstack	Removes the current window from a parent group.
close	Deletes the window if this window is not a modal parent or a member of a fixed group.
getIntersection	Returns the value indicating if the mouse is hovering over the window.
getClientIntersection
getClient9Area	Returns the area over which the mouse hovers, one of the nine areas into which the window is segmented.
get9AreaName	Returns the name of the screen segment as a string.
globalToLocalUnitPosition	Transforms the global screen coordinates in pixels into units relative to the window client area.
localUnitToGlobalPosition	Transforms the position in units relative to the window client area into the global screen coordinates in pixels.

EngineWindow Class

Members

Gui getGui() const#

Returns the current parent Gui for a window. If the window is nested, this Gui differs from SelfGui.

Return value

Current Gui instance.

int getDisplayIndex() const#

Returns the current number of the display, on which the window is currently displayed. For separate windows, this index is requested from the system proxy; for nested windows, the index is provided based on the location of the client center point.

Return value

Current number of the display, on which the window is currently displayed.

int isNested() const#

Returns the current value indicating if this is a nested window or group of windows.

Return value

Current this is a nested window or group of windows

int isSeparate() const#

Returns the current value indicating if this is a separate window or group of windows.

Return value

Current this is a separate window or group of windows

Gui getSelfGui() const#

Returns the current Gui instance for a window. This Gui remains unchanged during the whole lifecycle of the window.

Return value

Current Gui instance.

void setPosition ( ivec2 position ) #

Sets a new position of the top left corner of the window in the screen coordinates. In case of several displays, the position is relative to the main display.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed.

Arguments

ivec2 position - The window screen position (coordinates of the top left corner).

ivec2 getPosition() const#

Returns the current position of the top left corner of the window in the screen coordinates. In case of several displays, the position is relative to the main display.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed.

Return value

Current window screen position (coordinates of the top left corner).

void setClientPosition ( ivec2 position ) #

Sets a new position of the top left corner of the client (the window content area without the top bar and borders) in the screen coordinates. In case of several displays, the position is relative to the main display.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed.

Arguments

ivec2 position - The screen position of the client (coordinates of the top left corner).

ivec2 getClientPosition() const#

Returns the current position of the top left corner of the client (the window content area without the top bar and borders) in the screen coordinates. In case of several displays, the position is relative to the main display.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed.

Return value

Current screen position of the client (coordinates of the top left corner).

ivec2 getClientLocalPosition() const#

Returns the current position of the top left corner of the client (the window content area without the top bar and borders) relative to the window position.

Return value

Current screen position of the client (coordinates of the top left corner) relative to the window position.

void setSize ( ivec2 size ) #

Sets a new engine window size in units (including the sizing border).

NoticeThis method is for a separate or parent window, using this method for a nested window is not allowed (when requesting the current value, it will return the value of the global parent group).

Arguments

ivec2 size - The engine window size in units (including the sizing border).

ivec2 getSize() const#

Returns the current engine window size in units (including the sizing border).

NoticeThis method is for a separate or parent window, using this method for a nested window is not allowed (when requesting the current value, it will return the value of the global parent group).

Return value

Current engine window size in units (including the sizing border).

void setClientSize ( ivec2 size ) #

Sets a new size of the window client (content) area in units.

Arguments

ivec2 size - The

ivec2 getClientSize() const#

Returns the current size of the window client (content) area in units.

Return value

Current

void setMinSize ( ivec2 size ) #

Sets a new minimum possible window size in units when resizing the window. If the value is more than the current maximum size, use the setMinAndMaxSize() method, to change both values at once. Otherwise the value will be clamped to the current maximum size.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return zero values).

Arguments

ivec2 size - The minimum possible size of the window.

ivec2 getMinSize() const#

Returns the current minimum possible window size in units when resizing the window. If the value is more than the current maximum size, use the setMinAndMaxSize() method, to change both values at once. Otherwise the value will be clamped to the current maximum size.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return zero values).

Return value

Current minimum possible size of the window.

void setMaxSize ( ivec2 size ) #

Sets a new maximum possible window size in units when resizing the window. If the value is less than the current minimum size, use the setMinAndMaxSize() method, to change both values at once. Otherwise the value will be clamped to the current minimum size.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed.

Arguments

ivec2 size - The maximum possible size of the window.

ivec2 getMaxSize() const#

Returns the current maximum possible window size in units when resizing the window. If the value is less than the current minimum size, use the setMinAndMaxSize() method, to change both values at once. Otherwise the value will be clamped to the current minimum size.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed.

Return value

Current maximum possible size of the window.

void setTitle ( string title ) #

Sets a new text of the title for the window. For a separate window, the title is set via system proxy in the title bar only; for a nested window, it is also set in the tab of the parent group.

Arguments

string title - The title of the window.

const char * getTitle() const#

Returns the current text of the title for the window. For a separate window, the title is set via system proxy in the title bar only; for a nested window, it is also set in the tab of the parent group.

Return value

Current title of the window.

void setOpacity ( float opacity ) #

Sets a new opacity for the window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will always return 1.0f).

Arguments

float opacity - The opacity for the window.

float getOpacity() const#

Returns the current opacity for the window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will always return 1.0f).

Return value

Current opacity for the window.

void setBordersEnabled ( int enabled ) #

Sets a new value indicating if the borders are enabled for the engine window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return false).

Arguments

int enabled - The borders for the window

int isBordersEnabled() const#

Returns the current value indicating if the borders are enabled for the engine window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return false).

Return value

Current borders for the window

void setBorderSize ( int size ) #

Sets a new engine window border size.

Notice

This value is applied to the windows in the engine style only. For system-style windows system settings are applied.
This method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return 0).

Arguments

int size - The engine window border size.

int getBorderSize() const#

Returns the current engine window border size.

Notice

This value is applied to the windows in the engine style only. For system-style windows system settings are applied.
This method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return 0).

Return value

Current engine window border size.

void setResizable ( int resizable ) #

Sets a new value indicating if the engine window is resizable by the mouse.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return false).

Arguments

int resizable - The the option of making the engine window resizable by the mouse

int isResizable() const#

Returns the current value indicating if the engine window is resizable by the mouse.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return false).

Return value

Current the option of making the engine window resizable by the mouse

int isShown() const#

Returns the current value indicating if the engine window is rendered.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

Current the engine window is rendered

int isHidden() const#

Returns the current value indicating if the engine window isn't rendered.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

Current the engine window isn't rendered

int isFocused() const#

Returns the current value indicating if the engine window is in focus.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

Current the engine window is in focus

int isMinimized() const#

Returns the current value indicating if the engine window is minimized.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

Current the engine window is minimized

int isMaximized() const#

Returns the current value indicating if the engine window is maximized.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

Current the engine window is maximized

int getOrder() const#

Returns the current order of the window. This value allows comparing which window is closer to the viewer (a relatively smaller value).

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

Current order of the window.

EngineWindowGroup getParentGroup() const#

Returns the current group into which the current window is nested, or NULL if it is a separate window.

Return value

Current group into which the current window is nested, or NULL if it is a separate window.

EngineWindowGroup getGlobalParentGroup() const#

Returns the current top group of the hierarchy into which the current window is nested, or NULL if it is a separate window.

Return value

Current top group of the hierarchy into which the current window is nested, or NULL if it is a separate window.

int getNumDroppedItems() const#

Returns the current total number of files and/or folders dropped to the window.

Return value

Current number of dropped files and/or folders.

int getNumModalWindows() const#

Returns the current total number of modal windows for this window. The concept of modal assumes that if a window has modal children, it cannot be closed. Any other interaction with a parent window is possible.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return 0.

Return value

Current total number of modal windows.

getModalParent() const#

Returns the current modal parent of the window. The concept of modal assumes that if a window has modal children, it cannot be closed. Any other interaction with a parent window is possible.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return nullptr.

Return value

Current modal parent of the window.

bool isModalParent() const#

Returns the current value indicating if the window is parent for any modal window. The concept of modal assumes that if a window has modal children, it cannot be closed. Any other interaction with a parent window is possible.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return false.

Return value

true if the window is parent for any modal window; otherwise false.

bool isModal() const#

Returns the current value indicating if the window is modal. The concept of modal assumes that if a window has modal children, it cannot be closed. Any other interaction with a parent window is possible.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return false.

Return value

true if the window is modal; otherwise false.

void setIgnoreSystemClose ( bool close ) #

Sets a new value indicating if closing the window using the OS methods is ignored (ALT+F4 or cross in the top-right corner of the window).

Arguments

bool close - Set true to enable ignoring OS methods for closing the window; false - to disable it.

bool isIgnoreSystemClose() const#

Returns the current value indicating if closing the window using the OS methods is ignored (ALT+F4 or cross in the top-right corner of the window).

Return value

true if ignoring OS methods for closing the window is enabled; otherwise false.

void setHoldEngine ( bool engine ) #

Sets a new value indicating if the engine operation can't be stopped while this window is open.

Arguments

bool engine - Set true to enable the engine can't stop operating while this window is open; false - to disable it.

bool isHoldEngine() const#

Returns the current value indicating if the engine operation can't be stopped while this window is open.

Return value

true if the engine can't stop operating while this window is open; otherwise false.

getID() const#

Returns the current ID of the engine window, which is unchanged during the whole lifecycle of the window.

Return value

Current ID of the engine window, if the window is external.

void setAlwaysOnTop ( bool top ) #

Sets a new value indicating if the window is always rendered above the other windows.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return the value of the global parent group).

Arguments

bool top - Set true to enable the window is always on top; false - to disable it.

bool isAlwaysOnTop() const#

Returns the current value indicating if the window is always rendered above the other windows.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return the value of the global parent group).

Return value

true if the window is always on top; otherwise false.

bool isHiddenByTab() const#

Returns the current value indicating if the window is overlapped by any other tab (either by switching to another tab or resizing this window to have zero client area).

Return value

true if the window is overlapped by any other tab; otherwise false.

void setCanCreateGroup ( bool group ) #

Sets a new value indicating if the engine window can become a group.

Arguments

bool group - Set true to enable usage of the engine window as a group; false - to disable it.

bool isCanCreateGroup() const#

Returns the current value indicating if the engine window can become a group.

Return value

true if usage of the engine window as a group is enabled; otherwise false.

void setCanBeNested ( bool nested ) #

Sets a new value indicating if the engine window can be used as a nested window.

Arguments

bool nested - Set true to enable usage of the engine window as a nested window; false - to disable it.

bool isCanBeNested() const#

Returns the current value indicating if the engine window can be used as a nested window.

Return value

true if usage of the engine window as a nested window is enabled; otherwise false.

bool isSystemFocused() const#

Returns the current value indicating if the engine window is currently in focus.

NoticeThis method should be applied to a separate or parent window, for a nested window it will return the value of the global parent group.

Return value

true if the engine window is in focus; otherwise false.

void setSizingBorderSize ( int size ) #

Sets a new size of the border in the widget that is manipulated to resize the window.

Notice
						This method should not be applied to a system-style window with enabled borders, as the system settings cannot be changed (for an unmodified system-style window (i.e. with the enabled border size), the system value is applied).
This method should not be applied to nested windows (it will return 0).

					

Arguments

int size - The size of the border in the widget that is manipulated to resize the window, in pixels.

int getSizingBorderSize() const#

Returns the current size of the border in the widget that is manipulated to resize the window.

Notice
						This method should not be applied to a system-style window with enabled borders, as the system settings cannot be changed (for an unmodified system-style window (i.e. with the enabled border size), the system value is applied).
This method should not be applied to nested windows (it will return 0).

					

Return value

Current size of the border in the widget that is manipulated to resize the window, in pixels.

void setEngineStyle ( bool style ) #

Sets a new value indicating if the engine style or the default system style is set for the engine window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return true).

Arguments

bool style - Set true to enable the engine style for the engine window; false - to disable it.

bool isEngineStyle() const#

Returns the current value indicating if the engine style or the default system style is set for the engine window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return true).

Return value

true if the engine style for the engine window is enabled; otherwise false.

void setSystemStyle ( bool style ) #

Sets a new value indicating if the default system style or the engine style is set for the engine window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return true).

Arguments

bool style - Set true to enable the default system style for the engine window; false - to disable it.

bool isSystemStyle() const#

Returns the current value indicating if the default system style or the engine style is set for the engine window.

NoticeThis method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return true).

Return value

true if the default system style for the engine window is enabled; otherwise false.

void setTitleBarHeight ( int height ) #

Sets a new height of the window title bar.

Notice

This value is applied to the windows in the engine style only. For system-style windows system settings are applied.
This method can be applied to a separate or parent window, using this method for a nested window is not allowed (it will return 0).

Arguments

int height - The engine window title bar height.

int getTitleBarHeight() const#

Returns the current height of the window title bar.

Notice

This value is applied to the windows in the engine style only. For system-style windows system settings are applied.
This method can be applied to a separate or parent window, using this method for a nested window is not allowed (it will return 0).

Return value

Current engine window title bar height.

void setTitleBarEnabled ( bool enabled ) #

Sets a new value indicating if the title bar is enabled for the engine window.

Notice

This value is applied to the windows in the engine style only. For system-style windows system settings are applied.
This method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return 0).

Arguments

bool enabled - Set true to enable the title bar for the engine window; false - to disable it.

bool isTitleBarEnabled() const#

Returns the current value indicating if the title bar is enabled for the engine window.

Notice

This value is applied to the windows in the engine style only. For system-style windows system settings are applied.
This method should be applied to a separate or parent window, using this method for a nested window is not allowed (it will return 0).

Return value

true if the title bar for the engine window is enabled; otherwise false.

const char * getTypeName() const#

Returns the current name of the engine window type as a string.

Return value

Current string representation of the engine window type.

getType() const#

Returns the current type of the engine window.

Return value

Current type of the engine window.

float getDpiScale() const#

Returns the current DPI scale applied to the elements inside the window.

Return value

Current DPI scale applied to the elements inside the window.

int getDpi() const#

Returns the current DPI level for the window.

Return value

Current DPI level for the window.

getMaxRenderSize() const#

Returns the current maximum window size in pixels.

Return value

Current maximum window size in pixels.

getMinRenderSize() const#

Returns the current minimum window size in pixels.

Return value

Current minimum window size in pixels.

getClientRenderSize() const#

Returns the current client area size in pixels.

Return value

Current client area size in pixels.

getRenderSize() const#

Returns the current engine window frame size in pixels.