kOfxInteractActionKeyUp

kOfxInteractActionKeyUp
Prev	Chapter 14. Actions Passed to an Interact	Next

kOfxInteractActionKeyUp

	#include "ofxCore.h"
	#define kOfxInteractActionKeyUp "OfxInteractActionKeyUp"

Arguments

handle handle to an interact instance, cast to an OfxInteractHandle
inArgs has the following properties on an image effect plugin,
- kOfxPropEffectInstance - a handle to the effect for which the interact has been,
- kOfxPropKeySym - single integer value representing the key that was manipulated, this may not have a UTF8 representation (eg: a return key)
- kOfxPropKeyString - UTF8 string representing a character key that was pressed, some keys have no UTF8 encoding, in which case this is ""
- kOfxPropTime - the effect time at which changed occured
- kOfxImageEffectPropRenderScale - the render scale applied to any image fetched
outArgs is redundant and is set to NULL.

Description

This action is issued when a key on the keyboard is released.

No openGL calls should be issued by the plug-in during this action.

Preconditions

kOfxActionCreateInstance has been called on the instance handle,
the current instance handle has had kOfxInteractActionGainFocus called on it

Postconditions

if the instance returns kOfxStatOK , the host should not pass the pen motion to any other interactive object it may own that shares the same focus.

Return Values

kOfxStatOK , the action was trapped and the host should not pass the event to other objects it may own
kOfxStatReplyDefault , the action was not trapped and the host can deal with it if it wants

Prev	Up	Next
kOfxInteractActionKeyDown	Home	kOfxInteractActionKeyRepeat