This is the Module to interact in a save way with the ArduboyTones C++ library. -You will need to uncomment the ArduboyTones_Library in the import_config.h file.
-This is the Module to interact in a save way with the ArduboyTones C++ library.
+You will need to uncomment the ArduboyTones_Library in the import_config.h file.
+pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library. -You will need to uncomment the ArduboyTones_Library in the import_config.h file.
-Get a new instance of ArduboyTones
+pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library.
+You will need to uncomment the ArduboyTones_Library in the import_config.h file.
+Play a single tone.
noTone() is called or a new tone or
sequence is started.Stop playing the tone or sequence.
If a tone or sequence is playing, it will stop. If nothing is playing, this function will do nothing.
-Check if a tone or tone sequence is playing.
true if playing (even if sound is muted).Play a tone sequence from frequency/duration pairs in an array in RAM.
+Play a tone sequence from frequency/duration pairs in an array in RAM.
Using tones(), with the data in PROGMEM, is normally a better
choice. The only reason to use tonesInRAM() would be if dynamically
altering the contents of the array is required.
Set the volume to always normal, always high, or tone controlled.
+Set the volume to always normal, always high, or tone controlled.
One of the following values should be used:
VOLUME_IN_TONE The volume of each tone will be specified in the tone
diff --git a/docs/doc/arduboy_rust/ardvoice/index.html b/docs/doc/arduboy_rust/ardvoice/index.html
index 8016f41..a18e260 100644
--- a/docs/doc/arduboy_rust/ardvoice/index.html
+++ b/docs/doc/arduboy_rust/ardvoice/index.html
@@ -1,4 +1,3 @@
-This is the Module to interact in a save way with the ArdVoice C++ library. -You will need to uncomment the ArdVoice_Library in the import_config.h file.
-This is the Module to interact in a save way with the ArdVoice C++ library.
+You will need to uncomment the ArdVoice_Library in the import_config.h file.
+pub struct ArdVoice {}This is the struct to interact in a save way with the ArdVoice C++ library. -You will need to uncomment the ArdVoice_Library in the import_config.h file.
-pub struct ArdVoice {}This is the struct to interact in a save way with the ArdVoice C++ library.
+You will need to uncomment the ArdVoice_Library in the import_config.h file.
+Returns the argument unchanged.
diff --git a/docs/doc/arduboy_rust/index.html b/docs/doc/arduboy_rust/index.html index 432e29e..5305fd6 100644 --- a/docs/doc/arduboy_rust/index.html +++ b/docs/doc/arduboy_rust/index.html @@ -18,8 +18,4 @@ Just comment the unused library definition out.To get an idea, the ArduboyTones Library needs additional 2-3% of the flash memory.
-static friendly data structures that don’t require dynamic memory allocationconst raw pointer to a ardvoice tone as u8, without creating an intermediate reference.const raw pointer to a sprite as u8, without creating an intermediate reference.const raw pointer to a [u8;_] that saves text, without creating an intermediate reference.const raw pointer to a tone sequenze as u16, without creating an intermediate reference.static friendly data structures that don’t require dynamic memory allocationconst raw pointer to a ardvoice tone as u8, without creating an intermediate reference.const raw pointer to a sprite as u8, without creating an intermediate reference.const raw pointer to a [u8;_] that saves text, without creating an intermediate reference.const raw pointer to a tone sequenze as u16, without creating an intermediate reference.This is the Module to interact in a save way with the ArduboyTones C++ library. -You will need to uncomment the ArduboyTones_Library in the import_config.h file.
-This is the Module to interact in a save way with the ArduboyTones C++ library.
+You will need to uncomment the ArduboyTones_Library in the import_config.h file.
+pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library. -You will need to uncomment the ArduboyTones_Library in the import_config.h file.
-Get a new instance of ArduboyTones
+pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library.
+You will need to uncomment the ArduboyTones_Library in the import_config.h file.
+Play a single tone.
noTone() is called or a new tone or
sequence is started.Stop playing the tone or sequence.
If a tone or sequence is playing, it will stop. If nothing is playing, this function will do nothing.
-Check if a tone or tone sequence is playing.
true if playing (even if sound is muted).Play a tone sequence from frequency/duration pairs in an array in RAM.
+Play a tone sequence from frequency/duration pairs in an array in RAM.
Using tones(), with the data in PROGMEM, is normally a better
choice. The only reason to use tonesInRAM() would be if dynamically
altering the contents of the array is required.
Set the volume to always normal, always high, or tone controlled.
+Set the volume to always normal, always high, or tone controlled.
One of the following values should be used:
VOLUME_IN_TONE The volume of each tone will be specified in the tone
diff --git a/docs/doc/arduboy_rust/prelude/index.html b/docs/doc/arduboy_rust/prelude/index.html
index cd69459..0e1e540 100644
--- a/docs/doc/arduboy_rust/prelude/index.html
+++ b/docs/doc/arduboy_rust/prelude/index.html
@@ -2,10 +2,7 @@
Import the module:
use arduboy_rust::prelude::*;const raw pointer to a ardvoice tone as u8, without creating an intermediate reference.const raw pointer to a sprite as u8, without creating an intermediate reference.const raw pointer to a [u8;_] that saves text, without creating an intermediate reference.const raw pointer to a tone sequenze as u16, without creating an intermediate reference.const raw pointer to a ardvoice tone as u8, without creating an intermediate reference.const raw pointer to a sprite as u8, without creating an intermediate reference.const raw pointer to a [u8;_] that saves text, without creating an intermediate reference.const raw pointer to a tone sequenze as u16, without creating an intermediate reference.StringVecconst for the A buttonconst for the A buttonconst for the B buttonconst for the blue ledconst for the B buttonconst for the DOWN buttonconst for the DOWN buttonconst for the green ledconst for the LEFT buttonconst for the LEFT buttonconst for the red ledconst for led offconst for led onconst for the RIGHT buttonconst for the RIGHT buttonconst for the UP buttonconst for the UP buttonsize_t type, from stddef.h (or cstddef for C++).char type.double type.float type.signed int (int) type.signed long (long) type.signed long long (long long) type.unsigned char type.unsigned int type.unsigned long type.unsigned long long type.pub struct ArdVoice {}This is the struct to interact in a save way with the ArdVoice C++ library. -You will need to uncomment the ArdVoice_Library in the import_config.h file.
-pub struct ArdVoice {}This is the struct to interact in a save way with the ArdVoice C++ library.
+You will need to uncomment the ArdVoice_Library in the import_config.h file.
+Returns the argument unchanged.
diff --git a/docs/doc/arduboy_rust/prelude/struct.ArduboyTones.html b/docs/doc/arduboy_rust/prelude/struct.ArduboyTones.html index b3f579a..9180280 100644 --- a/docs/doc/arduboy_rust/prelude/struct.ArduboyTones.html +++ b/docs/doc/arduboy_rust/prelude/struct.ArduboyTones.html @@ -1,9 +1,9 @@ -pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library. -You will need to uncomment the ArduboyTones_Library in the import_config.h file.
-Get a new instance of ArduboyTones
+pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library.
+You will need to uncomment the ArduboyTones_Library in the import_config.h file.
+Play a single tone.
noTone() is called or a new tone or
sequence is started.Stop playing the tone or sequence.
If a tone or sequence is playing, it will stop. If nothing is playing, this function will do nothing.
-Check if a tone or tone sequence is playing.
true if playing (even if sound is muted).Play a tone sequence from frequency/duration pairs in an array in RAM.
+Play a tone sequence from frequency/duration pairs in an array in RAM.
Using tones(), with the data in PROGMEM, is normally a better
choice. The only reason to use tonesInRAM() would be if dynamically
altering the contents of the array is required.
Set the volume to always normal, always high, or tone controlled.
+Set the volume to always normal, always high, or tone controlled.
One of the following values should be used:
VOLUME_IN_TONE The volume of each tone will be specified in the tone
diff --git a/docs/doc/arduboy_rust/struct.ArdVoice.html b/docs/doc/arduboy_rust/struct.ArdVoice.html
index b12b136..c85d6da 100644
--- a/docs/doc/arduboy_rust/struct.ArdVoice.html
+++ b/docs/doc/arduboy_rust/struct.ArdVoice.html
@@ -1,12 +1,12 @@
-pub struct ArdVoice {}This is the struct to interact in a save way with the ArdVoice C++ library. -You will need to uncomment the ArdVoice_Library in the import_config.h file.
-pub struct ArdVoice {}This is the struct to interact in a save way with the ArdVoice C++ library.
+You will need to uncomment the ArdVoice_Library in the import_config.h file.
+Returns the argument unchanged.
diff --git a/docs/doc/arduboy_rust/struct.ArduboyTones.html b/docs/doc/arduboy_rust/struct.ArduboyTones.html index c6dabc6..a28542a 100644 --- a/docs/doc/arduboy_rust/struct.ArduboyTones.html +++ b/docs/doc/arduboy_rust/struct.ArduboyTones.html @@ -1,9 +1,9 @@ -pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library. -You will need to uncomment the ArduboyTones_Library in the import_config.h file.
-Get a new instance of ArduboyTones
+pub struct ArduboyTones {}This is the struct to interact in a save way with the ArduboyTones C++ library.
+You will need to uncomment the ArduboyTones_Library in the import_config.h file.
+Play a single tone.
noTone() is called or a new tone or
sequence is started.Stop playing the tone or sequence.
If a tone or sequence is playing, it will stop. If nothing is playing, this function will do nothing.
-Check if a tone or tone sequence is playing.
true if playing (even if sound is muted).Play a tone sequence from frequency/duration pairs in an array in RAM.
+Play a tone sequence from frequency/duration pairs in an array in RAM.
Using tones(), with the data in PROGMEM, is normally a better
choice. The only reason to use tonesInRAM() would be if dynamically
altering the contents of the array is required.
Set the volume to always normal, always high, or tone controlled.
+Set the volume to always normal, always high, or tone controlled.
One of the following values should be used:
VOLUME_IN_TONE The volume of each tone will be specified in the tone
diff --git a/docs/doc/src/arduboy_rust/library/arduboy_tone.rs.html b/docs/doc/src/arduboy_rust/library/arduboy_tone.rs.html
index 3177a52..dbc8cf8 100644
--- a/docs/doc/src/arduboy_rust/library/arduboy_tone.rs.html
+++ b/docs/doc/src/arduboy_rust/library/arduboy_tone.rs.html
@@ -148,7 +148,10 @@
148
149
150
+151
+152
//!This is the Module to interact in a save way with the ArduboyTones C++ library.
+//!
//! You will need to uncomment the ArduboyTones_Library in the import_config.h file.
pub use crate::library::arduboy_tone_pitch;
use core::ffi::{c_uchar, c_uint, c_ulong};
@@ -184,6 +187,7 @@
}
///This is the struct to interact in a save way with the ArduboyTones C++ library.
+///
/// You will need to uncomment the ArduboyTones_Library in the import_config.h file.
pub struct ArduboyTones {}
impl ArduboyTones {
diff --git a/docs/doc/src/arduboy_rust/library/ardvoice.rs.html b/docs/doc/src/arduboy_rust/library/ardvoice.rs.html
index 337f096..8ec2147 100644
--- a/docs/doc/src/arduboy_rust/library/ardvoice.rs.html
+++ b/docs/doc/src/arduboy_rust/library/ardvoice.rs.html
@@ -38,7 +38,10 @@
38
39
40
+41
+42
//! This is the Module to interact in a save way with the ArdVoice C++ library.
+//!
//! You will need to uncomment the ArdVoice_Library in the import_config.h file.
use core::ffi::{c_float, c_uchar, c_ulong};
@@ -59,6 +62,7 @@
fn ardvoice_is_voice_playing_raw() -> bool;
}
///This is the struct to interact in a save way with the ArdVoice C++ library.
+///
///You will need to uncomment the ArdVoice_Library in the import_config.h file.
pub struct ArdVoice {}
impl ArdVoice {