From f9b54bb5052b18102e190392c147f3f2754e084a Mon Sep 17 00:00:00 2001 From: Breval Ferrari Date: Wed, 19 Mar 2025 01:28:56 -0400 Subject: [PATCH] update doc for Audio (changed specs) --- bingus/src/snd/simphonia.rs | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/bingus/src/snd/simphonia.rs b/bingus/src/snd/simphonia.rs index c1ab65e..3c03847 100644 --- a/bingus/src/snd/simphonia.rs +++ b/bingus/src/snd/simphonia.rs @@ -23,9 +23,10 @@ use crate::IntoDataBytes; use super::{RawSamples, Sample}; -/// The new hot thing: this represents audio in any format. You can open any file and make this thing with the file's bytes. -/// You can then modify its bytes and see what it gives. Maybe it won't work anymore. -/// You can also decode it to raw samples and play with it freely without corrupting anything. +/// Audio, unlike DynamicImage, isn't directly bendable +/// because its underlying data format isn't decided automatically +/// so you have to attribute it yourself by turning it into a [RawSamples] struct +/// with your chosen sample format. #[derive(new)] pub struct Audio { reader: Box,