ofxInteract.h File Reference

#include "ofxCore.h"

Include dependency graph for ofxInteract.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OfxInteractSuiteV1
	OFX suite that allows an effect to interact with an openGL window so as to provide custom interfaces. More...
Defines
#define	kOfxInteractSuite   "OfxInteractSuite"
#define	kOfxInteractPropSlaveToParam   "OfxInteractPropSlaveToParam"
	The set of parameters on which a value change will trigger a redraw for an interact.
#define	kOfxInteractPropPixelScale   "OfxInteractPropPixelScale"
	The size of a real screen pixel under the interact's cannonical projection.
#define	kOfxInteractPropViewportSize   "OfxInteractPropViewport"
	The size of an interact's openGL viewport.
#define	kOfxInteractPropBackgroundColour   "OfxInteractPropBackgroundColour"
	The background colour of the application behind an interact instance.
#define	kOfxInteractPropSuggestedColour   "OfxInteractPropSuggestedColour"
	The suggested colour to draw a widget in an interact, typically for overlays.
#define	kOfxInteractPropPenPosition   "OfxInteractPropPenPosition"
	The position of the pen in an interact.
#define	kOfxInteractPropPenViewportPosition   "OfxInteractPropPenViewportPosition"
	The position of the pen in an interact in viewport coordinates.
#define	kOfxInteractPropPenPressure   "OfxInteractPropPenPressure"
	The pressure of the pen in an interact.
#define	kOfxInteractPropBitDepth   "OfxInteractPropBitDepth"
	Indicates whether the dits per component in the interact's openGL frame buffer.
#define	kOfxInteractPropHasAlpha   "OfxInteractPropHasAlpha"
	Indicates whether the interact's frame buffer has an alpha component or not.
#define	kOfxInteractActionDraw   "OfxInteractActionDraw"
	Action passed to interacts telling it to redraw, see InteractsActionDraw for more details.
#define	kOfxInteractActionPenMotion   "OfxInteractActionPenMotion"
	Action passed to interacts for an interact pen motion , see InteractsActionPen for more details.
#define	kOfxInteractActionPenDown   "OfxInteractActionPenDown"
	Action passed to interacts for a pen down , see InteractsActionPen for more details.
#define	kOfxInteractActionPenUp   "OfxInteractActionPenUp"
	Action passed to interacts for a pen up, see InteractsActionPen for more details.
#define	kOfxInteractActionKeyDown   "OfxInteractActionKeyDown"
	Action passed to interacts for a key down, see InteractsActionKey for more details.
#define	kOfxInteractActionKeyUp   "OfxInteractActionKeyUp"
	Action passed to interacts for a key down, see InteractsActionKey for more details.
#define	kOfxInteractActionKeyRepeat   "OfxInteractActionKeyRepeat"
	Action passed to interacts for a key repeat , see InteractsActionKey for more details.
#define	kOfxInteractActionGainFocus   "OfxInteractActionGainFocus"
	Action passed to interacts for a gain of input focus, see InteractsActionFocus for more details.
#define	kOfxInteractActionLoseFocus   "OfxInteractActionLoseFocus"
	Action passed to interacts for a loss of input focus, see InteractsActionFocus for more details.
Typedefs
typedef struct OfxInteract *	OfxInteractHandle
	Blind declaration of an OFX interactive gui.
typedef struct OfxInteractSuiteV1	OfxInteractSuiteV1
	OFX suite that allows an effect to interact with an openGL window so as to provide custom interfaces.

---

Detailed Description

Contains the API for ofx plugin defined GUIs and interaction.

Definition in file ofxInteract.h.

---

Define Documentation

#define kOfxInteractSuite   "OfxInteractSuite"

Definition at line 43 of file ofxInteract.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectHost::fetchSuite(), and OFX::Private::loadAction().

---

Typedef Documentation

typedef struct OfxInteract* OfxInteractHandle

Blind declaration of an OFX interactive gui.

Definition at line 48 of file ofxInteract.h.

typedef struct OfxInteractSuiteV1 OfxInteractSuiteV1

OFX suite that allows an effect to interact with an openGL window so as to provide custom interfaces.