Cinder  0.9.1
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
cinder::Display Class Reference

#include <Display.h>

Inherited by cinder::DisplayCocoaTouch, cinder::DisplayMsw, and cinder::DisplayWinRt.

Public Member Functions

 Display ()
 
virtual ~Display ()
 
int getWidth () const
 
int getHeight () const
 
ivec2 getSize () const
 
float getAspectRatio () const
 
Area getBounds () const
 
ivec2 getSystemCoordinate (const ivec2 &displayRelativeCoordinate) const
 
int getBitsPerPixel () const
 
float getContentScale () const
 
bool contains (const ivec2 &pt) const
 
virtual std::string getName () const
 

Static Public Member Functions

static DisplayRef getMainDisplay ()
 
static const std::vector< DisplayRef > & getDisplays ()
 
static DisplayRef getDisplayForPoint (const ivec2 &pt)
 
static Area getSpanningArea ()
 

Protected Attributes

Area mArea
 
int mBitsPerPixel
 
float mContentScale
 
std::string mName
 
bool mNameDirty
 

Friends

std::ostream & operator<< (std::ostream &o, const Display &display)
 

Constructor & Destructor Documentation

cinder::Display::Display ( )
virtual cinder::Display::~Display ( )
virtual

Member Function Documentation

int cinder::Display::getWidth ( ) const

Returns the width of the screen measured in points.

int cinder::Display::getHeight ( ) const

Returns the height of the screen measured in points.

ivec2 cinder::Display::getSize ( ) const

Returns the size of the Display measured in points.

float cinder::Display::getAspectRatio ( ) const

Returns the Display aspect ratio, which is its width / height.

Area cinder::Display::getBounds ( ) const

Returns the bounding Area of the Display in points, measured relative to primary display's upper-left corner.

ivec2 cinder::Display::getSystemCoordinate ( const ivec2 &  displayRelativeCoordinate) const

Returns the system position (relative to the system's primary display's upper-left corner) of a Display-relative displayRelativeCoordinate. The results are suitable for use with app::Window's position functions.

int cinder::Display::getBitsPerPixel ( ) const

Returns the bits per pixel for the display. Typically 24 bits.

float cinder::Display::getContentScale ( ) const

Returns the factor which multiplies points to pixels. 2.0f for high-density (Retina) displays; 1.0f for others.

bool cinder::Display::contains ( const ivec2 &  pt) const

Returns whether the Display's coordinates contain pt.

virtual std::string cinder::Display::getName ( ) const
virtual

Returns the display's name or an empty string if unavailable.

Reimplemented in cinder::DisplayMsw.

DisplayRef cinder::Display::getMainDisplay ( )
static

Returns the system's primary display.

const vector< DisplayRef > & cinder::Display::getDisplays ( )
static

Returns a vector of all displays connected to the system.

DisplayRef cinder::Display::getDisplayForPoint ( const ivec2 &  pt)
static

Returns the Display which contains a given point, measured relative to the upper-left corner of the primary display. Returns a NULL DisplayRef on failure.

Area cinder::Display::getSpanningArea ( )
static

Returns the Area which spans all Displays.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o,
const Display display 
)
friend

Member Data Documentation

Area cinder::Display::mArea
protected
int cinder::Display::mBitsPerPixel
protected
float cinder::Display::mContentScale
protected
std::string cinder::Display::mName
mutableprotected
bool cinder::Display::mNameDirty
mutableprotected

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