openframeworks / openframeworks/openFrameworks
Make "getId" type function naming consistent.
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
There is a lot of mixing of getId and getID. Arguments could be made for either, but we should be consistent.
Examples:
Here: https://github.com/openframeworks/openFrameworks/issues/3780
GLuint ofBufferObject::getId() const;
GLuint VertexAttribute::getId() const;
GLuint IndexAttributegetId() const;
const GLuint& ofBaseGLRenderer::getCurrentFramebufferId() const; and sub-classes.
int ofLight::getLightID() const;
ofSoundDevice::deviceID
int ofBaseSoundStream::getDeviceID() const = 0;
unsigned int ofSoundBuffer::getDeviceID() const;
void ofBaseVideoGrabber::setDeviceID(int _deviceID); and sub-classes.
int ofThread::getThreadId() const;
ofQTKitGrabber::getDeviceID();
ofQTKitGrabber::getVideoDeviceID();
ofQTKitGrabber::getAudioDeviceID();
int ofRtAudioSoundStream::getDeviceID() const
int ofSerialDeviceInfo::getDeviceID();
GLuint getVaoId() const;
GLuint getVertId() const;
GLuint getColorId() const;
GLuint getNormalId() const;
GLuint getTexCoordId() const;
GLuint getIndexId() const;
/// returns OpenGL memory object id for GL buffer holding attribute data
GLuint getAttributeId(int AttrPos_) const;
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing issue 3780 and the listed declarations, including ofBufferObject::getId(), ofLight::getLightID(), and the getDeviceID variants. Search the C++ sources for getId and getID usages to determine the scope and affected callers. Done means the chosen naming convention is applied consistently without leaving the listed variants unresolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100