10 lines
11 KiB
HTML
10 lines
11 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 `texture` mod in crate `bevy_render`."><title>bevy_render::texture - 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 texture</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</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>texture</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/texture/mod.rs.html#1-136">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.DefaultImageSampler"><code>pub use crate::render_resource::<a class="struct" href="../render_resource/struct.DefaultImageSampler.html" title="struct bevy_render::render_resource::DefaultImageSampler">DefaultImageSampler</a>;</code></div></li></ul><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.CachedTexture.html" title="struct bevy_render::texture::CachedTexture">Cached<wbr>Texture</a></div><div class="desc docblock-short">A cached GPU <a href="../render_resource/struct.Texture.html" title="struct bevy_render::render_resource::Texture"><code>Texture</code></a> with corresponding <a href="../render_resource/struct.TextureView.html" title="struct bevy_render::render_resource::TextureView"><code>TextureView</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ColorAttachment.html" title="struct bevy_render::texture::ColorAttachment">Color<wbr>Attachment</a></div><div class="desc docblock-short">A wrapper for a <a href="struct.CachedTexture.html" title="struct bevy_render::texture::CachedTexture"><code>CachedTexture</code></a> that is used as a <a href="../render_resource/struct.RenderPassColorAttachment.html" title="struct bevy_render::render_resource::RenderPassColorAttachment"><code>RenderPassColorAttachment</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.DepthAttachment.html" title="struct bevy_render::texture::DepthAttachment">Depth<wbr>Attachment</a></div><div class="desc docblock-short">A wrapper for a <a href="../render_resource/struct.TextureView.html" title="struct bevy_render::render_resource::TextureView"><code>TextureView</code></a> that is used as a depth-only <a href="../render_resource/struct.RenderPassDepthStencilAttachment.html" title="struct bevy_render::render_resource::RenderPassDepthStencilAttachment"><code>RenderPassDepthStencilAttachment</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.FallbackImage.html" title="struct bevy_render::texture::FallbackImage">Fallback<wbr>Image</a></div><div class="desc docblock-short">A <a href="../struct.RenderApp.html" title="struct bevy_render::RenderApp"><code>RenderApp</code></a> resource that contains the default “fallback image”,
|
||
which can be used in situations where an image was not explicitly defined. The most common
|
||
use case is <a href="../render_resource/trait.AsBindGroup.html" title="trait bevy_render::render_resource::AsBindGroup"><code>AsBindGroup</code></a> implementations (such as materials) that support optional textures.</div></li><li><div class="item-name"><a class="struct" href="struct.FallbackImageCubemap.html" title="struct bevy_render::texture::FallbackImageCubemap">Fallback<wbr>Image<wbr>Cubemap</a></div><div class="desc docblock-short">A <a href="../struct.RenderApp.html" title="struct bevy_render::RenderApp"><code>RenderApp</code></a> resource that contains a “cubemap fallback image”,
|
||
which can be used in situations where an image was not explicitly defined. The most common
|
||
use case is <a href="../render_resource/trait.AsBindGroup.html" title="trait bevy_render::render_resource::AsBindGroup"><code>AsBindGroup</code></a> implementations (such as materials) that support optional textures.</div></li><li><div class="item-name"><a class="struct" href="struct.FallbackImageFormatMsaaCache.html" title="struct bevy_render::texture::FallbackImageFormatMsaaCache">Fallback<wbr>Image<wbr>Format<wbr>Msaa<wbr>Cache</a></div><div class="desc docblock-short">A Cache of fallback textures that uses the sample count and <code>TextureFormat</code> as a key</div></li><li><div class="item-name"><a class="struct" href="struct.FallbackImageMsaa.html" title="struct bevy_render::texture::FallbackImageMsaa">Fallback<wbr>Image<wbr>Msaa</a></div></li><li><div class="item-name"><a class="struct" href="struct.FallbackImageZero.html" title="struct bevy_render::texture::FallbackImageZero">Fallback<wbr>Image<wbr>Zero</a></div><div class="desc docblock-short">A <a href="../struct.RenderApp.html" title="struct bevy_render::RenderApp"><code>RenderApp</code></a> resource that contains a <em>zero-filled</em> “fallback image”,
|
||
which can be used in place of <a href="struct.FallbackImage.html" title="struct bevy_render::texture::FallbackImage"><code>FallbackImage</code></a>, when a fully transparent or black fallback
|
||
is required instead of fully opaque white.</div></li><li><div class="item-name"><a class="struct" href="struct.GpuImage.html" title="struct bevy_render::texture::GpuImage">GpuImage</a></div><div class="desc docblock-short">The GPU-representation of an <a href="../../bevy_image/image/struct.Image.html" title="struct bevy_image::image::Image"><code>Image</code></a>.
|
||
Consists of the <a href="../render_resource/struct.Texture.html" title="struct bevy_render::render_resource::Texture"><code>Texture</code></a>, its <a href="../render_resource/struct.TextureView.html" title="struct bevy_render::render_resource::TextureView"><code>TextureView</code></a> and the corresponding <a href="../render_resource/struct.Sampler.html" title="struct bevy_render::render_resource::Sampler"><code>Sampler</code></a>, and the texture’s size.</div></li><li><div class="item-name"><a class="struct" href="struct.ImagePlugin.html" title="struct bevy_render::texture::ImagePlugin">Image<wbr>Plugin</a></div><div class="desc docblock-short">Adds the <a href="../../bevy_image/image/struct.Image.html" title="struct bevy_image::image::Image"><code>Image</code></a> as an asset and makes sure that they are extracted and prepared for the GPU.</div></li><li><div class="item-name"><a class="struct" href="struct.OutputColorAttachment.html" title="struct bevy_render::texture::OutputColorAttachment">Output<wbr>Color<wbr>Attachment</a></div><div class="desc docblock-short">A wrapper for a <a href="../render_resource/struct.TextureView.html" title="struct bevy_render::render_resource::TextureView"><code>TextureView</code></a> that is used as a <a href="../render_resource/struct.RenderPassColorAttachment.html" title="struct bevy_render::render_resource::RenderPassColorAttachment"><code>RenderPassColorAttachment</code></a> for a view
|
||
target’s final output texture.</div></li><li><div class="item-name"><a class="struct" href="struct.TextureCache.html" title="struct bevy_render::texture::TextureCache">Texture<wbr>Cache</a></div><div class="desc docblock-short">This resource caches textures that are created repeatedly in the rendering process and
|
||
are only required for one frame.</div></li></ul><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.TRANSPARENT_IMAGE_HANDLE.html" title="constant bevy_render::texture::TRANSPARENT_IMAGE_HANDLE">TRANSPARENT_<wbr>IMAGE_<wbr>HANDLE</a></div><div class="desc docblock-short">A handle to a 1 x 1 transparent white image.</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.update_texture_cache_system.html" title="fn bevy_render::texture::update_texture_cache_system">update_<wbr>texture_<wbr>cache_<wbr>system</a></div><div class="desc docblock-short">Updates the <a href="struct.TextureCache.html" title="struct bevy_render::texture::TextureCache"><code>TextureCache</code></a> to only retains recently used textures.</div></li></ul></section></div></main></body></html> |