Enum SetSampleOffset 

pub enum SetSampleOffset {
    Low(u8),
    High(RangedU8<0, 0x0F>),
}

Effects Oxx and SAy combined

The offset into the sample is represented in the number of samples, in hexadecimal 0xyxx00, where y is configured by SetSampleOffset::High and xx by SetSampleOffset::Low.

We’re not going to be handling memory with Options the type system like with other commands here because the handling is a bit inconsistent.

Recalling of the High part can be done using [EffectCmd::Set(None)] if it was the previously used Sxx command.

Recalling of the Low part can be done with EffectCmd::Offset(SetSampleOffset::Low(0x0)) this makes it impossible to use an offset of for example O00 + SA1 (0x10000), which the OpenMPT GUI happily hints at but then it doesn’t actually work in the player. O00 does recall the last value and it’s weirdly stateful in that even if you remove all the other instances of SAy and Oxx and play the pattern from the beginning it seems to remember the last offset.

We leave this encoded as a full range u8 and don’t treat the zero specially.

Variants

Low(u8)

High(RangedU8<0, 0x0F>)

Trait Implementations

impl Clone for SetSampleOffset

fn clone(&self) -> SetSampleOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetSampleOffset

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

Formats the value using the given formatter.

impl PartialEq for SetSampleOffset

fn eq(&self, other: &SetSampleOffset) -> 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 SetSampleOffset

impl StructuralPartialEq for SetSampleOffset