Files
phy/bevy_render/render_asset/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

6 lines
7.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="API documentation for the Rust `render_asset` mod in crate `bevy_render`."><title>bevy_render::render_asset - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_render" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></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" title="show sidebar"></button><a class="logo-container" href="../../bevy_render/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bevy_render/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_render/index.html">bevy_<wbr>render</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module render_<wbr>asset</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bevy_<wbr>render</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_render</a></span><h1>Module <span>render_asset</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_render/render_asset.rs.html#1-429">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ExtractedAssets.html" title="struct bevy_render::render_asset::ExtractedAssets">Extracted<wbr>Assets</a></div><div class="desc docblock-short">Temporarily stores the extracted and removed assets of the current frame.</div></li><li><div class="item-name"><a class="struct" href="struct.PrepareNextFrameAssets.html" title="struct bevy_render::render_asset::PrepareNextFrameAssets">Prepare<wbr>Next<wbr>Frame<wbr>Assets</a></div><div class="desc docblock-short">All assets that should be prepared next frame.</div></li><li><div class="item-name"><a class="struct" href="struct.RenderAssetBytesPerFrame.html" title="struct bevy_render::render_asset::RenderAssetBytesPerFrame">Render<wbr>Asset<wbr>Bytes<wbr>PerFrame</a></div><div class="desc docblock-short">A resource that attempts to limit the amount of data transferred from cpu to gpu
each frame, preventing choppy frames at the cost of waiting longer for gpu assets
to become available</div></li><li><div class="item-name"><a class="struct" href="struct.RenderAssetPlugin.html" title="struct bevy_render::render_asset::RenderAssetPlugin">Render<wbr>Asset<wbr>Plugin</a></div><div class="desc docblock-short">This plugin extracts the changed assets from the “app world” into the “render world”
and prepares them for the GPU. They can then be accessed from the <a href="struct.RenderAssets.html" title="struct bevy_render::render_asset::RenderAssets"><code>RenderAssets</code></a> resource.</div></li><li><div class="item-name"><a class="struct" href="struct.RenderAssetUsages.html" title="struct bevy_render::render_asset::RenderAssetUsages">Render<wbr>Asset<wbr>Usages</a></div><div class="desc docblock-short">Defines where the asset will be used.</div></li><li><div class="item-name"><a class="struct" href="struct.RenderAssets.html" title="struct bevy_render::render_asset::RenderAssets">Render<wbr>Assets</a></div><div class="desc docblock-short">Stores all GPU representations (<a href="trait.RenderAsset.html" title="trait bevy_render::render_asset::RenderAsset"><code>RenderAsset</code></a>)
of <a href="trait.RenderAsset.html#associatedtype.SourceAsset" title="associated type bevy_render::render_asset::RenderAsset::SourceAsset"><code>RenderAsset::SourceAsset</code></a> as long as they exist.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.PrepareAssetError.html" title="enum bevy_render::render_asset::PrepareAssetError">Prepare<wbr>Asset<wbr>Error</a></div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.RenderAsset.html" title="trait bevy_render::render_asset::RenderAsset">Render<wbr>Asset</a></div><div class="desc docblock-short">Describes how an asset gets extracted and prepared for rendering.</div></li><li><div class="item-name"><a class="trait" href="trait.RenderAssetDependency.html" title="trait bevy_render::render_asset::RenderAssetDependency">Render<wbr>Asset<wbr>Dependency</a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.prepare_assets.html" title="fn bevy_render::render_asset::prepare_assets">prepare_<wbr>assets</a></div><div class="desc docblock-short">This system prepares all assets of the corresponding <a href="trait.RenderAsset.html#associatedtype.SourceAsset" title="associated type bevy_render::render_asset::RenderAsset::SourceAsset"><code>RenderAsset::SourceAsset</code></a> type
which where extracted this frame for the GPU.</div></li></ul></section></div></main></body></html>