Description

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

Functions
bool	VuoApp_isMainThread (void)
	Is the current thread the main thread? More...

void	VuoApp_executeOnMainThread (void(^block)(void))
	Executes the specified block on the main thread, then returns. More...

char *	VuoApp_getName (void)
	Returns the composition's name. More...

const char *	VuoApp_getVuoFrameworkPath (void)
	Returns the path of the folder containing `Vuo.framework`. More...

void	VuoApp_init (void)
	Creates an NSApplication instance (if one doesn't already exist). More...

void *	VuoApp_setMenuItems (void *items)
	Replaces the top-level menus in the menu bar, except for application-wide menus, with the given menus. More...

void	VuoApp_setMenu (void *menu)
	Replaces the top-level menus in the menu bar with the given menu. More...

Function Documentation

◆ VuoApp_executeOnMainThread()

void VuoApp_executeOnMainThread ( void(^)(void) block )

Executes the specified block on the main thread, then returns.

Can be called from any thread, including the main thread (avoids deadlock).

Don't call this from __attribute__((constructor)) functions, since this function depends on initialization which might not happen before your constructor is called.

◆ VuoApp_getName()

char* VuoApp_getName ( void )

Returns the composition's name.

If the composition is running in Vuo Editor (via VuoCompositionLoader), it extracts the name from the most-recently-loaded dylib's path. If the composition has been saved, this matches the composition's source filename. If not, it returns the text "Vuo Composition".

If the composition is running via VuoRunner (but not via VuoCompositionLoader), it returns the name of the VuoRunner process.

If the composition is running standalone, it tries the following Info.plist keys:

CFBundleDisplayName
CFBundleName
CFBundleExecutable

If none of those keys exist, it uses the composition executable's filename.

The caller is responsible for freeing the returned string.

◆ VuoApp_getVuoFrameworkPath()

const char* VuoApp_getVuoFrameworkPath ( void )

Returns the path of the folder containing Vuo.framework.

◆ VuoApp_init()

void VuoApp_init ( void )

Creates an NSApplication instance (if one doesn't already exist).

This causes the process's icon to appear in the dock.

VuoWindow methods call this automatically as needed, so you only need to call this if you need an NSApplication without using VuoWindow (like, for example, VuoAudioFile does).

This function may be called from any thread.

◆ VuoApp_isMainThread()

bool VuoApp_isMainThread ( void )

Is the current thread the main thread?

◆ VuoApp_setMenu()

void VuoApp_setMenu ( void * menu )

Replaces the top-level menus in the menu bar with the given menu.

menu should be an NSMenu.

◆ VuoApp_setMenuItems()

void* VuoApp_setMenuItems ( void * items )

Replaces the top-level menus in the menu bar, except for application-wide menus, with the given menus.

items should be an NSArray of NSMenuItems.

Returns the old menu.