Vuo  2.0.2
Classes | Macros | Typedefs | Functions
VuoWindowReference

Description

A unique ID for a window being displayed by the composition.

Classes

struct  VuoWindowReference_struct
 A unique ID for a window being displayed by the composition. More...
 

Macros

#define VuoWindowReference_REQUIRES_INTERPROCESS_JSON
 This type has a _getInterprocessJson() function. More...
 

Typedefs

typedef const struct VuoWindowReference_structVuoWindowReference
 A unique ID for a window being displayed by the composition. More...
 

Functions

VuoWindowReference VuoWindowReference_make (void *window)
 
VuoWindowReference VuoWindowReference_makeFromJson (struct json_object *js)
 
struct json_objectVuoWindowReference_getJson (const VuoWindowReference value)
 
struct json_objectVuoWindowReference_getInterprocessJson (const VuoWindowReference value)
 
char * VuoWindowReference_getSummary (const VuoWindowReference value)
 
VuoReal VuoWindowReference_getAspectRatio (const VuoWindowReference value)
 Returns the window's current aspect ratio. More...
 
void VuoWindowReference_getContentSize (const VuoWindowReference value, VuoInteger *width, VuoInteger *height, float *backingScaleFactor)
 Returns the window's current content size in pixels. More...
 
bool VuoWindowReference_isFocused (const VuoWindowReference value)
 Returns true if the application is currently focused and the window is currently focused (disregarding auxiliary windows, such as the About box). More...
 
bool VuoWindowReference_isFullscreen (const VuoWindowReference value)
 Returns true if the window is currently fullscreen. More...
 
VuoWindowReference VuoWindowReference_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoWindowReference_getString (const VuoWindowReference value)
 Automatically generated function. More...
 
void VuoWindowReference_retain (VuoWindowReference value)
 Automatically generated function. More...
 
void VuoWindowReference_release (VuoWindowReference value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoWindowReference_struct

struct VuoWindowReference_struct
Class Members
void * l

Macro Definition Documentation

◆ VuoWindowReference_REQUIRES_INTERPROCESS_JSON

#define VuoWindowReference_REQUIRES_INTERPROCESS_JSON

This type has a _getInterprocessJson() function.

Definition at line 34 of file VuoWindowReference.h.

Typedef Documentation

◆ VuoWindowReference

A unique ID for a window being displayed by the composition.

Function Documentation

◆ VuoWindowReference_getAspectRatio()

VuoReal VuoWindowReference_getAspectRatio ( const VuoWindowReference  value)

Returns the window's current aspect ratio.

Definition at line 104 of file VuoWindowReference.m.

◆ VuoWindowReference_getContentSize()

void VuoWindowReference_getContentSize ( const VuoWindowReference  value,
VuoInteger width,
VuoInteger height,
float *  backingScaleFactor 
)

Returns the window's current content size in pixels.

On Retina displays, this function returns the physical number of pixels (device/backing resolution, not logical resolution).

This function may be called from any thread.

Definition at line 119 of file VuoWindowReference.m.

◆ VuoWindowReference_getInterprocessJson()

json_object * VuoWindowReference_getInterprocessJson ( const VuoWindowReference  value)

Calls VuoWindowReference_getJson(). Interprocess support is not yet implemented.

Definition at line 84 of file VuoWindowReference.m.

◆ VuoWindowReference_getJson()

json_object * VuoWindowReference_getJson ( const VuoWindowReference  value)

Encodes value as a JSON object.

Definition at line 70 of file VuoWindowReference.m.

◆ VuoWindowReference_getString()

char* VuoWindowReference_getString ( const VuoWindowReference  value)

Automatically generated function.

◆ VuoWindowReference_getSummary()

char * VuoWindowReference_getSummary ( const VuoWindowReference  value)

Returns a brief human-readable summary of value.

Definition at line 93 of file VuoWindowReference.m.

◆ VuoWindowReference_isFocused()

bool VuoWindowReference_isFocused ( const VuoWindowReference  value)

Returns true if the application is currently focused and the window is currently focused (disregarding auxiliary windows, such as the About box).

Definition at line 134 of file VuoWindowReference.m.

◆ VuoWindowReference_isFullscreen()

bool VuoWindowReference_isFullscreen ( const VuoWindowReference  value)

Returns true if the window is currently fullscreen.

Definition at line 143 of file VuoWindowReference.m.

◆ VuoWindowReference_make()

VuoWindowReference VuoWindowReference_make ( void *  window)

Creates a VuoWindowReference from a VuoWindow. Since the VuoWindowReference contains the memory address of the VuoWindow, it's only valid as long as the VuoWindow remains in memory.

Definition at line 47 of file VuoWindowReference.m.

◆ VuoWindowReference_makeFromJson()

VuoWindowReference VuoWindowReference_makeFromJson ( json_object js)

Decodes the JSON object js, expected to contain a string, to create a new VuoMouseButton.

Definition at line 56 of file VuoWindowReference.m.

◆ VuoWindowReference_makeFromString()

VuoWindowReference VuoWindowReference_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoWindowReference_release()

void VuoWindowReference_release ( VuoWindowReference  value)

Automatically generated function.

◆ VuoWindowReference_retain()

void VuoWindowReference_retain ( VuoWindowReference  value)

Automatically generated function.