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_struct *	VuoWindowReference
	A unique ID for a window being displayed by the composition. More...

Functions
VuoWindowReference	VuoWindowReference_make (void *window)
	Creates a VuoWindowReference from a VuoWindow. More...
VuoWindowReference	VuoWindowReference_makeFromJson (json_object *js)
	Decodes the JSON object js, expected to contain a string, to create a new VuoMouseButton. More...
struct json_object *	VuoWindowReference_getJson (const VuoWindowReference value)
	Encodes value as a JSON object. More...
struct json_object *	VuoWindowReference_getInterprocessJson (const VuoWindowReference value)
	Calls VuoWindowReference_getJson(). More...
char *	VuoWindowReference_getSummary (const VuoWindowReference value)
	Returns a brief human-readable summary of value. More...
VuoReal	VuoWindowReference_getAspectRatio (const VuoWindowReference value)
	Returns the window's current aspect ratio. More...
VuoPoint2d	VuoWindowReference_getPosition (const VuoWindowReference value)
	Returns the position of the top-left of the window's content area, in screen points. 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...
VuoScreen	VuoWindowReference_getScreen (const VuoWindowReference value)
	Returns the screen the window is currently on. 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 36 of file VuoWindowReference.h.

Typedef Documentation

VuoWindowReference

typedef const struct VuoWindowReference_struct * 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 110 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 143 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_getPosition()

VuoPoint2d VuoWindowReference_getPosition

(

const VuoWindowReference

value

)

Returns the position of the top-left of the window's content area, in screen points.

This function may be called from any thread.

Definition at line 123 of file VuoWindowReference.m.

VuoWindowReference_getScreen()

VuoScreen VuoWindowReference_getScreen

(

const VuoWindowReference

value

)

Returns the screen the window is currently on.

Definition at line 176 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 158 of file VuoWindowReference.m.

VuoWindowReference_isFullscreen()

bool VuoWindowReference_isFullscreen

(

const VuoWindowReference

value

)

Returns true if the window is currently fullscreen.

Definition at line 167 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

(

struct 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.