Vuo  1.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Enumerations | Functions

Description

Information about a display screen.

Classes

struct  VuoScreen
 Information about a display screen. More...
 

Enumerations

enum  VuoScreenType {
  VuoScreenType_Active, VuoScreenType_Primary, VuoScreenType_Secondary, VuoScreenType_MatchId,
  VuoScreenType_MatchName
}
 How the screen should be selected from those available on the running system. More...
 

Functions

VuoScreen VuoScreen_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoScreen_getJson (const VuoScreen value)
 Encodes value as a JSON object.
 
char * VuoScreen_getSummary (const VuoScreen value)
 Returns a compact string representation of value.
 
bool VuoScreen_areEqual (VuoScreen value1, VuoScreen value2)
 Returns true if the two screen specifications are identical.
 
bool VuoScreen_realize (VuoScreen screen, VuoScreen *realizedScreen)
 Given any VuoScreen structure:
 
static VuoScreen VuoScreen_makeFromName (VuoText name) __attribute__((const ))
 Returns a screen with the specified name.
 
static const char * VuoScreen_cStringForType (VuoScreenType type)
 Returns a string constant representing type.
 
static VuoScreenType VuoScreen_typeFromCString (const char *typeString)
 Returns the VuoScreenType corresponding with the typeString.
 
VuoScreen VuoScreen_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoScreen_getString (const VuoScreen value)
 Automatically generated function.
 
void VuoScreen_retain (VuoScreen value)
 Automatically generated function.
 
void VuoScreen_release (VuoScreen value)
 Automatically generated function.
 

Class Documentation

struct VuoScreen
Class Members
VuoInteger displayMask CGDisplayIDToOpenGLDisplayMask()
VuoInteger dpiHorizontal
VuoInteger dpiVertical
VuoInteger height
VuoInteger id NSScreenNumber.
bool isRealized True if this VuoScreen refers to a specific screen by ID, and the following values are filled in.
VuoText name e.g., Color LCD for a built-in MacBook Pro display
VuoPoint2d topLeft
VuoScreenType type
VuoInteger width

Enumeration Type Documentation

How the screen should be selected from those available on the running system.

Function Documentation

bool VuoScreen_areEqual ( VuoScreen  value1,
VuoScreen  value2 
)

Returns true if the two screen specifications are identical.

static const char* VuoScreen_cStringForType ( VuoScreenType  type)
inlinestatic

Returns a string constant representing type.

struct json_object* VuoScreen_getJson ( const VuoScreen  value)
read

Encodes value as a JSON object.

char* VuoScreen_getString ( const VuoScreen  value)

Automatically generated function.

char* VuoScreen_getSummary ( const VuoScreen  value)

Returns a compact string representation of value.

VuoScreen VuoScreen_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"type" : "match-name",
"name" : "lcd"
}
static VuoScreen VuoScreen_makeFromName ( VuoText  name) const
inlinestatic

Returns a screen with the specified name.

VuoScreen VuoScreen_makeFromString ( const char *  str)

Automatically generated function.

bool VuoScreen_realize ( VuoScreen  screen,
VuoScreen realizedScreen 
)

Given any VuoScreen structure:

  • If screen is already realized, copies it into realizedScreen, and returns true.
  • If a matching screen is found, setsrealizedScreento match it by ID, fills in all the details, and returns true.
  • If no matching screen is found, returns false, leavingrealizedDevice` unset.
void VuoScreen_release ( VuoScreen  value)

Automatically generated function.

void VuoScreen_retain ( VuoScreen  value)

Automatically generated function.

static VuoScreenType VuoScreen_typeFromCString ( const char *  typeString)
inlinestatic

Returns the VuoScreenType corresponding with the typeString.

If none matches, returns VuoScreenType_Primary.