AcademySoftwareFoundation / AcademySoftwareFoundation/openfx
Missing header file note ofxOpenGLRender.h
- Dominant language
- C++
- Stars
- 570
- Forks
- 152
- Avg merge
- 5m
- Merged PRs (30d)
- 2
Description
http://openeffects.org/standard_changes/modifying-plugin-properties-after-description
states that a plugin instance can change the Enable state in Instance Changed with the following precaution advised for plugins that do so:
"
When setting to true we also do this (assuming it's not set):
// we support all the OpenGL bit depths
gPropHost->propSetString(effectProps, kOfxOpenGLPropPixelDepth, 0, kOfxBitDepthByte);
gPropHost->propSetString(effectProps, kOfxOpenGLPropPixelDepth, 1, kOfxBitDepthShort);
gPropHost->propSetString(effectProps, kOfxOpenGLPropPixelDepth, 2, kOfxBitDepthFloat);
gPropHost->propSetString(effectProps, kOfxOpenGLPropPixelDepth, 3, kOfxBitDepthHalf );
"
Contributor guide
Research direction
Start with the missing note requested for ofxOpenGLRender.h and compare it with the linked OpenFX standard change guidance. Document the precaution about setting the OpenGL pixel-depth properties when enabling a plugin instance; done means the relevant header contains that guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api, computer-graphics, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100