Struct ittech::ModuleFlags

pub struct ModuleFlags { /* fields omitted */ }

Implementations

impl ModuleFlags

pub const STEREO: ModuleFlags

On = Stereo, Off = Mono

pub const VOL_0_MIX_OPTIMIZATIONS: ModuleFlags

If on, no mixing occurs if the volume at mixing time is 0 (redundant v1.04+)

pub const USE_INSTRUMENTS: ModuleFlags

On = Use instruments, Off = Use samples

pub const LINEAR_SLIDES: ModuleFlags

On = Linear slides, Off = Amiga slides

pub const OLD_EFFECTS: ModuleFlags

On = Old Effects, Off = IT Effects Differences:

• Vibrato is updated EVERY frame in IT mode, whereas it is updated every non-row frame in other formats. Also, it is two times deeper with Old Effects ON.
• Command Oxx will set the sample offset to the END of a sample instead of ignoring the command under old effects mode.
• (More to come, probably)

pub const LINK_G_E_EFFECTS: ModuleFlags

On = Link Effect G's memory with Effect E/F. Also Gxx with an instrument present will cause the envelopes to be retriggered. If you change a sample on a row with Gxx, it'll adjust the frequency of the current note according to:

NewFrequency = OldFrequency * NewC5 / OldC5;

pub const USE_MIDI_PITCH: ModuleFlags

Use MIDI pitch controller, Pitch depth given by PWD

pub const REQUEST_MIDI_CONFIG_EMBEDDED: ModuleFlags

Request embedded MIDI configuration (Coded this way to permit cross-version saving)

pub const MESSAGE_ATTACHED: ModuleFlags

On = song message attached. Song message: Stored at offset given by "Message Offset" field. Length = MsgLgth. NewLine = 0Dh (13 dec) EndOfMsg = 0

Note: v1.04+ of IT may have song messages of up to 8000 bytes included.

pub const MIDI_CONIFG_EMBEDDED: ModuleFlags

MIDI configuration embedded

pub const fn empty() -> ModuleFlags

Returns an empty set of flags

pub const fn all() -> ModuleFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<ModuleFlags>

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

pub const fn from_bits_truncate(bits: u32) -> ModuleFlags

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> ModuleFlags

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: ModuleFlags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for ModuleFlags

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

Formats the value using the given formatter.

impl BitAnd<ModuleFlags> for ModuleFlags

type Output = ModuleFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<ModuleFlags> for ModuleFlags

fn bitand_assign(&mut self, other: ModuleFlags)

Disables all flags disabled in the set.

impl BitOr<ModuleFlags> for ModuleFlags

type Output = ModuleFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<ModuleFlags> for ModuleFlags

fn bitor_assign(&mut self, other: ModuleFlags)

Adds the set of flags.

impl BitXor<ModuleFlags> for ModuleFlags

type Output = ModuleFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<ModuleFlags> for ModuleFlags

fn bitxor_assign(&mut self, other: ModuleFlags)

Toggles the set of flags.

impl Clone for ModuleFlags

fn clone(&self) -> ModuleFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ModuleFlags

impl Debug for ModuleFlags

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

Formats the value using the given formatter.

impl Eq for ModuleFlags

impl Extend<ModuleFlags> for ModuleFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<ModuleFlags> for ModuleFlags

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

Creates a value from an iterator.

impl Hash for ModuleFlags

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

Feeds this value into the given Hasher.

pub 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 ModuleFlags

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

Formats the value using the given formatter.

impl Not for ModuleFlags

type Output = ModuleFlags

The resulting type after applying the ! operator.

fn not(self) -> ModuleFlags

Returns the complement of this set of flags.

impl Octal for ModuleFlags

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

Formats the value using the given formatter.

impl Ord for ModuleFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ModuleFlags> for ModuleFlags

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

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

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

This method tests for !=.

impl PartialOrd<ModuleFlags> for ModuleFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for ModuleFlags

impl StructuralPartialEq for ModuleFlags

impl Sub<ModuleFlags> for ModuleFlags

type Output = ModuleFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<ModuleFlags> for ModuleFlags

fn sub_assign(&mut self, other: ModuleFlags)

Disables all flags enabled in the set.

impl UpperHex for ModuleFlags

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

Formats the value using the given formatter.