VuoWindow.h File Reference

Description

VuoWindow interface.

Copyright

Copyright © 2012–2018 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Typedefs
typedef void *	VuoWindowText
	A window containing a text edit widget. More...
typedef void *	VuoWindowOpenGl
	A window containing an OpenGL view. More...

Functions
VuoWindowText	VuoWindowText_make (void)
	Creates and displays a window containing a text edit widget. More...
void	VuoWindowText_enableTriggers (VuoWindowText w, VuoOutputTrigger(typedLine, VuoText), VuoOutputTrigger(typedWord, VuoText), VuoOutputTrigger(typedCharacter, VuoText))
	Sets up the window to call the trigger functions when its text is edited. More...
void	VuoWindowText_disableTriggers (VuoWindowText w)
	Stops the window from calling trigger functions when its text is edited. More...
void	VuoWindowText_appendLine (VuoWindowText w, const char *text)
	Appends text and a linebreak to the text edit widget in the window. More...
void	VuoWindowText_close (VuoWindowText w)
	Closes the window. More...
VuoWindowOpenGl	VuoWindowOpenGl_make (void(*initCallback)(void *, float backingScaleFactor), void(*updateBackingCallback)(void *, float backingScaleFactor), void(*resizeCallback)(void *, unsigned int, unsigned int), VuoIoSurface(*drawCallback)(void *), void *context)
	Creates and displays a window containing an OpenGL view. More...
void	VuoWindowOpenGl_enableTriggers (VuoWindowOpenGl w, VuoOutputTrigger(showedWindow, VuoWindowReference), VuoOutputTrigger(requestedFrame, VuoReal))
	Sets up the window to call the trigger functions when events occur. More...
void	VuoWindowOpenGl_disableTriggers (VuoWindowOpenGl w)
	Stops the window from calling trigger functions when events occur. More...
void	VuoWindowOpenGl_redraw (VuoWindowOpenGl w)
	Schedules the specified window to be redrawn. More...
void	VuoWindowOpenGl_setProperties (VuoWindowOpenGl w, VuoList_VuoWindowProperty properties)
	Applies a list of properties to a window. More...
void	VuoWindowOpenGl_setAspectRatio (VuoWindowOpenGl w, unsigned int pixelsWide, unsigned int pixelsHigh)
	Sets the window's current and preferred aspect ratio. More...
void	VuoWindowOpenGl_unlockAspectRatio (VuoWindowOpenGl w)
	Removes the aspect ratio constraint set by VuoWindowOpenGl_setAspectRatio. More...
void	VuoWindowOpenGl_close (VuoWindowOpenGl w)
	Closes the window. More...

Typedef Documentation

VuoWindowOpenGl

typedef void* VuoWindowOpenGl

A window containing an OpenGL view.

VuoWindowText

typedef void* VuoWindowText

A window containing a text edit widget.

Function Documentation

VuoWindowOpenGl_close()

void VuoWindowOpenGl_close

(

VuoWindowOpenGl

vw

)

Closes the window.

This function may be called on any thread except the main thread.

VuoWindowOpenGl_disableTriggers()

void VuoWindowOpenGl_disableTriggers

(

VuoWindowOpenGl

w

)

Stops the window from calling trigger functions when events occur.

This function may be called on any thread except the main thread.

VuoWindowOpenGl_enableTriggers()

void VuoWindowOpenGl_enableTriggers	(	VuoWindowOpenGl	w,
		VuoOutputTrigger(showedWindow, VuoWindowReference)	,
		VuoOutputTrigger(requestedFrame, VuoReal)
	)

Sets up the window to call the trigger functions when events occur.

This function may be called on any thread except the main thread.

VuoWindowOpenGl_make()

VuoWindowOpenGl VuoWindowOpenGl_make	(	void(*)(void *, float backingScaleFactor)	initCallback,
		void(*)(void *, float backingScaleFactor)	updateBackingCallback,
		void(*)(void *, unsigned int, unsigned int)	resizeCallback,
		VuoIoSurface(*)(void *)	drawCallback,
		void *	context
	)

Creates and displays a window containing an OpenGL view.

Creates a new NSApplication instance if one did not already exist.

This function may be called on any thread except the main thread.

VuoWindowOpenGl_redraw()

void VuoWindowOpenGl_redraw

(

VuoWindowOpenGl

w

)

Schedules the specified window to be redrawn.

This function may be called from any thread.

VuoWindowOpenGl_setAspectRatio()

void VuoWindowOpenGl_setAspectRatio	(	VuoWindowOpenGl	w,
		unsigned int	pixelsWide,
		unsigned int	pixelsHigh
	)

Sets the window's current and preferred aspect ratio.

If necessary, the window is resized to match the specified aspect ratio. After calling this method, when the user resizes the window, its height is adjusted to match the specified aspect ratio.

VuoWindowOpenGl_setProperties()

void VuoWindowOpenGl_setProperties	(	VuoWindowOpenGl	w,
		VuoList_VuoWindowProperty	properties
	)

Applies a list of properties to a window.

This function may be called from any thread.

VuoWindowOpenGl_unlockAspectRatio()

void VuoWindowOpenGl_unlockAspectRatio

(

VuoWindowOpenGl

w

)

Removes the aspect ratio constraint set by VuoWindowOpenGl_setAspectRatio.

After calling this method, the user will be able to resizes the window freely.

VuoWindowText_appendLine()

void VuoWindowText_appendLine	(	VuoWindowText	vw,
		const char *	text
	)

Appends text and a linebreak to the text edit widget in the window.

This function may be called from any thread.

VuoWindowText_close()

void VuoWindowText_close

(

VuoWindowText

vw

)

Closes the window.

This function may be called on any thread except the main thread.

VuoWindowText_disableTriggers()

void VuoWindowText_disableTriggers

(

VuoWindowText

w

)

Stops the window from calling trigger functions when its text is edited.

This function may be called on any thread except the main thread.

VuoWindowText_enableTriggers()

void VuoWindowText_enableTriggers	(	VuoWindowText	w,
		VuoOutputTrigger(typedLine, VuoText)	,
		VuoOutputTrigger(typedWord, VuoText)	,
		VuoOutputTrigger(typedCharacter, VuoText)
	)

Sets up the window to call the trigger functions when its text is edited.

This function may be called on any thread except the main thread.

VuoWindowText_make()

VuoWindowText VuoWindowText_make

(

void

)

Creates and displays a window containing a text edit widget.

Creates a new NSApplication instance if one did not already exist.

This function may be called on any thread except the main thread.