Vuo  2.3.2
Classes | Macros | 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. More...
 
struct json_objectVuoScreen_getJson (const VuoScreen value)
 Encodes value as a JSON object. More...
 
char * VuoScreen_getSummary (const VuoScreen value)
 Returns a compact string representation of value. More...
 
bool VuoScreen_areEqual (VuoScreen value1, VuoScreen value2)
 Returns true if the two screen specifications are identical. More...
 
bool VuoScreen_isLessThan (const VuoScreen a, const VuoScreen b)
 Returns true if the id of a is less than the id of b. More...
 
bool VuoScreen_realize (VuoScreen screen, VuoScreen *realizedScreen)
 Given any VuoScreen structure: More...
 
static VuoScreen VuoScreen_makeFromName (VuoText name) __attribute__((const))
 Returns a screen with the specified name. More...
 
static const char * VuoScreen_cStringForType (VuoScreenType type)
 Returns a string constant representing type. More...
 
static VuoScreenType VuoScreen_typeFromCString (const char *typeString)
 Returns the VuoScreenType corresponding with the typeString. More...
 
VuoScreen VuoScreen_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoScreen_getString (const VuoScreen value)
 Automatically generated function. More...
 
void VuoScreen_retain (VuoScreen value)
 Automatically generated function. More...
 
void VuoScreen_release (VuoScreen value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoScreen

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

◆ VuoScreenType

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

Definition at line 32 of file VuoScreen.h.

Function Documentation

◆ VuoScreen_areEqual()

bool VuoScreen_areEqual ( VuoScreen  value1,
VuoScreen  value2 
)

Returns true if the two screen specifications are identical.

Definition at line 110 of file VuoScreen.c.

◆ VuoScreen_cStringForType()

static const char* VuoScreen_cStringForType ( VuoScreenType  type)
inlinestatic

Returns a string constant representing type.

Definition at line 95 of file VuoScreen.h.

◆ VuoScreen_getJson()

struct json_object* VuoScreen_getJson ( const VuoScreen  value)

Encodes value as a JSON object.

Definition at line 65 of file VuoScreen.c.

◆ VuoScreen_getString()

char* VuoScreen_getString ( const VuoScreen  value)

Automatically generated function.

◆ VuoScreen_getSummary()

char* VuoScreen_getSummary ( const VuoScreen  value)

Returns a compact string representation of value.

Definition at line 88 of file VuoScreen.c.

◆ VuoScreen_isLessThan()

bool VuoScreen_isLessThan ( const VuoScreen  a,
const VuoScreen  b 
)

Returns true if the id of a is less than the id of b.

Changed in Vuo 2.0.0:
New.

Definition at line 127 of file VuoScreen.c.

◆ VuoScreen_makeFromJson()

VuoScreen VuoScreen_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"type" : "match-name",
"name" : "lcd"
}

Definition at line 43 of file VuoScreen.c.

◆ VuoScreen_makeFromName()

static VuoScreen VuoScreen_makeFromName ( VuoText  name) const
inlinestatic

Returns a screen with the specified name.

Definition at line 86 of file VuoScreen.h.

◆ VuoScreen_makeFromString()

VuoScreen VuoScreen_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoScreen_realize()

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.

Definition at line 139 of file VuoScreen.c.

◆ VuoScreen_release()

void VuoScreen_release ( VuoScreen  value)

Automatically generated function.

◆ VuoScreen_retain()

void VuoScreen_retain ( VuoScreen  value)

Automatically generated function.

◆ VuoScreen_typeFromCString()

static VuoScreenType VuoScreen_typeFromCString ( const char *  typeString)
inlinestatic

Returns the VuoScreenType corresponding with the typeString.

If none matches, returns VuoScreenType_Primary.

Definition at line 118 of file VuoScreen.h.