58 lines
7.1 KiB
HTML
58 lines
7.1 KiB
HTML
<!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="Source of the Rust file `game/game_logic/src/asset_manager/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><script defer src="../../../main.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script>
|
||
<noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../../game_logic/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></div>
|
||
</a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../game_logic/index.html"><img class="rust-logo" src="../../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1"> 1</span>
|
||
<span id="2"> 2</span>
|
||
<span id="3"> 3</span>
|
||
<span id="4"> 4</span>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10">10</span>
|
||
<span id="11">11</span>
|
||
<span id="12">12</span>
|
||
<span id="13">13</span>
|
||
<span id="14">14</span>
|
||
<span id="15">15</span>
|
||
<span id="16">16</span>
|
||
<span id="17">17</span>
|
||
<span id="18">18</span>
|
||
<span id="19">19</span>
|
||
<span id="20">20</span>
|
||
<span id="21">21</span>
|
||
<span id="22">22</span>
|
||
<span id="23">23</span>
|
||
<span id="24">24</span>
|
||
<span id="25">25</span>
|
||
<span id="26">26</span>
|
||
<span id="27">27</span>
|
||
</pre><pre class="rust"><code><span class="doccomment">//! Embedded asset management.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ## Overview</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! `asset_manager` is one of the most important modules in this project. It handles loading and packaging of in-game resources.</span>
|
||
<span class="doccomment">//! Generally in a game, you might distribute an executable along with a zip of everything needed to run, </span>
|
||
<span class="doccomment">//! but we have had some issues with this before on systems with restrictive file permissions (cough OSX).</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! To make the game distribution process easier, we embed our resources directly into the executable's data section using </span>
|
||
<span class="doccomment">//! [`rust-embed`](https://github.com/pyros2097/rust-embed). This means we only have to distribute one single file to players.</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! ## Debug vs. Release mode</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! When the game is built in debug mode (with `cargo build`), the resources are *not* packaged into the game. </span>
|
||
<span class="doccomment">//! Instead, they are read from disk, allowing us to modify them while the game is running, and speeding up the compile times.</span>
|
||
<span class="doccomment">//! </span>
|
||
<span class="doccomment">//! When the game is built in release mode (with `cargo build --release`), the resources are packaged into the game as described above.</span>
|
||
<span class="doccomment">//! This means the game will load faster, but also use more RAM.</span>
|
||
|
||
<span class="kw">mod</span> <span class="ident">datastore</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">datastore::InternalData</span>;
|
||
<span class="kw">mod</span> <span class="ident">json</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">json</span>::{<span class="ident">InternalJsonLoadError</span>, <span class="ident">load_json_structure</span>};
|
||
<span class="kw">mod</span> <span class="ident">sprite_types</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">sprite_types</span>::{<span class="ident">KnownSpriteType</span>, <span class="ident">load_known_sprite_types</span>};
|
||
<span class="kw">mod</span> <span class="ident">texture</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">texture</span>::{<span class="ident">load_texture_from_internal_data</span>, <span class="ident">ResourceLoadError</span>, <span class="ident">load_music_from_internal_data</span>, <span class="ident">load_sound_from_internal_data</span>};</code></pre></div>
|
||
</section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="game_logic" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |