ofxInteract.h File Reference


Detailed Description

Contains the API for ofx plugin defined GUIs and interaction.

#include "ofxCore.h"

Go to the source code of this file.

Classes

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 kOfxInteractPropPenPosition   "OfxInteractPropPenPosition"
 The position of the pen in an interact.
#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.


Define Documentation

#define kOfxInteractSuite   "OfxInteractSuite"


Typedef Documentation

typedef struct OfxInteract* OfxInteractHandle

Blind declaration of an OFX interactive gui.


Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.