Enum RescanFlags

#[repr(u32)]
pub enum RescanFlags {
    Values = 1,
    Text = 2,
    Info = 4,
    All = 8,
}

Variants

Values = 1

The parameter values did change, e.g. after loading a preset. The host will scan all the parameters value. The host will not record those changes as automation points. New values takes effect immediately.

Text = 2

The value to text conversion changed, and the text needs to be rendered again.

Info = 4

The parameter info did change, use this flag for:

• name change
• module change
• is_periodic (flag)
• is_hidden (flag)

New info takes effect immediately.

All = 8

Invalidates everything the host knows about parameters. It can only be used while the plugin is deactivated. If the plugin is activated use clap_host->restart() and delay any change until the host calls clap_plugin->deactivate().

You must use this flag if:

• some parameters were added or removed.
• some parameters had critical changes:
  • is_per_note (flag)
  • is_per_key (flag)
  • is_per_channel (flag)
  • is_per_port (flag)
  • is_readonly (flag)
  • is_bypass (flag)
  • is_stepped (flag)
  • is_modulatable (flag)
  • min_value
  • max_value
  • cookie

Implementations

impl RescanFlags

pub const fn set(&self, flags: u32) -> u32

pub const fn is_set(&self, flags: u32) -> bool

pub const fn clear(&self, flags: u32) -> u32

Trait Implementations

impl Clone for RescanFlags

fn clone(&self) -> RescanFlags

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RescanFlags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<RescanFlags> for u32

fn from(value: RescanFlags) -> Self

Converts to this type from the input type.

impl PartialEq for RescanFlags

fn eq(&self, other: &RescanFlags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RescanFlags

impl Eq for RescanFlags

impl StructuralPartialEq for RescanFlags