Struct fpsdk::ProcessParamFlags

pub struct ProcessParamFlags { /* fields omitted */ }

Processing parameters flags.

Implementations

impl ProcessParamFlags

pub const UPDATE_VALUE: ProcessParamFlags

Update the value of the parameter.

pub const GET_VALUE: ProcessParamFlags

Return the value of the parameter as the result of the function.

pub const SHOW_HINT: ProcessParamFlags

Update the hint if there is one.

pub const UPDATE_CONTROL: ProcessParamFlags

Update the parameter control (wheel, slider, ...).

pub const FROM_MIDI: ProcessParamFlags

A value between 0 and 65536 has to be translated to the range of the parameter control.

Note that you should also return the translated value, even if ProcessParamFlags::GET_VALUE isn't included.

pub const NO_LINK: ProcessParamFlags

(internal) Don't check if wheels are linked.

pub const INTERNAL_CTRL: ProcessParamFlags

Sent by an internal controller. Internal controllers should pay attention to these, to avoid Feedback of controller changes.

pub const PLUG_RESERVED: ProcessParamFlags

This flag is free to be used by the plugin as it wishes.

pub const fn empty() -> ProcessParamFlags

Returns an empty set of flags

pub const fn all() -> ProcessParamFlags

Returns the set containing all flags.

pub const fn bits(&self) -> isize

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: isize) -> Option<ProcessParamFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: isize) -> ProcessParamFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: isize) -> ProcessParamFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: ProcessParamFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: ProcessParamFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: ProcessParamFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: ProcessParamFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: ProcessParamFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: ProcessParamFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for ProcessParamFlags

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

Formats the value using the given formatter.

impl BitAnd<ProcessParamFlags> for ProcessParamFlags

type Output = ProcessParamFlags

The resulting type after applying the & operator.

fn bitand(self, other: ProcessParamFlags) -> ProcessParamFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<ProcessParamFlags> for ProcessParamFlags

fn bitand_assign(&mut self, other: ProcessParamFlags)

Disables all flags disabled in the set.

impl BitOr<ProcessParamFlags> for ProcessParamFlags

type Output = ProcessParamFlags

The resulting type after applying the | operator.

fn bitor(self, other: ProcessParamFlags) -> ProcessParamFlags

Returns the union of the two sets of flags.

impl BitOrAssign<ProcessParamFlags> for ProcessParamFlags

fn bitor_assign(&mut self, other: ProcessParamFlags)

Adds the set of flags.

impl BitXor<ProcessParamFlags> for ProcessParamFlags

type Output = ProcessParamFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: ProcessParamFlags) -> ProcessParamFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<ProcessParamFlags> for ProcessParamFlags

fn bitxor_assign(&mut self, other: ProcessParamFlags)

Toggles the set of flags.

impl Clone for ProcessParamFlags

fn clone(&self) -> ProcessParamFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ProcessParamFlags

impl Debug for ProcessParamFlags

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

Formats the value using the given formatter.

impl Eq for ProcessParamFlags

impl Extend<ProcessParamFlags> for ProcessParamFlags

fn extend<T: IntoIterator<Item = ProcessParamFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<ProcessParamFlags> for ProcessParamFlags

fn from_iter<T: IntoIterator<Item = ProcessParamFlags>>(
    iterator: T
) -> ProcessParamFlags

Creates a value from an iterator.

impl Hash for ProcessParamFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for ProcessParamFlags

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

Formats the value using the given formatter.

impl Not for ProcessParamFlags

type Output = ProcessParamFlags

The resulting type after applying the ! operator.

fn not(self) -> ProcessParamFlags

Returns the complement of this set of flags.

impl Octal for ProcessParamFlags

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

Formats the value using the given formatter.

impl Ord for ProcessParamFlags

fn cmp(&self, other: &ProcessParamFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ProcessParamFlags> for ProcessParamFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<ProcessParamFlags> for ProcessParamFlags

fn partial_cmp(&self, other: &ProcessParamFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ProcessParamFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ProcessParamFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ProcessParamFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ProcessParamFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ProcessParamFlags

impl StructuralPartialEq for ProcessParamFlags

impl Sub<ProcessParamFlags> for ProcessParamFlags

type Output = ProcessParamFlags

The resulting type after applying the - operator.

fn sub(self, other: ProcessParamFlags) -> ProcessParamFlags

Returns the set difference of the two sets of flags.

impl SubAssign<ProcessParamFlags> for ProcessParamFlags

fn sub_assign(&mut self, other: ProcessParamFlags)

Disables all flags enabled in the set.

impl UpperHex for ProcessParamFlags

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

Formats the value using the given formatter.