Struct UiSounds 

pub struct UiSounds {
    pub open: Option<String>,
    pub close: Option<String>,
    pub navigate: Option<String>,
    pub wrap: Option<String>,
    pub activate: Option<String>,
    pub edge: Option<String>,
    pub change: Option<String>,
    pub typing: Option<String>,
}

Which sound to play for each UiSound. Each entry is a sound name as accepted by Audio::play; None means silence.

The default is UiSounds::builtin: small generated clicks that work without any files.

use audio_code::ui::{UiSound, UiSounds};

// Built-in sounds, but your own file for moving through menus and no "edge" sound.
let sounds = UiSounds::builtin()
    .with(UiSound::Navigate, "ui/my_click")
    .without(UiSound::Edge);

To design a click in code instead of using a file, see Ui::set_sound_data.

Fields

open: Option<String>

Played when a widget opens.

close: Option<String>

Played when the player closes a widget.

navigate: Option<String>

Played when moving between items.

wrap: Option<String>

Played when wrapping around in a menu (falls back to navigate).

activate: Option<String>

Played when a button is pressed.

edge: Option<String>

Played at the first or last item.

change: Option<String>

Played when a value changes.

typing: Option<String>

Played for each typed or deleted character.

Implementations

impl UiSounds

pub fn builtin() -> Self

Generated sounds that need no files. Typing is silent.

pub fn none() -> Self

No sounds at all.

pub fn from_folder(folder: &str) -> Self

Loads sounds by convention from a folder: open, close, navigate, wrap, activate, edge, change and typing (any supported extension) inside folder. Missing files fall back to silence with a warning on first use; use UiSounds::without for slots you do not have a file for.

pub fn with(self, kind: UiSound, name: impl Into<String>) -> Self

Returns a copy that plays sound name for kind.

pub fn without(self, kind: UiSound) -> Self

Returns a copy that is silent for kind.

pub fn set(&mut self, kind: UiSound, name: Option<String>)

Changes the sound for kind (None = silent).

pub fn get(&self, kind: UiSound) -> Option<&str>

The sound name for a moment, if any.

Trait Implementations

impl Clone for UiSounds

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UiSounds

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

Formats the value using the given formatter.

impl Default for UiSounds

fn default() -> Self

Returns the “default value” for a type.

impl Eq for UiSounds

impl PartialEq for UiSounds

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UiSounds