<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="This is the important one to use this library effective in your project"><title>arduboy_rust::prelude - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-fa3bb1812debf86c.css"><metaname="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.75.0-nightly (2bbb61989 2023-10-04)"data-channel="nightly"data-search-js="search-8be46b629f5f14a8.js"data-settings-js="settings-74424d7eec62a23e.js"><scriptsrc="../../static.files/storage-fec3eaa3851e447d.js"></script><scriptdefersrc="../../static.files/main-c5bd66d33317d69f.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="logo-container"href="../../arduboy_rust/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a></nav><navclass="sidebar"><aclass="logo-container"href="../../arduboy_rust/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2class="location"><ahref="#">Module prelude</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#modules">Modules</a></li><li><ahref="#macros">Macros</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#constants">Constants</a></li><li><ahref="#functions">Functions</a></li><li><ahref="#types">Type Aliases</a></li></ul></section></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="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"><divid="help-button"title="help"tabindex="-1"><ahref="../../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Module <ahref="../index.html">arduboy_rust</a>::<wbr><aclass="mod"href="#">prelude</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1>
</div></details><h2id="modules"class="small-section-header"><ahref="#modules">Modules</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="fx/index.html"title="mod arduboy_rust::prelude::fx">fx</a></div><divclass="desc docblock-short">Functions given by the ArduboyFX library.</div></li><li><divclass="item-name"><aclass="mod"href="fx_consts/index.html"title="mod arduboy_rust::prelude::fx_consts">fx_consts</a></div><divclass="desc docblock-short">Consts given by the ArduboyFX library.</div></li><li><divclass="item-name"><aclass="mod"href="serial/index.html"title="mod arduboy_rust::prelude::serial">serial</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the Arduino Serial C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="sprites/index.html"title="mod arduboy_rust::prelude::sprites">sprites</a></div><divclass="desc docblock-short">This is the module to interact in a save way with the Sprites C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="tones_pitch/index.html"title="mod arduboy_rust::prelude::tones_pitch">tones_pitch</a></div><divclass="desc docblock-short">A list of all tones available and used by the Sounds library Arduboy2Tones</div></li></ul><h2id="macros"class="small-section-header"><ahref="#macros">Macros</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="macro"href="macro.f.html"title="macro arduboy_rust::prelude::f">f</a></div><divclass="desc docblock-short">This is the way to go if you want print some random text</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_ardvoice_tone_addr.html"title="macro arduboy_rust::prelude::get_ardvoice_tone_addr">get_ardvoice_tone_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a ardvoice tone as u8, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_sprite_addr.html"title="macro arduboy_rust::prelude::get_sprite_addr">get_sprite_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a sprite as u8, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_string_addr.html"title="macro arduboy_rust::prelude::get_string_addr">get_string_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a [u8;_] that saves text, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_tones_addr.html"title="macro arduboy_rust::prelude::get_tones_addr">get_tones_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a tone sequenze as u16, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.progmem.html"title="macro arduboy_rust::prelude::progmem">progmem</a></div><divclass="desc docblock-short">Create a space for Progmem variable</div></li></ul><h2id="structs"class="small-section-header"><ahref="#structs">Structs</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.ArdVoice.html"title="struct arduboy_rust::prelude::ArdVoice">ArdVoice</a></div><divclass="desc docblock-short">This is the struct to interact in a save way with the ArdVoice C++ library.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Arduboy2.html"title="struct arduboy_rust::prelude::Arduboy2">Arduboy2</a></div><divclass="desc docblock-short">This is the struct to interact in a save way with the Arduboy2 C++ library.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ArduboyTones.html"title="struct arduboy_rust::prelude::ArduboyTones">ArduboyTones</a></div><divclass="desc docblock-short">This is the struct to interact in a save way with the ArduboyTones C++ library.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ButtonSet.html"title="struct arduboy_rust::prelude::ButtonSet">ButtonS
seed based</div></li><li><divclass="item-name"><aclass="fn"href="fn.random_less_than.html"title="fn arduboy_rust::prelude::random_less_than">random_less_than</a></div><divclass="desc docblock-short">A Arduino function to get a random number smaller than the number given
seed based</div></li><li><divclass="item-name"><aclass="fn"href="fn.strlen.html"title="fn arduboy_rust::prelude::strlen">strlen</a></div><divclass="desc docblock-short">A C function to get the length of a string</div></li></ul><h2id="types"class="small-section-header"><ahref="#types">Type Aliases</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="type"href="type.c_size_t.html"title="type arduboy_rust::prelude::c_size_t">c_size_t</a><spanclass="stab unstable"title="">Experimental</span></div><divclass="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><divclass="item-name"><aclass="type"href="type.c_char.html"title="type arduboy_rust::prelude::c_char">c_char</a></div><divclass="desc docblock-short">Equivalent to C’s <code>char</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_double.html"title="type arduboy_rust::prelude::c_double">c_double</a></div><divclass="desc docblock-short">Equivalent to C’s <code>double</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_float.html"title="type arduboy_rust::prelude::c_float">c_float</a></div><divclass="desc docblock-short">Equivalent to C’s <code>float</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_int.html"title="type arduboy_rust::prelude::c_int">c_int</a></div><divclass="desc docblock-short">Equivalent to C’s <code>signed int</code> (<code>int</code>) type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_long.html"title="type arduboy_rust::prelude::c_long">c_long</a></div><divclass="desc docblock-short">Equivalent to C’s <code>signed long</code> (<code>long</code>) type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_longlong.html"title="type arduboy_rust::prelude::c_longlong">c_longlong</a></div><divclass="desc docblock-short">Equivalent to C’s <code>signed long long</code> (<code>long long</code>) type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_uchar.html"title="type arduboy_rust::prelude::c_uchar">c_uchar</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned char</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_uint.html"title="type arduboy_rust::prelude::c_uint">c_uint</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned int</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_ulong.html"title="type arduboy_rust::prelude::c_ulong">c_ulong</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned long</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_ulonglong.html"title="type arduboy_rust::prelude::c_ulonglong">c_ulonglong</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned long long</code> type.</div></li></ul></section></div></main></body></html>
