Cinder  0.9.1
Public Member Functions | List of all members
cinder::app::FullScreenOptions Struct Reference

#include <Window.h>

Public Member Functions

 FullScreenOptions ()
 
FullScreenOptionskioskMode (bool enable=true)
 
FullScreenOptionssecondaryDisplayBlanking (bool enable=true)
 
FullScreenOptionsexclusive (bool enable=true)
 
FullScreenOptionsdisplay (DisplayRef display)
 
DisplayRef getDisplay () const
 
bool isKioskModeEnabled () const
 
bool isSecondaryDisplayBlankingEnabled () const
 
bool isExclusive () const
 

Detailed Description

Options passed when entering fullscreen.

Constructor & Destructor Documentation

cinder::app::FullScreenOptions::FullScreenOptions ( )

Member Function Documentation

FullScreenOptions& cinder::app::FullScreenOptions::kioskMode ( bool  enable = true)

(OS X only) Sets the fullscreen mode to 'kiosk', which means don't use the 10.7 way of animating to fullscreen. Default is true.

FullScreenOptions& cinder::app::FullScreenOptions::secondaryDisplayBlanking ( bool  enable = true)

Sets whether secondary displays should be blanked (made black). Default is false.

FullScreenOptions& cinder::app::FullScreenOptions::exclusive ( bool  enable = true)

(OS X only) Sets whether the Window related to these options is the only accessible window. Default is false.

FullScreenOptions& cinder::app::FullScreenOptions::display ( DisplayRef  display)

Sets the display which will be used in fullscreen mode. Defaults to the Window's current Display. Ignored on Mac OS X outside of kiosk mode.

DisplayRef cinder::app::FullScreenOptions::getDisplay ( ) const

Returns the display on which the fullscreen should occur. A NULL value implies the default, which is the Window's current Display.

bool cinder::app::FullScreenOptions::isKioskModeEnabled ( ) const

Returns whether kiosk mode is enabled.

bool cinder::app::FullScreenOptions::isSecondaryDisplayBlankingEnabled ( ) const

Returns whether blanking of secondary displays in enabled. Default is false.

bool cinder::app::FullScreenOptions::isExclusive ( ) const

Returns whether the Window related to these options is the only accessible window.


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