<!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 arduboy_rust crate To get started import the prelude to your project."><title>arduboy_rust - 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-cb6f1f67f1bcd037.css"id="mainThemeStyle"><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.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"><scriptsrc="../static.files/storage-db41da1a38ea3cb8.js"></script><scriptdefersrc="../crates.js"></script><scriptdefersrc="../static.files/main-0795b7d26be81095.js"></script><noscript><linkrel="stylesheet"media="(prefers-color-scheme:light)"href="../static.files/light-6d2c9675f3d09c26.css"><linkrel="stylesheet"media="(prefers-color-scheme:dark)"href="../static.files/dark-45ceb8f2e522f4d1.css"><linkrel="stylesheet"href="../static.files/noscript-cffde32267a19fd6.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 crate"><!--[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><h2></h2></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="#">Crate arduboy_rust</a></h2><divclass="sidebar-elems"><ulclass="block"><liclass="version">Version 1.0.0</li><li><aid="all-types"href="all.html">All Items</a></li></ul><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></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"><img
</div></details><h2id="modules"class="small-section-header"><ahref="#modules">Modules</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="arduboy2/index.html"title="mod arduboy_rust::arduboy2">arduboy2</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the Arduboy2 C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="arduboy_tone/index.html"title="mod arduboy_rust::arduboy_tone">arduboy_tone</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the ArduboyTones C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="arduino/index.html"title="mod arduboy_rust::arduino">arduino</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the Arduino C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="c/index.html"title="mod arduboy_rust::c">c</a></div><divclass="desc docblock-short">Clib functions you can use on the Arduboy</div></li><li><divclass="item-name"><aclass="mod"href="hardware/index.html"title="mod arduboy_rust::hardware">hardware</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the Arduboy hardware.</div></li><li><divclass="item-name"><aclass="mod"href="prelude/index.html"title="mod arduboy_rust::prelude">prelude</a></div><divclass="desc docblock-short">This is the important one to use this library effective in your project</div></li><li><divclass="item-name"><aclass="mod"href="sprites/index.html"title="mod arduboy_rust::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></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::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_sprite_addr.html"title="macro arduboy_rust::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::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::get_tones_addr">get_tones_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a sprite as u16, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.progmem.html"title="macro arduboy_rust::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.Arduboy2.html"title="struct arduboy_rust::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::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.EEPROM.html"title="struct arduboy_rust::EEPROM">EEPROM</a></div><divclass="desc docblock-short">This is the struct to store and read structs objects to/from eeprom memory.</div></li><li><divclass="item-name"><aclass="struct"href="struct.EEPROMBYTE.html"title="s