Struct SoundDef 

#[non_exhaustive]
pub struct SoundDef {
    pub duration: ZeroOne<f32>,
    pub frequency: PositiveSign<f32>,
    pub amplitude: ZeroOne<f32>,
}

A sound effect or grain.

SoundDefs are used as members of Universes and may be referenced by … TODO document

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

duration: ZeroOne<f32>

The total duration of the sound, in seconds. It may not be longer than one second.

frequency: PositiveSign<f32>

The frequency of the oscillator, in hertz.

amplitude: ZeroOne<f32>

TODO: Define amplitude scaling. We probably need some physical reference because the obvious alternative, 0 dBFS, is a bad idea. But some sounds are spatial and some are not…perhaps “1 meter/cube away is the reference distance” will solve that.

Trait Implementations

impl Clone for SoundDef

fn clone(&self) -> SoundDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SoundDef

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for SoundDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SoundDef

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SoundDef

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

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 SoundDef

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Transactional for SoundDef

type Transaction = DefTransaction

The type of transaction which should be used with Self.

impl UTransactional for SoundDef

fn bind( target: Handle<Self>, transaction: Self::Transaction, ) -> UniverseTransaction

Specify the target of the transaction as a Handle, and erase its type, so that it can be combined with other transactions in the same universe.

impl UniverseMember for SoundDef

type Read<'ticket> = &'ticket SoundDef

Type returned by Handle::<T>::read() which is the way to read the T value after it has been inserted into the Universe.

impl VisitHandles for SoundDef

fn visit_handles(&self, _: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.

impl Eq for SoundDef

impl StructuralPartialEq for SoundDef