Struct sofiza::Region

pub struct Region {
    pub group: Option<usize>,
    pub opcodes: HashMap<String, Opcode>,
}

A Region is the basic component of an instrument. An instrument is defined by one or more regions.

A region starts with the header, and finishes with the next header, header, or the end of the file.

Following the header one or more opcodes can be defined. The opcodes are special keywords which instruct the player on what, when and how to play a sample.

Opcodes within a region can appear in any order, and they have to be separated by one or more spaces or tabulation controls. Opcodes can appear in separated lines within a region.

All Input Controls defined in a region act using the AND boolean operator. Consequently, all conditions must be matched for the region to play.

Fields

group: Option<usize>

The opcodes of this group are applied and will override the defaults.

opcodes: HashMap<String, Opcode>

This list of opcodes will override both the default and inherited opcodes.

Implementations

impl Region

pub fn new() -> Self

New region.

pub fn with_group(group: usize) -> Self

New region with some group.

pub fn add_opcode(&mut self, opcode: &Opcode)

Add an opcode to this Region

pub fn set_group(&mut self, group: Option<usize>)

Set the group of this Region

pub fn group(&self) -> Option<usize>

Get the group of this Region

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Region

Returns the “default value” for a type.