Mirrors/rodio
2
0
Fork 0
mirror of https://github.com/RustAudio/rodio synced 2024-12-13 21:52:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

Moved "noise" feature documentation

Browse source 
...into the previous "Optional Features" block
This commit is contained in:
Jamie Hardt 2024-09-29 16:02:07 -07:00
parent 09c5f31435
commit b373f5253a
1 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/lib.rs
View file

@ -110,6 +110,11 @@
//! The "tracing" feature replaces the print to stderr when a stream error happens with a //! The "tracing" feature replaces the print to stderr when a stream error happens with a
//! recording an error event with tracing. //! recording an error event with tracing.
//! //!
//! ### Feature "Noise"
//!
//! The "noise" feature adds support for white and pink noise sources. This feature requires the
//! "rand" crate.
//!
//! ## How it works under the hood //! ## How it works under the hood
//! //!
//! Rodio spawns a background thread that is dedicated to reading from the sources and sending //! Rodio spawns a background thread that is dedicated to reading from the sources and sending
@ -121,15 +126,8 @@
//! the number of sinks that can be created (except for the fact that creating too many will slow //! the number of sinks that can be created (except for the fact that creating too many will slow
//! down your program). //! down your program).
//! //!
//!
//! ## Features
//!
//! Rodio provides several optional features that are guarded with feature gates.
//!
//! ### Feature "Noise"
//!
//! The "noise" feature adds support for white and pink noise sources. This feature requires the
//! "rand" crate.
#![cfg_attr(test, deny(missing_docs))] #![cfg_attr(test, deny(missing_docs))]
pub use cpal::{ pub use cpal::{
self, traits::DeviceTrait, Device, Devices, DevicesError, InputDevices, OutputDevices, self, traits::DeviceTrait, Device, Devices, DevicesError, InputDevices, OutputDevices,