Skip to content

Clarify bypass parameter count and process() behavior #510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abique merged 2 commits into from
Jul 9, 2026
Merged

Clarify bypass parameter count and process() behavior #510

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8754b4e
Clarify bypass parameter count
Schroedingers-Cat Jul 3, 2026
debc987
Clarify process() calling while bypassed
Schroedingers-Cat Jul 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions include/clap/ext/params.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,12 @@ enum {

// This parameter is used to merge the plugin and host bypass button.
// It implies that the parameter is stepped.
// Only zero or one bypass parameter is allowed per plugin.
// min: 0 -> bypass off
// max: 1 -> bypass on
// The value of this parameter should not influence whether the host calls plugin->process() or
// not. If a plugin wants to save CPU cycles during bypass, the plugin will implement that in its
// process() routine, possibly returning CLAP_PROCESS_SLEEP at some point.
CLAP_PARAM_IS_BYPASS = 1 << 4,

// When set:
Expand Down
Loading