Doc fixes: clipGetRegionOfDefinition, Interacts #185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Gary Oberbrunner <[email protected]>
Add more info about the interaction between DrawSuite and Overlay Interacts, for clarity. Also clean up some doc around RegionOfInterest. Also update the Documentation README to include a lot more useful info. Signed-off-by: Gary Oberbrunner <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation clarity for plugin interactions and image effect behaviors. Key changes include:
- Updated ofxInteract.h to clearly differentiate between OverlayInteractV1 and OverlayInteractV2 drawing calls.
- Revised ofxImageEffect.h comments for clip actions and region definitions to improve clarity.
- Enhanced the Documentation README with detailed architecture and build process instructions.
Reviewed Changes
Copilot reviewed 4 out of 7 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| include/ofxInteract.h | Clarifies usage between OpenGL calls and DrawSuite based on OverlayInteract version. |
| include/ofxImageEffect.h | Refines doc text on clip actions, region of definition, and region of interest handling. |
| include/ofxDrawSuite.h | Adds a note indicating the required plugin property for proper DrawSuite usage. |
| Documentation/README.md | Expands build instructions and documentation architecture details. |
Files not reviewed (3)
- Documentation/sources/Guide/ofxExample5_Circle.rst: Language not supported
- Documentation/sources/Reference/ofxInteracts.rst: Language not supported
- Documentation/sources/Reference/ofxPropertiesReference.rst: Language not supported
| ``inArgs`` property set. All the RoIs in the ``outArgs`` property set | ||
| must initialised to this value before the action is called. | ||
|
|
||
| ``inArgs`` property set. The host must initalize all the RoIs in the ``outArgs`` property set |
There was a problem hiding this comment.
Consider correcting 'initalize' to 'initialize' to ensure proper spelling in the documentation.
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add more info about the interaction between DrawSuite and Overlay
Interacts, for clarity.
Also clean up some doc around RegionOfInterest.
Also update the Documentation README to include a lot more useful
info.