Rust-for-Arduboy/docs/doc/arduboy_rust/prelude/FX/index.html
2023-10-11 18:41:42 +02:00

10 lines
No EOL
7.8 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="Functions given by the ArduboyFX library."><title>arduboy_rust::prelude::fx - 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-fa3bb1812debf86c.css"><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.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-5d8b3c7633ad77ba.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></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 fx</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#functions">Functions</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 href="../index.html">prelude</a>::<wbr><a class="mod" href="#">fx</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/libraries\arduboyfx_library/fx.rs.html#1-141">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>Functions given by the ArduboyFX library.</p>
<p>You can use the FX:: module to access the functions after the import of the prelude</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>;
<span class="kw">fn </span>setup() {
fx::begin()
}</code></pre></div>
<p>You will need to uncomment the ArduboyFX in the config.toml file.</p>
</div></details><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.begin.html" title="fn arduboy_rust::prelude::fx::begin">begin</a></div></li><li><div class="item-name"><a class="fn" href="fn.begin_data.html" title="fn arduboy_rust::prelude::fx::begin_data">begin_data</a></div></li><li><div class="item-name"><a class="fn" href="fn.begin_data_save.html" title="fn arduboy_rust::prelude::fx::begin_data_save">begin_data_save</a></div></li><li><div class="item-name"><a class="fn" href="fn.display.html" title="fn arduboy_rust::prelude::fx::display">display</a></div></li><li><div class="item-name"><a class="fn" href="fn.display_clear.html" title="fn arduboy_rust::prelude::fx::display_clear">display_clear</a></div></li><li><div class="item-name"><a class="fn" href="fn.draw_bitmap.html" title="fn arduboy_rust::prelude::fx::draw_bitmap">draw_bitmap</a></div></li><li><div class="item-name"><a class="fn" href="fn.draw_char.html" title="fn arduboy_rust::prelude::fx::draw_char">draw_char</a></div></li><li><div class="item-name"><a class="fn" href="fn.draw_frame.html" title="fn arduboy_rust::prelude::fx::draw_frame">draw_frame</a></div></li><li><div class="item-name"><a class="fn" href="fn.draw_loaded_frame.html" title="fn arduboy_rust::prelude::fx::draw_loaded_frame">draw_loaded_frame</a></div></li><li><div class="item-name"><a class="fn" href="fn.draw_number.html" title="fn arduboy_rust::prelude::fx::draw_number">draw_number</a></div></li><li><div class="item-name"><a class="fn" href="fn.draw_string.html" title="fn arduboy_rust::prelude::fx::draw_string">draw_string</a></div></li><li><div class="item-name"><a class="fn" href="fn.load_game_state.html" title="fn arduboy_rust::prelude::fx::load_game_state">load_game_state</a></div></li><li><div class="item-name"><a class="fn" href="fn.read_data_array.html" title="fn arduboy_rust::prelude::fx::read_data_array">read_data_array</a></div></li><li><div class="item-name"><a class="fn" href="fn.save_game_state.html" title="fn arduboy_rust::prelude::fx::save_game_state">save_game_state</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_cursor.html" title="fn arduboy_rust::prelude::fx::set_cursor">set_cursor</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_cursor_range.html" title="fn arduboy_rust::prelude::fx::set_cursor_range">set_cursor_range</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_cursor_x.html" title="fn arduboy_rust::prelude::fx::set_cursor_x">set_cursor_x</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_cursor_y.html" title="fn arduboy_rust::prelude::fx::set_cursor_y">set_cursor_y</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_font.html" title="fn arduboy_rust::prelude::fx::set_font">set_font</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_font_mode.html" title="fn arduboy_rust::prelude::fx::set_font_mode">set_font_mode</a></div></li><li><div class="item-name"><a class="fn" href="fn.set_frame.html" title="fn arduboy_rust::prelude::fx::set_frame">set_frame</a></div></li></ul></section></div></main></body></html>