Browse Source

Add documentation to `engine::Module::ProcessArgs`

tags/v2.0.0
Andrew Belt 4 years ago
parent
commit
6285f3f222
1 changed files with 4 additions and 0 deletions
  1. +4
    -0
      include/engine/Module.hpp

+ 4
- 0
include/engine/Module.hpp View File

@@ -193,7 +193,11 @@ struct Module {
} }


struct ProcessArgs { struct ProcessArgs {
/** The current sample rate in Hz. */
float sampleRate; float sampleRate;
/** The timestep of process() in seconds.
Defined by `1 / sampleRate`.
*/
float sampleTime; float sampleTime;
}; };
/** Advances the module by one audio sample. /** Advances the module by one audio sample.


Loading…
Cancel
Save