Update for accurate initialization and state management. #2
Conversation
This file contains 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
+ use a local variable in ramp generator function, not the member variable. + set read/write m_phase at head/tail of the block calc. + explicitly set current output value, then increment phase. + add comments.
and constrain to when UGen runs at *kr
+ includes header tags, example of teletype, complete sentences. + examples show a range of code useful for testing a broad scope of usage.
mtmccrea
force-pushed
the
fix-init-more-docs
branch
from
20dd96f
to
972bd51
Compare
|
Fantastic stuff. Thanks so much! |
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.
Great tutorial!
These proposed changes provide fixes and comments regarding handling the state variables, as well as fix the initialization of the UGen.
Some of the more important changes include:
0.phasein the calculation functions, rather than member variablem_phase0before, causing a ramp-up of the frequency from0toin0(Frequency)over the first block).schelpfile was updated to more fully utilize helpdoc syntax, fill out header metadata, and provide more examples that double as examples of snippets useful for testing UGens generally (e.g. checking behavior of different input rates)The tutorial itself has been updated to reflect these changes, and some elaboration was provided on certain topics, namely documentation, to encourage best practices.
Note: I didn't update the
.pdfor.epubfiles, in case some changes are rejected or further changes are made in response.