This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials

Unigine::Displays Class

Header: #include <UnigineDisplays.h>

The Displays class allows getting information about connected displays such as the number of screen displays and the index of the main one, their position and size in pixels. It provides access to the name and current dpi. This class also allows obtaining the total number of available modes for displays and getting the resolution and refresh rate by the mode index.

Displays Class

Enums

ORIENTATION#

NameDescription
ORIENTATION_UNKNOWN = -1Another undefined type of orientation.
ORIENTATION_LANDSCAPE = 0Landscape orientation.
ORIENTATION_LANDSCAPE_FLIPPED = 1Landscape orientation turned upside down.
ORIENTATION_PORTRAIT = 2Portrait orientation.
ORIENTATION_PORTRAIT_FLIPPED = 3Portrait orientation turned upside down.

Members


int getMain ( ) const#

Returns the main system display index.

Return value

The index of the main system display.

int getDefaultSystemDPI ( ) const#

Returns the default system dots/pixels-per-inch value.

Return value

The dots/pixels-per-inch value.

int getNum ( ) const#

Returns the number of available video displays.

Return value

The number of available video displays.

Math::ivec2 getPosition ( int display_index ) const#

Returns the display position by its index.

Arguments

  • int display_index - Display index.

Return value

Display position.

Math::ivec2 getResolution ( int display_index ) const#

Returns the display resolution by its index.

Arguments

  • int display_index - Display index.

Return value

Display resolution.

int getDPI ( int display_index ) const#

Returns the display DPI by its index.

Arguments

  • int display_index - Display index.

Return value

Display DPI.

int getNumModes ( int display_index ) const#

Returns the total number of available display modes.

Arguments

  • int display_index - Display index.

Return value

Number of available display modes.

Math::ivec2 getModeResolution ( int display_index, int mode_index ) const#

Returns the resolution of the selected display mode for the selected display.

Arguments

Return value

Resolution.

int getModeRefreshRate ( int display_index, int mode_index ) const#

Returns the refresh rate of the specified display mode.

Arguments

Return value

Refresh rate of the specified display mode.

const char * getName ( int display_index ) const#

Returns the system name of the display.

Arguments

  • int display_index - Display index.

Return value

System name of the display.

int getCurrent ( ) const#

Returns the index of the display that is currently under cursor.

Return value

The index of the display that is currently under cursor.

int getRefreshRate ( int display_index ) const#

Returns the current refresh rate of the specified display.

Arguments

  • int display_index - Display index.

Return value

Refresh rate of the specified display.

int getCurrentMode ( int display_index ) const#

Returns the current display mode for the specified display.

Arguments

  • int display_index - Display index.

Return value

Index of the display mode from 0 to the total number of available display modes.

int getDesktopMode ( int display_index ) const#

Returns information about the desktop's display mode. There's a difference between this function and getCurrentMode() when the application runs fullscreen and has changed the resolution. In such a case, this function will return the previous native display mode, and not the current display mode.

Arguments

  • int display_index - Display index.

Return value

Index of the display mode from 0 to the total number of available display modes.

Displays::ORIENTATION getOrientation ( int display_index ) const#

Returns the display orientation.

Arguments

  • int display_index - Display index.

Return value

Orientation, one of the ORIENTATION_* values.

int getUniqueID ( int display_index ) const#

Returns the unique ID for the display.

Arguments

  • int display_index - Display index.

Return value

Display unique ID.

int findDisplay ( const char * name ) const#

Returns the display index by its name.

Arguments

  • const char * name - Display name.

Return value

Display index.

int findDisplay ( int unique_id ) const#

Returns the display index by its unique ID.

Arguments

  • int unique_id - Display unique ID.

Return value

Display index, or -1 if the display is not found.

int findMode ( int display_index, const Math::ivec2 & resolution ) const#

Returns the index of the display mode by the display index and resolution.

Arguments

  • int display_index - Display index.
  • const Math::ivec2 & resolution - Display resolution.

Return value

Index of the display mode from 0 to the total number of available display modes, or -1 if the mode is not found.

int findMode ( int display_index, const Math::ivec2 & resolution, int refresh_rate ) const#

Returns the index of the display mode by the display index, resolution, and refresh rate.

Arguments

  • int display_index - Display index.
  • const Math::ivec2 & resolution - Display resolution.
  • int refresh_rate - Refresh rate.

Return value

Index of the display mode from 0 to the total number of available display modes, or -1 if the mode is not found.
Last update: 2022-10-10
Build: ()