Cogs::Monitor Class Reference

Helper class for enumerating available displays on the host computer. More...

#include <Monitor.h>

Public Member Functions
void *	getIdentifier () const
const std::string &	getName () const
const glm::ivec2 &	getPosition () const
const glm::ivec2 &	getSize () const
glm::ivec2	getCentre () const

Static Public Member Functions
static void	enumerate ()
static size_t	getCount ()
static const Monitor &	get (size_t idx)
static const Monitor *	findByName (const std::string &name)
static const Monitor *	findFromPoint (const glm::ivec2 &point)
static const Monitor *	findFromRect (const glm::ivec2 &tl, const glm::ivec2 &br)

Private Types
using	List = std::vector< Monitor >

Private Attributes
void *	identifier = nullptr
	Platform specific identifier.
std::string	name
	User-friendly name for this monitor.
glm::ivec2	position
	Position of this monitor in desktop coordinates.
glm::ivec2	size
	Size of this monitor in desktop coordinates.
bool	primary = false
	This is the user's primary monitor.

Static Private Attributes
static List	monitors

Detailed Description

Helper class for enumerating available displays on the host computer.

*============================================================================================

Member Typedef Documentation

List

using Cogs::Monitor::List = std::vector<Monitor>

private

Member Function Documentation

enumerate()

void Cogs::Monitor::enumerate ( )

static

References identifier, monitors, name, position, primary, and size.

findByName()

const Cogs::Monitor * Cogs::Monitor::findByName ( const std::string &  name )

static

findFromPoint()

const Cogs::Monitor * Cogs::Monitor::findFromPoint ( const glm::ivec2 &  point )

static

References position.

findFromRect()

const Cogs::Monitor * Cogs::Monitor::findFromRect ( const glm::ivec2 &  tl, const glm::ivec2 &  br  )

static

References position, and size.

get()

const Cogs::Monitor & Cogs::Monitor::get ( size_t  idx )

static

getCentre()

glm::ivec2 Cogs::Monitor::getCentre ( ) const

inline

getCount()

size_t Cogs::Monitor::getCount ( )

static

References monitors.

getIdentifier()

void * Cogs::Monitor::getIdentifier ( ) const

inline

getName()

const std::string & Cogs::Monitor::getName ( ) const

inline

getPosition()

const glm::ivec2 & Cogs::Monitor::getPosition ( ) const

inline

getSize()

const glm::ivec2 & Cogs::Monitor::getSize ( ) const

inline

Member Data Documentation

identifier

void* Cogs::Monitor::identifier = nullptr

private

Platform specific identifier.

Referenced by enumerate().

monitors

Cogs::Monitor::List Cogs::Monitor::monitors

staticprivate

Referenced by enumerate(), and getCount().

name

std::string Cogs::Monitor::name

private

User-friendly name for this monitor.

Referenced by enumerate().

position

glm::ivec2 Cogs::Monitor::position

private

Position of this monitor in desktop coordinates.

Referenced by enumerate(), findFromPoint(), and findFromRect().

primary

bool Cogs::Monitor::primary = false

private

This is the user's primary monitor.

Referenced by enumerate().

size

glm::ivec2 Cogs::Monitor::size

private

Size of this monitor in desktop coordinates.

Referenced by enumerate(), and findFromRect().

---

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

• Source/Platform/Monitor.h
• Source/Platform/Monitor.cpp
• Source/Platform/Monitor.Linux.cpp
• Source/Platform/Monitor.Windows.cpp