From d3aff941ceecdf16c1ddcf91e2e860d649423379 Mon Sep 17 00:00:00 2001 From: ZennDev1337 Date: Mon, 9 Oct 2023 10:16:12 +0200 Subject: [PATCH] added all the examples for the FX library. changes in the Readme.md and updated the docs. --- .../arduboy_rust/arduboyfx/fx/fn.load_game_state.html | 1 + .../arduboy_rust/arduboyfx/fx/fn.save_game_state.html | 1 + .../arduboy_rust/arduboyfx/fx/fn.set_font_mode.html | 1 + .../hardware/buttons/constant.ANY_BUTTON.html | 2 ++ .../library/arduboyfx/fx/fn.load_game_state.html | 11 +++++++++++ .../library/arduboyfx/fx/fn.save_game_state.html | 11 +++++++++++ .../library/arduboyfx/fx/fn.set_font_mode.html | 11 +++++++++++ .../arduboy_rust/prelude/FX/fn.load_game_state.html | 1 + .../arduboy_rust/prelude/FX/fn.save_game_state.html | 1 + .../doc/arduboy_rust/prelude/FX/fn.set_font_mode.html | 1 + docs/doc/arduboy_rust/prelude/FX/index.html | 10 ++++++++++ docs/doc/arduboy_rust/prelude/FX/sidebar-items.js | 1 + .../prelude/arduboyfx/fx/fn.load_game_state.html | 1 + .../prelude/arduboyfx/fx/fn.save_game_state.html | 1 + .../prelude/arduboyfx/fx/fn.set_font_mode.html | 1 + .../prelude/buttons/constant.ANY_BUTTON.html | 2 ++ .../doc/arduboy_rust/prelude/constant.ANY_BUTTON.html | 2 ++ 17 files changed, 59 insertions(+) create mode 100644 docs/doc/arduboy_rust/arduboyfx/fx/fn.load_game_state.html create mode 100644 docs/doc/arduboy_rust/arduboyfx/fx/fn.save_game_state.html create mode 100644 docs/doc/arduboy_rust/arduboyfx/fx/fn.set_font_mode.html create mode 100644 docs/doc/arduboy_rust/hardware/buttons/constant.ANY_BUTTON.html create mode 100644 docs/doc/arduboy_rust/library/arduboyfx/fx/fn.load_game_state.html create mode 100644 docs/doc/arduboy_rust/library/arduboyfx/fx/fn.save_game_state.html create mode 100644 docs/doc/arduboy_rust/library/arduboyfx/fx/fn.set_font_mode.html create mode 100644 docs/doc/arduboy_rust/prelude/FX/fn.load_game_state.html create mode 100644 docs/doc/arduboy_rust/prelude/FX/fn.save_game_state.html create mode 100644 docs/doc/arduboy_rust/prelude/FX/fn.set_font_mode.html create mode 100644 docs/doc/arduboy_rust/prelude/FX/index.html create mode 100644 docs/doc/arduboy_rust/prelude/FX/sidebar-items.js create mode 100644 docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.load_game_state.html create mode 100644 docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.save_game_state.html create mode 100644 docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.set_font_mode.html create mode 100644 docs/doc/arduboy_rust/prelude/buttons/constant.ANY_BUTTON.html create mode 100644 docs/doc/arduboy_rust/prelude/constant.ANY_BUTTON.html diff --git a/docs/doc/arduboy_rust/arduboyfx/fx/fn.load_game_state.html b/docs/doc/arduboy_rust/arduboyfx/fx/fn.load_game_state.html new file mode 100644 index 0000000..c42548b --- /dev/null +++ b/docs/doc/arduboy_rust/arduboyfx/fx/fn.load_game_state.html @@ -0,0 +1 @@ +load_game_state in arduboy_rust::arduboyfx::fx - Rust

Function arduboy_rust::arduboyfx::fx::load_game_state

source · 
pub fn load_game_state<T>(your_struct: &mut T) -> u8
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/arduboyfx/fx/fn.save_game_state.html b/docs/doc/arduboy_rust/arduboyfx/fx/fn.save_game_state.html new file mode 100644 index 0000000..b29dbe7 --- /dev/null +++ b/docs/doc/arduboy_rust/arduboyfx/fx/fn.save_game_state.html @@ -0,0 +1 @@ +save_game_state in arduboy_rust::arduboyfx::fx - Rust

Function arduboy_rust::arduboyfx::fx::save_game_state

source · 
pub fn save_game_state<T>(your_struct: &T)
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/arduboyfx/fx/fn.set_font_mode.html b/docs/doc/arduboy_rust/arduboyfx/fx/fn.set_font_mode.html new file mode 100644 index 0000000..007a62e --- /dev/null +++ b/docs/doc/arduboy_rust/arduboyfx/fx/fn.set_font_mode.html @@ -0,0 +1 @@ +set_font_mode in arduboy_rust::arduboyfx::fx - Rust

Function arduboy_rust::arduboyfx::fx::set_font_mode

source · 
pub fn set_font_mode(mode: u8)
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/hardware/buttons/constant.ANY_BUTTON.html b/docs/doc/arduboy_rust/hardware/buttons/constant.ANY_BUTTON.html new file mode 100644 index 0000000..bf4cffb --- /dev/null +++ b/docs/doc/arduboy_rust/hardware/buttons/constant.ANY_BUTTON.html @@ -0,0 +1,2 @@ +ANY_BUTTON in arduboy_rust::hardware::buttons - Rust

Constant arduboy_rust::hardware::buttons::ANY_BUTTON

source · 
pub const ANY_BUTTON: ButtonSet;
Expand description

Just a const for the any

+
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.load_game_state.html b/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.load_game_state.html new file mode 100644 index 0000000..cc7da50 --- /dev/null +++ b/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.load_game_state.html @@ -0,0 +1,11 @@ + + + + + Redirection + + +

Redirecting to ../../../../arduboy_rust/prelude/arduboyfx/fx/fn.load_game_state.html...

+ + + \ No newline at end of file diff --git a/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.save_game_state.html b/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.save_game_state.html new file mode 100644 index 0000000..c464501 --- /dev/null +++ b/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.save_game_state.html @@ -0,0 +1,11 @@ + + + + + Redirection + + +

Redirecting to ../../../../arduboy_rust/prelude/arduboyfx/fx/fn.save_game_state.html...

+ + + \ No newline at end of file diff --git a/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.set_font_mode.html b/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.set_font_mode.html new file mode 100644 index 0000000..cc52478 --- /dev/null +++ b/docs/doc/arduboy_rust/library/arduboyfx/fx/fn.set_font_mode.html @@ -0,0 +1,11 @@ + + + + + Redirection + + +

Redirecting to ../../../../arduboy_rust/prelude/arduboyfx/fx/fn.set_font_mode.html...

+ + + \ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/FX/fn.load_game_state.html b/docs/doc/arduboy_rust/prelude/FX/fn.load_game_state.html new file mode 100644 index 0000000..02fa14b --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/FX/fn.load_game_state.html @@ -0,0 +1 @@ +load_game_state in arduboy_rust::prelude::fx - Rust

Function arduboy_rust::prelude::fx::load_game_state

source · 
pub fn load_game_state<T>(your_struct: &mut T) -> u8
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/FX/fn.save_game_state.html b/docs/doc/arduboy_rust/prelude/FX/fn.save_game_state.html new file mode 100644 index 0000000..ed2cd88 --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/FX/fn.save_game_state.html @@ -0,0 +1 @@ +save_game_state in arduboy_rust::prelude::fx - Rust

Function arduboy_rust::prelude::fx::save_game_state

source · 
pub fn save_game_state<T>(your_struct: &T)
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/FX/fn.set_font_mode.html b/docs/doc/arduboy_rust/prelude/FX/fn.set_font_mode.html new file mode 100644 index 0000000..3f82a2e --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/FX/fn.set_font_mode.html @@ -0,0 +1 @@ +set_font_mode in arduboy_rust::prelude::fx - Rust

Function arduboy_rust::prelude::fx::set_font_mode

source · 
pub fn set_font_mode(mode: u8)
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/FX/index.html b/docs/doc/arduboy_rust/prelude/FX/index.html new file mode 100644 index 0000000..2910536 --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/FX/index.html @@ -0,0 +1,10 @@ +arduboy_rust::prelude::fx - Rust

Module arduboy_rust::prelude::fx

source ·
Expand description

Functions given by the ArduboyFX library.

+

You can use the ‘FX::’ module to access the functions after the import of the prelude

+ +
use arduboy_rust::prelude::*;
+
+fn setup() {
+    FX::begin()
+}
+

You will need to uncomment the ArduboyFX_Library in the import_config.h file.

+

Functions

\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/FX/sidebar-items.js b/docs/doc/arduboy_rust/prelude/FX/sidebar-items.js new file mode 100644 index 0000000..9b9af4e --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/FX/sidebar-items.js @@ -0,0 +1 @@ +window.SIDEBAR_ITEMS = {"fn":["begin","begin_data","begin_data_save","display","display_clear","draw_bitmap","draw_char","draw_frame","draw_number","draw_string","load_game_state","read_data_array","save_game_state","set_cursor","set_cursor_range","set_cursor_x","set_cursor_y","set_font","set_font_mode","set_frame"]}; \ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.load_game_state.html b/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.load_game_state.html new file mode 100644 index 0000000..fea7f81 --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.load_game_state.html @@ -0,0 +1 @@ +load_game_state in arduboy_rust::prelude::arduboyfx::fx - Rust

Function arduboy_rust::prelude::arduboyfx::fx::load_game_state

source · 
pub fn load_game_state<T>(your_struct: &mut T) -> u8
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.save_game_state.html b/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.save_game_state.html new file mode 100644 index 0000000..f22fad7 --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.save_game_state.html @@ -0,0 +1 @@ +save_game_state in arduboy_rust::prelude::arduboyfx::fx - Rust

Function arduboy_rust::prelude::arduboyfx::fx::save_game_state

source · 
pub fn save_game_state<T>(your_struct: &T)
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.set_font_mode.html b/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.set_font_mode.html new file mode 100644 index 0000000..d2b4ce7 --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/arduboyfx/fx/fn.set_font_mode.html @@ -0,0 +1 @@ +set_font_mode in arduboy_rust::prelude::arduboyfx::fx - Rust

Function arduboy_rust::prelude::arduboyfx::fx::set_font_mode

source · 
pub fn set_font_mode(mode: u8)
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/buttons/constant.ANY_BUTTON.html b/docs/doc/arduboy_rust/prelude/buttons/constant.ANY_BUTTON.html new file mode 100644 index 0000000..94cb59b --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/buttons/constant.ANY_BUTTON.html @@ -0,0 +1,2 @@ +ANY_BUTTON in arduboy_rust::prelude::buttons - Rust

Constant arduboy_rust::prelude::buttons::ANY_BUTTON

source · 
pub const ANY_BUTTON: ButtonSet;
Expand description

Just a const for the any

+
\ No newline at end of file diff --git a/docs/doc/arduboy_rust/prelude/constant.ANY_BUTTON.html b/docs/doc/arduboy_rust/prelude/constant.ANY_BUTTON.html new file mode 100644 index 0000000..961a4e0 --- /dev/null +++ b/docs/doc/arduboy_rust/prelude/constant.ANY_BUTTON.html @@ -0,0 +1,2 @@ +ANY_BUTTON in arduboy_rust::prelude - Rust

Constant arduboy_rust::prelude::ANY_BUTTON

source · 
pub const ANY_BUTTON: ButtonSet;
Expand description

Just a const for the any

+
\ No newline at end of file