Public Member Functions | Static Public Member Functions | Friends
cinder::Display Class Reference

#import <Display.h>

List of all members.

Public Member Functions

() - ~Display
(int) - getWidth
 Returns the width of the screen measured in points.
(int) - getHeight
 Returns the height of the screen measured in points.
(Vec2i- getSize
 Returns the size of the Display measured in points.
(float) - getAspectRatio
 Returns the Display aspect ratio, which is its width / height.
(Area- getBounds
 Returns the bounding Area of the Display in points, measured relative to primary display's upper-left corner.
(Vec2i- getSystemCoordinate
 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) - getBitsPerPixel
 Returns the bits per pixel for the display. Typically 24 bits.
(float) - getContentScale
 Returns the factor which multiplies points to pixels. 2.0f for high-density (Retina) displays; 1.0f for others.
(bool) - contains
 Returns whether the Display's coordinates contain pt.
(NSScreen *) - getNsScreen
(CGDirectDisplayID- getCgDirectDisplayId
(UIScreen *) - getUiScreen
(const std::vector< Vec2i > &) - getSupportedResolutions
 Returns a vector of resolutions the Display supports.
(void) - setResolution
 Sets the resolution of the Display. Rounds to the nearest supported resolution.
(signals::signal< void()> &) - getSignalDisplaysChanged
 Returns the signal emitted when a display is connected or disconnected.
template<typename T , typename Y >
(void) - connectDisplaysChanged

Static Public Member Functions

(static DisplayRef+ getMainDisplay
 Returns the system's primary display.
(static const std::vector
< DisplayRef > &) 
+ getDisplays
 Returns a vector of all displays connected to the system.
(static DisplayRef+ getDisplayForPoint
 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.
(static Area+ getSpanningArea
 Returns the Area which spans all Displays.
(static DisplayRef+ findFromCgDirectDisplayId
(static DisplayRef+ findFromNsScreen
(static DisplayRef+ findFromHmonitor
 Finds a Display based on its HMONITOR. Returns the primary display if it's not found.
(static BOOL CALLBACK) + enumMonitorProc

Friends

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

Constructor & Destructor Documentation

- cinder:

Member Function Documentation

- (int) Display: const

Returns the width of the screen measured in points.

- (int) Display: const

Returns the height of the screen measured in points.

- (Vec2i) Display: const

Returns the size of the Display measured in points.

- (float) Display: const

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

- (Area) Display: const

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

- (Vec2i) Display: (const Vec2i &)  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) Display: const

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

- (float) Display: const

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

- (bool) Display: (const Vec2i &)  pt const

Returns whether the Display's coordinates contain pt.

- (NSScreen*) Display: const
- (CGDirectDisplayID) Display: const
- (UIScreen*) Display: const
- (const vector<Vec2i>&) cinder: const

Returns a vector of resolutions the Display supports.

- (void) Display: (const Vec2i &)  resolution

Sets the resolution of the Display. Rounds to the nearest supported resolution.

+ (DisplayRef) Display:

Returns the system's primary display.

+ (const vector< DisplayRef > &) Display:

Returns a vector of all displays connected to the system.

+ (DisplayRef) Display: (const Vec2i &)  pt

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) Display:

Returns the Area which spans all Displays.

+ (DisplayRef) Display: (CGDirectDisplayID displayID
+ (DisplayRef) Display: (NSScreen *)  nsScreen
+ (DisplayRef) Display: (HMONITOR)  hMonitor

Finds a Display based on its HMONITOR. Returns the primary display if it's not found.

+ (BOOL CALLBACK) Display: (HMONITOR)  hMonitor
(HDC)  hdc
(LPRECT)  rect
(LPARAM)  lParam 
- signals:

Returns the signal emitted when a display is connected or disconnected.

template<typename T , typename Y >
- (void) Display: (T)  fn
(Y *)  inst 

Friends And Related Function Documentation

- std: ( std::ostream &  o,
const Display display 
) [friend]

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