Browse Source

Add documentation to Port::setChannels().

tags/v1.0.0
Andrew Belt 5 years ago
parent
commit
31ee9bdfc7
1 changed files with 5 additions and 1 deletions
  1. +5
    -1
      include/engine/Port.hpp

+ 5
- 1
include/engine/Port.hpp View File

@@ -92,7 +92,11 @@ struct alignas(32) Port {
return sum; return sum;
} }


/** Sets the number of polyphony channels. */
/** Sets the number of polyphony channels.
Also clears voltages of higher channels.
If disconnected, this does nothing (`channels` remains 0).
If 0 is given, `channels` is set to 1 but all voltages are cleared.
*/
void setChannels(int channels) { void setChannels(int channels) {
// If disconnected, keep the number of channels at 0. // If disconnected, keep the number of channels at 0.
if (this->channels == 0) { if (this->channels == 0) {


Loading…
Cancel
Save