Struct arduboy_rust::arduboy2::Arduboy2
source · pub struct Arduboy2 {}Expand description
This is the struct to interact in a save way with the Arduboy2 C++ library.
-Implementations§
source§impl Arduboy2
impl Arduboy2
Implementations§
source§impl Arduboy2
impl Arduboy2
sourcepub fn begin(&self)
pub fn begin(&self)
Initialize the hardware, display the boot logo, provide boot utilities, etc. @@ -268,18 +268,20 @@ true if the first rectangle is intersecting the second.
The RGB LED is actually individual red, green and blue LEDs placed very close together in a single package. This 3 parameter version of the function will set each LED either on or off, to set the RGB LED to 7 different colors at their highest brightness or turn it off.
The colors are as follows:
- RED LED GREEN LED BLUE LED COLOR
- RGB_OFF RGB_OFF RGB_OFF OFF
- RGB_OFF RGB_OFF RGB_ON Blue
- RGB_OFF RGB_ON RGB_OFF Green
- RGB_OFF RGB_ON RGB_ON Cyan
- RGB_ON RGB_OFF RGB_OFF Red
- RGB_ON RGB_OFF RGB_ON Magenta
- RGB_ON RGB_ON RGB_OFF Yellow
- RGB_ON RGB_ON RGB_ON White
+ RED LED GREEN LED BLUE LED COLOR
+ RGB_OFF RGB_OFF RGB_OFF OFF
+ RGB_OFF RGB_OFF RGB_ON Blue
+ RGB_OFF RGB_ON RGB_OFF Green
+ RGB_OFF RGB_ON RGB_ON Cyan
+ RGB_ON RGB_OFF RGB_OFF Red
+ RGB_ON RGB_OFF RGB_ON Magenta
+ RGB_ON RGB_ON RGB_OFF Yellow
+ RGB_ON RGB_ON RGB_ON White
sourcepub fn every_x_frames(&self, frames: u8) -> bool
pub fn every_x_frames(&self, frames: u8) -> bool
Indicate if the specified number of frames has elapsed.
-Parameters -frames The desired number of elapsed frames.
+Parameters
+-
+
- frames The desired number of elapsed frames. +
Returns true if the specified number of frames has elapsed.
This function should be called with the same value each time for a given event. It will return true if the given number of frames has elapsed since the previous frame in which it returned true.
diff --git a/docs/doc/arduboy_rust/index.html b/docs/doc/arduboy_rust/index.html index 2fdae51..29b6aff 100644 --- a/docs/doc/arduboy_rust/index.html +++ b/docs/doc/arduboy_rust/index.html @@ -3,4 +3,4 @@ To get started import theuse arduboy_rust::prelude::*;Modules
- This is the Module to interact in a save way with the Arduboy2 C++ library.
- This is the Module to interact in a save way with the ArduboyTones C++ library.
- This is the Module to interact in a save way with the Arduino C++ library.
- Clib functions you can use on the Arduboy
- This is the Module to interact in a save way with the Arduboy hardware.
- This is the important one to use this library effective in your project
- This is the module to interact in a save way with the Sprites C++ library.
Macros
- This is the way to go if you want print some random text
- Create a
constraw pointer to a sprite as u8, without creating an intermediate reference. - Create a
constraw pointer to a [u8;_] that saves text, without creating an intermediate reference. - Create a
constraw pointer to a sprite as u16, without creating an intermediate reference. - Create a space for Progmem variable
Structs
- This is the struct to interact in a save way with the Arduboy2 C++ library.
- This is the struct to interact in a save way with the ArduboyTones C++ library.
- This struct to store and read structs objects to/from eeprom memory.
- Use this struct to store and read single bytes to/from eeprom memory.
Enums
- This item is to chose between Black or White
Constants
- The standard font size of the arduboy
- The standard height of the arduboy
- The standard width of the arduboy
Modules
- This is the Module to interact in a save way with the Arduboy2 C++ library.
- This is the Module to interact in a save way with the ArduboyTones C++ library.
- This is the Module to interact in a save way with the Arduino C++ library.
- Clib functions you can use on the Arduboy
- This is the Module to interact in a save way with the Arduboy hardware.
- This is the important one to use this library effective in your project
- This is the module to interact in a save way with the Sprites C++ library.
Macros
- This is the way to go if you want print some random text
- Create a
constraw pointer to a sprite as u8, without creating an intermediate reference. - Create a
constraw pointer to a [u8;_] that saves text, without creating an intermediate reference. - Create a
constraw pointer to a sprite as u16, without creating an intermediate reference. - Create a space for Progmem variable
Structs
- This is the struct to interact in a save way with the Arduboy2 C++ library.
- This is the struct to interact in a save way with the ArduboyTones C++ library.
- This is the struct to store and read structs objects to/from eeprom memory.
- Use this struct to store and read single bytes to/from eeprom memory.
Enums
- This item is to chose between Black or White
Constants
- The standard font size of the arduboy
- The standard height of the arduboy
- The standard width of the arduboy