class VideoMode

Video mode contains information about how a render window presents its information to an output device like a monitor.

Public

Constructors

VideoMode

VideoMode() noexcept = default

VideoMode

VideoMode(u32 width, u32 height, float refreshRate = 60.F, u32 outputIdx = 0)

Creates a new video mode.

width
Width of the frame buffer in pixels.
height
Height of the frame buffer in pixels.
refreshRate
How often should the output device refresh the output image in hertz.
outputIdx
Output index of the output device. Normally this means output monitor. 0th index always represents the primary device while order of others is undefined.

Methods

~VideoMode

virtual ~VideoMode() noexcept = default

Fields

Width

u32 Width

Width of the front/back buffer in pixels.

Height

u32 Height

Height of the front/back buffer in pixels.

RefreshRate

float RefreshRate

Refresh rate in hertz.

OutputIdx

u32 OutputIdx

Index of the parent video output.

IsCustom

bool IsCustom

Determines was video mode user created or provided by the API/OS.

API/OS created video modes can contain additional information that allows the video mode to be used more accurately and you should use them when possible.

Operators

operator==

bool operator==(const VideoMode &other) const