CoreGraphics::DisplayMode Class Reference

#include <displaymode.h>

Detailed Description

Describe a fullscreen display mode or window dimensions.

Copyright

(C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Public Member Functions
	DisplayMode ()
	default constructor
	DisplayMode (uint x, uint y, SizeT w, SizeT h)
	windowed mode constructor
	DisplayMode (SizeT w, SizeT h, PixelFormat::Code p)
	fullscreen constructor
	DisplayMode (uint x, uint y, SizeT w, SizeT h, PixelFormat::Code p)
	generic constructor
bool	operator== (const DisplayMode &rhs) const
	equality operator
bool	operator!= (const DisplayMode &rhs) const
	inequality operator
void	SetXPos (uint x)
	set x position
uint	GetXPos () const
	get x position
void	SetYPos (uint y)
	set y position
uint	GetYPos () const
	get y position
void	SetWidth (SizeT w)
	set width
SizeT	GetWidth () const
	get width
void	SetHeight (SizeT h)
	set height
SizeT	GetHeight () const
	get height
void	SetPixelFormat (PixelFormat::Code p)
	set pixel format
PixelFormat::Code	GetPixelFormat () const
	get pixel format
void	SetAspectRatio (float a)
	set aspect ratio
float	GetAspectRatio () const
	get aspect ratio
void	SetRefreshRate (uint refreshRate)
	using DirectX 11, the refresh rate exists within the display mode
uint	GetRefreshRate () const
	gives you the refresh rate
void	SetContentScale (float s)
	set content scale factor
float	GetContentScale () const
	get content scale factor

Private Attributes
uint	xPos
uint	yPos
SizeT	width
SizeT	height
uint	refreshRate
float	aspectRatio
float	contentScale
PixelFormat::Code	pixelFormat

Constructor & Destructor Documentation

DisplayMode() [1/4]

CoreGraphics::DisplayMode::DisplayMode ( )

inline

default constructor

DisplayMode() [2/4]

CoreGraphics::DisplayMode::DisplayMode ( uint x, uint y, SizeT w, SizeT h )

inline

windowed mode constructor

This constructor is suitable for windowed modes.

DisplayMode() [3/4]

CoreGraphics::DisplayMode::DisplayMode ( SizeT w, SizeT h, PixelFormat::Code p )

inline

fullscreen constructor

This constructor is suitable for fullscreen modes.

DisplayMode() [4/4]

CoreGraphics::DisplayMode::DisplayMode ( uint x, uint y, SizeT w, SizeT h, PixelFormat::Code p )

inline

generic constructor

Member Function Documentation

GetAspectRatio()

float CoreGraphics::DisplayMode::GetAspectRatio ( ) const

inline

get aspect ratio

GetContentScale()

float CoreGraphics::DisplayMode::GetContentScale ( ) const

inline

get content scale factor

GetHeight()

SizeT CoreGraphics::DisplayMode::GetHeight ( ) const

inline

get height

GetPixelFormat()

PixelFormat::Code CoreGraphics::DisplayMode::GetPixelFormat ( ) const

inline

get pixel format

GetRefreshRate()

uint CoreGraphics::DisplayMode::GetRefreshRate ( ) const

inline

gives you the refresh rate

GetWidth()

SizeT CoreGraphics::DisplayMode::GetWidth ( ) const

inline

get width

GetXPos()

uint CoreGraphics::DisplayMode::GetXPos ( ) const

inline

get x position

GetYPos()

uint CoreGraphics::DisplayMode::GetYPos ( ) const

inline

get y position

operator!=()

bool CoreGraphics::DisplayMode::operator!= ( const DisplayMode & rhs ) const

inline

inequality operator

operator==()

bool CoreGraphics::DisplayMode::operator== ( const DisplayMode & rhs ) const

inline

equality operator

SetAspectRatio()

void CoreGraphics::DisplayMode::SetAspectRatio ( float a )

inline

set aspect ratio

SetContentScale()

void CoreGraphics::DisplayMode::SetContentScale ( float s )

inline

set content scale factor

SetHeight()

void CoreGraphics::DisplayMode::SetHeight ( SizeT h )

inline

set height

SetPixelFormat()

void CoreGraphics::DisplayMode::SetPixelFormat ( PixelFormat::Code p )

inline

set pixel format

SetRefreshRate()

void CoreGraphics::DisplayMode::SetRefreshRate ( uint refreshRate )

inline

using DirectX 11, the refresh rate exists within the display mode

SetWidth()

void CoreGraphics::DisplayMode::SetWidth ( SizeT w )

inline

set width

SetXPos()

void CoreGraphics::DisplayMode::SetXPos ( uint x )

inline

set x position

SetYPos()

void CoreGraphics::DisplayMode::SetYPos ( uint y )

inline

set y position

Member Data Documentation

aspectRatio

float CoreGraphics::DisplayMode::aspectRatio

private

contentScale

float CoreGraphics::DisplayMode::contentScale

private

height

SizeT CoreGraphics::DisplayMode::height

private

pixelFormat

PixelFormat::Code CoreGraphics::DisplayMode::pixelFormat

private

refreshRate

uint CoreGraphics::DisplayMode::refreshRate

private

width

SizeT CoreGraphics::DisplayMode::width

private

xPos

uint CoreGraphics::DisplayMode::xPos

private

yPos

uint CoreGraphics::DisplayMode::yPos

private

---

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

• /github/workspace/code/render/coregraphics/displaymode.h