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

Typedefs
typedef struct VuoWindowReference_struct *	VuoWindowReference
	A unique ID for a window being displayed by the composition.

Functions
VuoWindowReference	VuoWindowReference_make (void *window)
	Creates a VuoWindowReference from a VuoWindow.

VuoWindowReference	VuoWindowReference_makeFromJson (json_object *js)
	Decodes the JSON object js, expected to contain a string, to create a new VuoMouseButton.

struct json_object *	VuoWindowReference_getJson (const VuoWindowReference value)
	Encodes value as a JSON object.

char *	VuoWindowReference_getSummary (const VuoWindowReference value)
	Returns a brief human-readable summary of value.

VuoReal	VuoWindowReference_getAspectRatio (const VuoWindowReference value)
	Returns the window's current aspect ratio.

void	VuoWindowReference_getContentSize (const VuoWindowReference value, VuoInteger width, VuoInteger height, float *backingScaleFactor)
	Returns the window's current content size in pixels.

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

VuoWindowReference	VuoWindowReference_makeFromString (const char *str)
	Automatically generated function.

char *	VuoWindowReference_getString (const VuoWindowReference value)
	Automatically generated function.

void	VuoWindowReference_retain (VuoWindowReference value)
	Automatically generated function.

void	VuoWindowReference_release (VuoWindowReference value)
	Automatically generated function.

Class Documentation

struct VuoWindowReference_struct

Class Members
void *	l

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

VuoReal VuoWindowReference_getAspectRatio ( const VuoWindowReference value )

Returns the window's current aspect ratio.

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 on any thread except the main thread.

json_object * VuoWindowReference_getJson ( const VuoWindowReference value )

read

Encodes value as a JSON object.

char* VuoWindowReference_getString ( const VuoWindowReference value )

Automatically generated function.

char * VuoWindowReference_getSummary ( const VuoWindowReference value )

Returns a brief human-readable summary of value.

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

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.

VuoWindowReference VuoWindowReference_makeFromJson ( struct json_object * js )

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

VuoWindowReference VuoWindowReference_makeFromString ( const char * str )

Automatically generated function.

void VuoWindowReference_release ( VuoWindowReference value )

Automatically generated function.

void VuoWindowReference_retain ( VuoWindowReference value )

Automatically generated function.