Vuo  2.0.0
Classes | Enumerations | Functions
VuoWindowProperty

Description

A window setting, such as its title, or whether it is full-screen.

Classes

struct  VuoWindowProperty
 A window setting, such as its title, or whether it is full-screen. More...
 

Enumerations

enum  VuoWindowPropertyType {
  VuoWindowProperty_Title, VuoWindowProperty_FullScreen, VuoWindowProperty_Position, VuoWindowProperty_Size,
  VuoWindowProperty_AspectRatio, VuoWindowProperty_AspectRatioReset, VuoWindowProperty_Resizable, VuoWindowProperty_Cursor,
  VuoWindowProperty_Interaction
}
 The type of window property. More...
 

Functions

VuoWindowProperty VuoWindowProperty_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoWindowProperty_getJson (const VuoWindowProperty value)
 Encodes value as a JSON object. More...
 
char * VuoWindowProperty_getSummary (const VuoWindowProperty value)
 Returns a compact string representation of value. More...
 
VuoList_VuoWindowProperty VuoWindowProperty_getPropertiesWithType (const VuoList_VuoWindowProperty windowProperties, const VuoWindowPropertyType windowPropertyType)
 Returns a list of window properties matching windowPropertyType in the windowProperties list. More...
 
VuoWindowProperty VuoWindowProperty_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoWindowProperty_getString (const VuoWindowProperty value)
 Automatically generated function. More...
 
void VuoWindowProperty_retain (VuoWindowProperty value)
 Automatically generated function. More...
 
void VuoWindowProperty_release (VuoWindowProperty value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoWindowProperty

struct VuoWindowProperty
Class Members
VuoReal aspectRatio
VuoCursor cursor
VuoBoolean fullScreen
VuoInteger height
VuoInteraction interaction
VuoInteger left
VuoBoolean resizable
VuoScreen screen
VuoText title
VuoInteger top
VuoWindowPropertyType type
VuoCoordinateUnit unit
VuoInteger width

Enumeration Type Documentation

◆ VuoWindowPropertyType

The type of window property.

Changed in Vuo 2.0.0:
Added VuoWindowProperty_Interaction.

Definition at line 39 of file VuoWindowProperty.h.

Function Documentation

◆ VuoWindowProperty_getJson()

struct json_object* VuoWindowProperty_getJson ( const VuoWindowProperty  value)

Encodes value as a JSON object.

Definition at line 120 of file VuoWindowProperty.c.

◆ VuoWindowProperty_getPropertiesWithType()

VuoList_VuoWindowProperty VuoWindowProperty_getPropertiesWithType ( const VuoList_VuoWindowProperty  windowProperties,
const VuoWindowPropertyType  windowPropertyType 
)

Returns a list of window properties matching windowPropertyType in the windowProperties list.

Changed in Vuo 2.0.0:
New.

Definition at line 214 of file VuoWindowProperty.c.

◆ VuoWindowProperty_getString()

char* VuoWindowProperty_getString ( const VuoWindowProperty  value)

Automatically generated function.

◆ VuoWindowProperty_getSummary()

char* VuoWindowProperty_getSummary ( const VuoWindowProperty  value)

Returns a compact string representation of value.

Definition at line 160 of file VuoWindowProperty.c.

◆ VuoWindowProperty_makeFromJson()

VuoWindowProperty VuoWindowProperty_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
{
"title" : "My Composition"
}

Definition at line 45 of file VuoWindowProperty.c.

◆ VuoWindowProperty_makeFromString()

VuoWindowProperty VuoWindowProperty_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoWindowProperty_release()

void VuoWindowProperty_release ( VuoWindowProperty  value)

Automatically generated function.

◆ VuoWindowProperty_retain()

void VuoWindowProperty_retain ( VuoWindowProperty  value)

Automatically generated function.