VuoDisplayRefresh.h File Reference

Description

VuoDisplayRefresh interface.

Copyright

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

Definition in file VuoDisplayRefresh.h.

Go to the source code of this file.

Typedefs
typedef void *	VuoDisplayRefresh
	A state object for firing display refresh events. More...

Functions
VuoDisplayRefresh	VuoDisplayRefresh_make (void *context)
	Creates a display refresh trigger instance. More...
void	VuoDisplayRefresh_enableTriggers (VuoDisplayRefresh dr, void(*requestedFrameTrigger)(VuoReal), void(*requestedFrameTriggerWithContext)(VuoReal, void *context))
	Starts firing display refresh events. More...
void	VuoDisplayRefresh_disableTriggers (VuoDisplayRefresh dr)
	After this function returns, this VuoDisplayRefresh instance will no longer fire events. More...

Typedef Documentation

VuoDisplayRefresh

typedef void* VuoDisplayRefresh

A state object for firing display refresh events.

Definition at line 22 of file VuoDisplayRefresh.h.

Function Documentation

VuoDisplayRefresh_disableTriggers()

void VuoDisplayRefresh_disableTriggers

(

VuoDisplayRefresh

dr

)

After this function returns, this VuoDisplayRefresh instance will no longer fire events.

This function may be called from any thread.

Definition at line 147 of file VuoDisplayRefresh.c.

VuoDisplayRefresh_enableTriggers()

void VuoDisplayRefresh_enableTriggers	(	VuoDisplayRefresh	dr,
		void(*)(VuoReal)	requestedFrameTrigger,
		void(*)(VuoReal, void *context)	requestedFrameTriggerWithContext
	)

Starts firing display refresh events.

See also

VuoDisplayRefreshInternal

This function may be called from any thread.

Definition at line 104 of file VuoDisplayRefresh.c.

VuoDisplayRefresh_make()

VuoDisplayRefresh VuoDisplayRefresh_make

(

void *

context

)

Creates a display refresh trigger instance.

This function may be called from any thread.

Parameters

context

Specifies custom contextual data to be passed to the requestedFrameSendoff callback (see VuoDisplayRefreshInternal)

Definition at line 83 of file VuoDisplayRefresh.c.