From 6c649fd2bdc69820d1f5d9361a2a49e60ff46153 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Devernay?= Date: Sun, 15 May 2016 10:38:11 +0200 Subject: [PATCH] overlay cursors: clarification see https://github.com/devernay/openfx/issues/4 --- include/ofxNatron.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/include/ofxNatron.h b/include/ofxNatron.h index dc61859f9..768891235 100644 --- a/include/ofxNatron.h +++ b/include/ofxNatron.h @@ -481,6 +481,7 @@ This is a property on parameters of type ::kOfxParamTypeChoice, and tells the ch The property kNatronOfxImageEffectSelectionRectangle will be updated prior to calling the kOfxActionInstanceChanged action for this parameter by the host, indicating the region covered by the selection rectangle. 8) The host application cursor can be controled by the plug-in via a secret String parameter with the name kNatronOfxParamCursorName. If this parameter is found, the host should display a cursor depending on the value of this parameter. The value of the parameter should be the name of the cursor. Several default cursor can be made available by the host as advertised by the kNatronOfxImageEffectPropDefaultCursors property. + Whenever an event is sent to overlay interacts (PenDown, PenMotion, PenUp, KeyDown, KeyUp, KeyRepeat, GainFocus, LoseFocus, the OFX Host should set the cursor to the one of the first interact which catches the event by returning kOfxStatOK to the corresponding action. If no overlay interact returns kOfxStatOK, the cursor should be set to the default cursor. */ @@ -521,6 +522,9 @@ This is a property on parameters of type ::kOfxParamTypeChoice, and tells the ch The special value of kNatronOfxDefaultCursor means that the host should keep the default cursor. The special value of kNatronOfxBlankCursor means that the host should not draw any cursor at all. + + Whenever an event is sent to overlay interacts (PenDown, PenMotion, PenUp, KeyDown, KeyUp, KeyRepeat, GainFocus, LoseFocus, the OFX Host should set the cursor to the one of the first interact which catches the event by returning kOfxStatOK to the corresponding action. If no overlay interact returns kOfxStatOK, the cursor should be set to the default cursor. + */ #define kNatronOfxImageEffectPropDefaultCursors "NatronOfxImageEffectPropDefaultCursors"