VuoScreen

Description

Information about a display screen.

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

Macros
#define	VuoScreen_SUPPORTS_COMPARISON
	Instances of this type can be compared and sorted.

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_object *	VuoScreen_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_isLessThan (const VuoScreen a, const VuoScreen b)
	Returns true if the id of a is less than the id of b.
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.
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

VuoScreen

struct VuoScreen

Class Members
VuoInteger	displayMask	CGDisplayIDToOpenGLDisplayMask()
VuoInteger	dpiHorizontal
VuoInteger	dpiVertical
VuoInteger	height
VuoInteger	id	NSScreenNumber.
VuoBoolean	isMirrored
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

Macro Definition Documentation

VuoScreen_SUPPORTS_COMPARISON

#define VuoScreen_SUPPORTS_COMPARISON

Instances of this type can be compared and sorted.

Definition at line 66 of file VuoScreen.h.

Enumeration Type Documentation

VuoScreenType

enum VuoScreenType

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

Definition at line 34 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 120 of file VuoScreen.c.

VuoScreen_cStringForType()

static const char * VuoScreen_cStringForType ( VuoScreenType  type )

inlinestatic

Returns a string constant representing type.

Definition at line 99 of file VuoScreen.h.

VuoScreen_getJson()

struct json_object * VuoScreen_getJson

(

const VuoScreen

value

)

Encodes value as a JSON object.

Definition at line 67 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 92 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 138 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 42 of file VuoScreen.c.

VuoScreen_makeFromName()

static VuoScreen VuoScreen_makeFromName ( VuoText  name ) const

inlinestatic

Returns a screen with the specified name.

Definition at line 90 of file VuoScreen.h.

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 150 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 122 of file VuoScreen.h.