21 lines
9.0 KiB
HTML
21 lines
9.0 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="Embedded asset management."><meta name="keywords" content="rust, rustlang, rust-lang, asset_manager"><title>game_logic::asset_manager - Rust</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>
|
||
<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 mod"><!--[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><h2 class="location">Module asset_manager</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li></ul></div><div id="sidebar-vars" data-name="asset_manager" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></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"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">game_logic</a>::<wbr><a class="mod" href="#">asset_manager</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../../src/game_logic/asset_manager/mod.rs.html#1-27" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Embedded asset management.</p>
|
||
<h3 id="overview" class="section-header"><a href="#overview">Overview</a></h3>
|
||
<p><code>asset_manager</code> is one of the most important modules in this project. It handles loading and packaging of in-game resources.
|
||
Generally in a game, you might distribute an executable along with a zip of everything needed to run,
|
||
but we have had some issues with this before on systems with restrictive file permissions (cough OSX).</p>
|
||
<p>To make the game distribution process easier, we embed our resources directly into the executable’s data section using
|
||
<a href="https://github.com/pyros2097/rust-embed"><code>rust-embed</code></a>. This means we only have to distribute one single file to players.</p>
|
||
<h3 id="debug-vs-release-mode" class="section-header"><a href="#debug-vs-release-mode">Debug vs. Release mode</a></h3>
|
||
<p>When the game is built in debug mode (with <code>cargo build</code>), the resources are <em>not</em> packaged into the game.
|
||
Instead, they are read from disk, allowing us to modify them while the game is running, and speeding up the compile times.</p>
|
||
<p>When the game is built in release mode (with <code>cargo build --release</code>), the resources are packaged into the game as described above.
|
||
This means the game will load faster, but also use more RAM.</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use datastore::<a class="struct" href="datastore/struct.InternalData.html" title="struct game_logic::asset_manager::datastore::InternalData">InternalData</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use json::<a class="enum" href="json/enum.InternalJsonLoadError.html" title="enum game_logic::asset_manager::json::InternalJsonLoadError">InternalJsonLoadError</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use json::<a class="fn" href="json/fn.load_json_structure.html" title="fn game_logic::asset_manager::json::load_json_structure">load_json_structure</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use sprite_types::<a class="struct" href="sprite_types/struct.KnownSpriteType.html" title="struct game_logic::asset_manager::sprite_types::KnownSpriteType">KnownSpriteType</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use sprite_types::<a class="fn" href="sprite_types/fn.load_known_sprite_types.html" title="fn game_logic::asset_manager::sprite_types::load_known_sprite_types">load_known_sprite_types</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use texture::<a class="fn" href="texture/fn.load_texture_from_internal_data.html" title="fn game_logic::asset_manager::texture::load_texture_from_internal_data">load_texture_from_internal_data</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use texture::<a class="enum" href="texture/enum.ResourceLoadError.html" title="enum game_logic::asset_manager::texture::ResourceLoadError">ResourceLoadError</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="datastore/index.html" title="game_logic::asset_manager::datastore mod">datastore</a></div><div class="item-right docblock-short"><p>Access to the game’s embedded files.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="json/index.html" title="game_logic::asset_manager::json mod">json</a></div><div class="item-right docblock-short"><p>Utilities for loading JSON from the embedded filesystem.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sprite_types/index.html" title="game_logic::asset_manager::sprite_types mod">sprite_types</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="texture/index.html" title="game_logic::asset_manager::texture mod">texture</a></div><div class="item-right docblock-short"><p>Code for loading textures from RAM to VRAM</p>
|
||
</div></div></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> |