ZennDev1337/Rust-for-Arduboy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Rust-for-Arduboy/docs/doc/arduboy_rust/prelude/index.html
ZennDev1337 87e451b82b update Docs
2023-08-15 13:42:38 +02:00

7 lines
No EOL
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="This is the important one to use this library effective in your project"><title>arduboy_rust::prelude - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="arduboy_rust" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0-nightly (8131b9774 2023-08-02)" data-channel="nightly" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-6d2c9675f3d09c26.css" data-theme-dark-css="dark-45ceb8f2e522f4d1.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-6d2c9675f3d09c26.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-45ceb8f2e522f4d1.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="logo-container" href="../../arduboy_rust/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../arduboy_rust/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module prelude</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">arduboy_rust</a>::<wbr><a class="mod" href="#">prelude</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/arduboy_rust/prelude.rs.html#1-31">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This is the important one to use this library effective in your project</p>
<p>Import the module:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>arduboy_rust::prelude::<span class="kw-2">*</span>;</code></pre></div>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="arduboy2/index.html" title="mod arduboy_rust::prelude::arduboy2">arduboy2</a></div><div class="desc docblock-short">This is the Module to interact in a save way with the Arduboy2 C++ library.</div></li><li><div class="item-name"><a class="mod" href="arduboy_tone/index.html" title="mod arduboy_rust::prelude::arduboy_tone">arduboy_tone</a></div><div class="desc docblock-short">This is the Module to interact in a save way with the ArduboyTones C++ library.</div></li><li><div class="item-name"><a class="mod" href="buttons/index.html" title="mod arduboy_rust::prelude::buttons">buttons</a></div><div class="desc docblock-short">A list of all six buttons available on the Arduboy</div></li><li><div class="item-name"><a class="mod" href="led/index.html" title="mod arduboy_rust::prelude::led">led</a></div><div class="desc docblock-short">A list of all LED variables available</div></li><li><div class="item-name"><a class="mod" href="sprites/index.html" title="mod arduboy_rust::prelude::sprites">sprites</a></div><div class="desc docblock-short">This is the module to interact in a save way with the Sprites C++ library.</div></li></ul><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.f.html" title="macro arduboy_rust::prelude::f">f</a></div><div class="desc docblock-short">This is the way to go if you want print some random text</div></li><li><div class="item-name"><a class="macro" href="macro.get_sprite_addr.html" title="macro arduboy_rust::prelude::get_sprite_addr">get_sprite_addr</a></div><div class="desc docblock-short">Create a <code>const</code> raw pointer to a sprite as u8, without creating an intermediate reference.</div></li><li><div class="item-name"><a class="macro" href="macro.get_string_addr.html" title="macro arduboy_rust::prelude::get_string_addr">get_string_addr</a></div><div class="desc docblock-short">Create a <code>const</code> raw pointer to a [u8;_] that saves text, without creating an intermediate reference.</div></li><li><div class="item-name"><a class="macro" href="macro.get_tones_addr.html" title="macro arduboy_rust::prelude::get_tones_addr">get_tones_addr</a></div><div class="desc docblock-short">Create a <code>const</code> raw pointer to a sprite as u16, without creating an intermediate reference.</div></li><li><div class="item-name"><a class="macro" href="macro.progmem.html" title="macro arduboy_rust::prelude::progmem">progmem</a></div><div class="desc docblock-short">Create a space for Progmem variable</div></li></ul><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Arduboy2.html" title="struct arduboy_rust::prelude::Arduboy2">Arduboy2</a></div><div class="desc docblock-short">This is the struct to interact in a save way with the Arduboy2 C++ library.</div></li><li><div class="item-name"><a class="struct" href="struct.ArduboyTones.html" title="struct arduboy_rust::prelude::ArduboyTones">ArduboyTones</a></div><div class="desc docblock-short">This is the struct to interact in a save way with the ArduboyTones C++ library.</div></li><li><div class="item-name"><a class="struct" href="struct.ButtonSet.html" title="struct arduboy_rust::prelude::ButtonSet">ButtonSet</a></div><div class="desc docblock-short">This struct gives the library a understanding what Buttons on the Arduboy are.</div></li><li><div class="item-name"><a class="struct" href="struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></div><div class="desc docblock-short">This is the struct to store and read structs objects to/from eeprom memory.</div></li><li><div class="item-name"><a class="struct" href="struct.EEPROMBYTE.html" title="struct arduboy_rust::prelude::EEPROMBYTE">EEPROMBYTE</a></div><div class="desc docblock-short">Use this struct to store and read single bytes to/from eeprom memory.</div></li><li><div class="item-name"><a class="struct" href="struct.Point.html" title="struct arduboy_rust::prelude::Point">Point</a></div><div class="desc docblock-short">This struct is used by a few Arduboy functions.</div></li><li><div class="item-name"><a class="struct" href="struct.Rect.html" title="struct arduboy_rust::prelude::Rect">Rect</a></div><div class="desc docblock-short">This struct is used by a few Arduboy functions.</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Base.html" title="enum arduboy_rust::prelude::Base">Base</a></div></li><li><div class="item-name"><a class="enum" href="enum.Color.html" title="enum arduboy_rust::prelude::Color">Color</a></div><div class="desc docblock-short">This item is to chose between Black or White</div></li></ul><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.A.html" title="constant arduboy_rust::prelude::A">A</a></div><div class="desc docblock-short">Just a <code>const</code> for the A button</div></li><li><div class="item-name"><a class="constant" href="constant.A_BUTTON.html" title="constant arduboy_rust::prelude::A_BUTTON">A_BUTTON</a></div><div class="desc docblock-short">Just a <code>const</code> for the A button</div></li><li><div class="item-name"><a class="constant" href="constant.B.html" title="constant arduboy_rust::prelude::B">B</a></div><div class="desc docblock-short">Just a <code>const</code> for the B button</div></li><li><div class="item-name"><a class="constant" href="constant.BLUE_LED.html" title="constant arduboy_rust::prelude::BLUE_LED">BLUE_LED</a></div><div class="desc docblock-short">Just a <code>const</code> for the blue led</div></li><li><div class="item-name"><a class="constant" href="constant.B_BUTTON.html" title="constant arduboy_rust::prelude::B_BUTTON">B_BUTTON</a></div><div class="desc docblock-short">Just a <code>const</code> for the B button</div></li><li><div class="item-name"><a class="constant" href="constant.DOWN.html" title="constant arduboy_rust::prelude::DOWN">DOWN</a></div><div class="desc docblock-short">Just a <code>const</code> for the DOWN button</div></li><li><div class="item-name"><a class="constant" href="constant.DOWN_BUTTON.html" title="constant arduboy_rust::prelude::DOWN_BUTTON">DOWN_BUTTON</a></div><div class="desc docblock-short">Just a <code>const</code> for the DOWN button</div></li><li><div class="item-name"><a class="constant" href="constant.FONT_SIZE.html" title="constant arduboy_rust::prelude::FONT_SIZE">FONT_SIZE</a></div><div class="desc docblock-short">The standard font size of the arduboy</div></li><li><div class="item-name"><a class="constant" href="constant.GREEN_LED.html" title="constant arduboy_rust::prelude::GREEN_LED">GREEN_LED</a></div><div class="desc docblock-short">Just a <code>const</code> for the green led</div></li><li><div class="item-name"><a class="constant" href="constant.HEIGHT.html" title="constant arduboy_rust::prelude::HEIGHT">HEIGHT</a></div><div class="desc docblock-short">The standard height of the arduboy</div></li><li><div class="item-name"><a class="constant" href="constant.LEFT.html" title="constant arduboy_rust::prelude::LEFT">LEFT</a></div><div class="desc docblock-short">Just a <code>const</code> for the LEFT button</div></li><li><div class="item-name"><a class="constant" href="constant.LEFT_BUTTON.html" title="constant arduboy_rust::prelude::LEFT_BUTTON">LEFT_BUTTON</a></div><div class="desc docblock-short">Just a <code>const</code> for the LEFT button</div></li><li><div class="item-name"><a class="constant" href="constant.RED_LED.html" title="constant arduboy_rust::prelude::RED_LED">RED_LED</a></div><div class="desc docblock-short">Just a <code>const</code> for the red led</div></li><li><div class="item-name"><a class="constant" href="constant.RGB_OFF.html" title="constant arduboy_rust::prelude::RGB_OFF">RGB_OFF</a></div><div class="desc docblock-short">Just a <code>const</code> for led off</div></li><li><div class="item-name"><a class="constant" href="constant.RGB_ON.html" title="constant arduboy_rust::prelude::RGB_ON">RGB_ON</a></div><div class="desc docblock-short">Just a <code>const</code> for led on</div></li><li><div class="item-name"><a class="constant" href="constant.RIGHT.html" title="constant arduboy_rust::prelude::RIGHT">RIGHT</a></div><div class="desc docblock-short">Just a <code>const</code> for the RIGHT button</div></li><li><div class="item-name"><a class="constant" href="constant.RIGHT_BUTTON.html" title="constant arduboy_rust::prelude::RIGHT_BUTTON">RIGHT_BUTTON</a></div><div class="desc docblock-short">Just a <code>const</code> for the RIGHT button</div></li><li><div class="item-name"><a class="constant" href="constant.UP.html" title="constant arduboy_rust::prelude::UP">UP</a></div><div class="desc docblock-short">Just a <code>const</code> for the UP button</div></li><li><div class="item-name"><a class="constant" href="constant.UP_BUTTON.html" title="constant arduboy_rust::prelude::UP_BUTTON">UP_BUTTON</a></div><div class="desc docblock-short">Just a <code>const</code> for the UP button</div></li><li><div class="item-name"><a class="constant" href="constant.WIDTH.html" title="constant arduboy_rust::prelude::WIDTH">WIDTH</a></div><div class="desc docblock-short">The standard width of the arduboy</div></li></ul><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Printable.html" title="trait arduboy_rust::prelude::Printable">Printable</a></div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.constrain.html" title="fn arduboy_rust::prelude::constrain">constrain</a></div></li><li><div class="item-name"><a class="fn" href="fn.delay.html" title="fn arduboy_rust::prelude::delay">delay</a></div><div class="desc docblock-short">A Arduino function to pause the cpu circles for a given amount of ms</div></li><li><div class="item-name"><a class="fn" href="fn.random_between.html" title="fn arduboy_rust::prelude::random_between">random_between</a></div><div class="desc docblock-short">A Arduino function to get a random number between 2 numbers
seed based</div></li><li><div class="item-name"><a class="fn" href="fn.random_less_than.html" title="fn arduboy_rust::prelude::random_less_than">random_less_than</a></div><div class="desc docblock-short">A Arduino function to get a random number smaller than the number given
seed based</div></li><li><div class="item-name"><a class="fn" href="fn.strlen.html" title="fn arduboy_rust::prelude::strlen">strlen</a></div><div class="desc docblock-short">A C function to get the length of a string</div></li></ul><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.c_size_t.html" title="type arduboy_rust::prelude::c_size_t">c_size_t</a><span class="stab unstable" title="">Experimental</span></div><div class="desc docblock-short">Equivalent to C’s <code>size_t</code> type, from <code>stddef.h</code> (or <code>cstddef</code> for C++).</div></li><li><div class="item-name"><a class="type" href="type.c_char.html" title="type arduboy_rust::prelude::c_char">c_char</a></div><div class="desc docblock-short">Equivalent to C’s <code>char</code> type.</div></li><li><div class="item-name"><a class="type" href="type.c_double.html" title="type arduboy_rust::prelude::c_double">c_double</a></div><div class="desc docblock-short">Equivalent to C’s <code>double</code> type.</div></li><li><div class="item-name"><a class="type" href="type.c_float.html" title="type arduboy_rust::prelude::c_float">c_float</a></div><div class="desc docblock-short">Equivalent to C’s <code>float</code> type.</div></li><li><div class="item-name"><a class="type" href="type.c_int.html" title="type arduboy_rust::prelude::c_int">c_int</a></div><div class="desc docblock-short">Equivalent to C’s <code>signed int</code> (<code>int</code>) type.</div></li><li><div class="item-name"><a class="type" href="type.c_long.html" title="type arduboy_rust::prelude::c_long">c_long</a></div><div class="desc docblock-short">Equivalent to C’s <code>signed long</code> (<code>long</code>) type.</div></li><li><div class="item-name"><a class="type" href="type.c_longlong.html" title="type arduboy_rust::prelude::c_longlong">c_longlong</a></div><div class="desc docblock-short">Equivalent to C’s <code>signed long long</code> (<code>long long</code>) type.</div></li><li><div class="item-name"><a class="type" href="type.c_uchar.html" title="type arduboy_rust::prelude::c_uchar">c_uchar</a></div><div class="desc docblock-short">Equivalent to C’s <code>unsigned char</code> type.</div></li><li><div class="item-name"><a class="type" href="type.c_uint.html" title="type arduboy_rust::prelude::c_uint">c_uint</a></div><div class="desc docblock-short">Equivalent to C’s <code>unsigned int</code> type.</div></li><li><div class="item-name"><a class="type" href="type.c_ulong.html" title="type arduboy_rust::prelude::c_ulong">c_ulong</a></div><div class="desc docblock-short">Equivalent to C’s <code>unsigned long</code> type.</div></li><li><div class="item-name"><a class="type" href="type.c_ulonglong.html" title="type arduboy_rust::prelude::c_ulonglong">c_ulonglong</a></div><div class="desc docblock-short">Equivalent to C’s <code>unsigned long long</code> type.</div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink