Enum AudioChannel 

#[repr(u8)]
pub enum AudioChannel {
    Music = 0,
    SFX = 1,
    Voice = 2,
    Ambience = 3,
    UI = 4,
    Custom(u8),
}

Audio channel enumeration for audio mixing and grouping.

Channels allow you to group audio sources together for volume control, filtering, and organization. Each audio source belongs to one channel.

Built-in Channels

• Music: Background music tracks (typically looped)
• SFX: Sound effects (footsteps, impacts, UI clicks)
• Voice: Voice-overs, dialogue, speech
• Ambience: Ambient environment sounds (wind, rain, room tone)
• UI: User interface sounds (button clicks, menu navigation)
• Custom: User-defined channels (bits 5-31)

Examples

use goud_engine::ecs::components::AudioChannel;

let music = AudioChannel::Music;
let sfx = AudioChannel::SFX;
let custom = AudioChannel::Custom(8); // Custom channel ID 8

assert_eq!(music.id(), 0);
assert_eq!(sfx.id(), 1);
assert_eq!(custom.id(), 8);

Variants

Music = 0

Background music tracks (channel ID: 0)

SFX = 1

Sound effects (channel ID: 1)

Voice = 2

Voice-overs and dialogue (channel ID: 2)

Ambience = 3

Ambient environment sounds (channel ID: 3)

UI = 4

User interface sounds (channel ID: 4)

Custom(u8)

Custom channel (ID 5-31)

Implementations

impl AudioChannel

pub fn id(&self) -> u8

Returns the numeric channel ID (0-31).

Examples

use goud_engine::ecs::components::AudioChannel;

assert_eq!(AudioChannel::Music.id(), 0);
assert_eq!(AudioChannel::SFX.id(), 1);
assert_eq!(AudioChannel::Custom(10).id(), 10);

pub fn name(&self) -> String

Returns the channel name for debugging.

Examples

use goud_engine::ecs::components::AudioChannel;

assert_eq!(AudioChannel::Music.name(), "Music");
assert_eq!(AudioChannel::SFX.name(), "SFX");
assert_eq!(AudioChannel::Custom(10).name(), "Custom(10)");

Trait Implementations

impl Clone for AudioChannel

fn clone(&self) -> AudioChannel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioChannel

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

Formats the value using the given formatter.

impl Default for AudioChannel

fn default() -> AudioChannel

Returns AudioChannel::SFX as the default.

impl<'de> Deserialize<'de> for AudioChannel

fn deserialize<__D>( __deserializer: __D, ) -> Result<AudioChannel, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AudioChannel

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

Formats the value using the given formatter.

impl Hash for AudioChannel

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AudioChannel

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AudioChannel

impl Eq for AudioChannel

impl StructuralPartialEq for AudioChannel