Some naming rationalization and audioenigne.cpp cleanup - #1176
Open
BuzzBurrowes wants to merge 1 commit into
Open
Some naming rationalization and audioenigne.cpp cleanup#1176BuzzBurrowes wants to merge 1 commit into
BuzzBurrowes wants to merge 1 commit into
Conversation
In preparation for the more significant changes to support multithreaded rendering, this step rationalizes some naming to make the code a little more understandable for those new to it, and cleans up a few things. For example, audioengine.cpp referred to the 'current' graph (in members like "currentGraph"), while much of the rest of the code referred to the 'active' graph. Active seem better and more widely used, so I changes instances of 'current' to 'active'. This also reduces confusion when you see a variable named 'current' inside a large loop block and can easily mistake that name for meaning 'the current graph being processed in this iteration' as opposed to 'the active graph selected by the user'. 'last' has a similar problem. Last in the current iteration? last in the vector of graphs? So... 'currentGraph' became 'activeGraphIndex' 'lastGraph' became 'priorActiveGraphIndex' To my mind those are a little better to follow through the code. And later, when I issue a pull request for the much more complicated changes that implement multithreaded rendering, I think changes like this will make that code easier to grok.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
In preparation for the more significant changes to support multithreaded rendering, this step rationalizes some naming to make the code a little more understandable for those new to it, and cleans up a few things.
For example, audioengine.cpp referred to the 'current' graph (in members like "currentGraph"), while much of the rest of the code referred to the 'active' graph. Active seems better and more widely used, so I changes instances of 'current' to 'active'. This also reduces confusion when you see a variable named 'current' inside a large loop block and can easily mistake that name for meaning 'the current graph being processed in this iteration' as opposed to 'the active graph selected by the user'.
'last' has a similar problem. Last in the current iteration? last in the vector of graphs?
So...
'currentGraph' became 'activeGraphIndex'
'lastGraph' became 'priorActiveGraphIndex'
To my mind those are a little better to follow through the code. And later, when I issue a pull request for the much more complicated changes that implement multithreaded rendering, I think changes like this will make that code easier to grok.