orion/phy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0ce894e6b0d87f3407c042731f639c638d665e79
phy/bevy_sprite/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

15 lines
28 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="Provides 2D sprite rendering functionality."><title>bevy_sprite - 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_sprite" 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="../crates.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 crate"><!--[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_sprite/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_sprite/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../bevy_sprite/index.html">bevy_<wbr>sprite</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>bevy_sprite</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_sprite/lib.rs.html#2-404">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides 2D sprite rendering functionality.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="prelude/index.html" title="mod bevy_sprite::prelude">prelude</a></div><div class="desc docblock-short">The sprite prelude.</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.BorderRect.html" title="struct bevy_sprite::BorderRect">Border<wbr>Rect</a></div><div class="desc docblock-short">Struct defining a <a href="struct.Sprite.html" title="struct bevy_sprite::Sprite"><code>Sprite</code></a> border with padding values</div></li><li><div class="item-name"><a class="struct" href="struct.ColorMaterial.html" title="struct bevy_sprite::ColorMaterial">Color<wbr>Material</a></div><div class="desc docblock-short">A <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d">2d material</a> that renders <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d">2d meshes</a> with a texture tinted by a uniform color</div></li><li><div class="item-name"><a class="struct" href="struct.ColorMaterialFlags.html" title="struct bevy_sprite::ColorMaterialFlags">Color<wbr>Material<wbr>Flags</a></div></li><li><div class="item-name"><a class="struct" href="struct.ColorMaterialPlugin.html" title="struct bevy_sprite::ColorMaterialPlugin">Color<wbr>Material<wbr>Plugin</a></div></li><li><div class="item-name"><a class="struct" href="struct.ColorMaterialUniform.html" title="struct bevy_sprite::ColorMaterialUniform">Color<wbr>Material<wbr>Uniform</a></div><div class="desc docblock-short">The GPU representation of the uniform data of a <a href="struct.ColorMaterial.html" title="struct bevy_sprite::ColorMaterial"><code>ColorMaterial</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.DrawMesh2d.html" title="struct bevy_sprite::DrawMesh2d">Draw<wbr>Mesh2d</a></div></li><li><div class="item-name"><a class="struct" href="struct.DrawSpriteBatch.html" title="struct bevy_sprite::DrawSpriteBatch">Draw<wbr>Sprite<wbr>Batch</a></div></li><li><div class="item-name"><a class="struct" href="struct.DynamicTextureAtlasBuilder.html" title="struct bevy_sprite::DynamicTextureAtlasBuilder">Dynamic<wbr>Texture<wbr>Atlas<wbr>Builder</a></div><div class="desc docblock-short">Helper utility to update <a href="struct.TextureAtlasLayout.html" title="struct bevy_sprite::TextureAtlasLayout"><code>TextureAtlasLayout</code></a> on the fly.</div></li><li><div class="item-name"><a class="struct" href="struct.ExtractedSprite.html" title="struct bevy_sprite::ExtractedSprite">Extracted<wbr>Sprite</a></div></li><li><div class="item-name"><a class="struct" href="struct.ExtractedSprites.html" title="struct bevy_sprite::ExtractedSprites">Extracted<wbr>Sprites</a></div></li><li><div class="item-name"><a class="struct" href="struct.ImageBindGroups.html" title="struct bevy_sprite::ImageBindGroups">Image<wbr>Bind<wbr>Groups</a></div></li><li><div class="item-name"><a class="struct" href="struct.Material2dBindGroupId.html" title="struct bevy_sprite::Material2dBindGroupId">Material2d<wbr>Bind<wbr>Group<wbr>Id</a></div></li><li><div class="item-name"><a class="struct" href="struct.Material2dKey.html" title="struct bevy_sprite::Material2dKey">Material2d<wbr>Key</a></div></li><li><div class="item-name"><a class="struct" href="struct.Material2dPipeline.html" title="struct bevy_sprite::Material2dPipeline">Material2d<wbr>Pipeline</a></div><div class="desc docblock-short">Render pipeline data for a given <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d"><code>Material2d</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.Material2dPlugin.html" title="struct bevy_sprite::Material2dPlugin">Material2d<wbr>Plugin</a></div><div class="desc docblock-short">Adds the necessary ECS resources and render logic to enable rendering entities using the given <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d"><code>Material2d</code></a>
asset type (which includes <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d"><code>Material2d</code></a> types).</div></li><li><div class="item-name"><a class="struct" href="struct.Material2dProperties.html" title="struct bevy_sprite::Material2dProperties">Material2d<wbr>Properties</a></div><div class="desc docblock-short">Common <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d"><code>Material2d</code></a> properties, calculated for a specific material instance.</div></li><li><div class="item-name"><a class="struct" href="struct.MaterialMesh2dBundle.html" title="struct bevy_sprite::MaterialMesh2dBundle">Material<wbr>Mesh2d<wbr>Bundle</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">A component bundle for entities with a <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d"><code>Mesh2d</code></a> and a <a href="struct.MeshMaterial2d.html" title="struct bevy_sprite::MeshMaterial2d"><code>MeshMaterial2d</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dBindGroup.html" title="struct bevy_sprite::Mesh2dBindGroup">Mesh2d<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dMarker.html" title="struct bevy_sprite::Mesh2dMarker">Mesh2d<wbr>Marker</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dPipeline.html" title="struct bevy_sprite::Mesh2dPipeline">Mesh2d<wbr>Pipeline</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dPipelineKey.html" title="struct bevy_sprite::Mesh2dPipelineKey">Mesh2d<wbr>Pipeline<wbr>Key</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dRenderPlugin.html" title="struct bevy_sprite::Mesh2dRenderPlugin">Mesh2d<wbr>Render<wbr>Plugin</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dTransforms.html" title="struct bevy_sprite::Mesh2dTransforms">Mesh2d<wbr>Transforms</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dUniform.html" title="struct bevy_sprite::Mesh2dUniform">Mesh2d<wbr>Uniform</a></div></li><li><div class="item-name"><a class="struct" href="struct.Mesh2dViewBindGroup.html" title="struct bevy_sprite::Mesh2dViewBindGroup">Mesh2d<wbr>View<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.MeshFlags.html" title="struct bevy_sprite::MeshFlags">Mesh<wbr>Flags</a></div></li><li><div class="item-name"><a class="struct" href="struct.MeshMaterial2d.html" title="struct bevy_sprite::MeshMaterial2d">Mesh<wbr>Material2d</a></div><div class="desc docblock-short">A <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d">material</a> used for rendering a <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d"><code>Mesh2d</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.NoWireframe2d.html" title="struct bevy_sprite::NoWireframe2d">NoWireframe2d</a></div><div class="desc docblock-short">Disables wireframe rendering for any entity it is attached to.
It will ignore the <a href="struct.Wireframe2dConfig.html" title="struct bevy_sprite::Wireframe2dConfig"><code>Wireframe2dConfig</code></a> global setting.</div></li><li><div class="item-name"><a class="struct" href="struct.PreparedMaterial2d.html" title="struct bevy_sprite::PreparedMaterial2d">Prepared<wbr>Material2d</a></div><div class="desc docblock-short">Data prepared for a <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d"><code>Material2d</code></a> instance.</div></li><li><div class="item-name"><a class="struct" href="struct.RenderMaterial2dInstances.html" title="struct bevy_sprite::RenderMaterial2dInstances">Render<wbr>Material2d<wbr>Instances</a></div></li><li><div class="item-name"><a class="struct" href="struct.RenderMesh2dInstance.html" title="struct bevy_sprite::RenderMesh2dInstance">Render<wbr>Mesh2d<wbr>Instance</a></div></li><li><div class="item-name"><a class="struct" href="struct.RenderMesh2dInstances.html" title="struct bevy_sprite::RenderMesh2dInstances">Render<wbr>Mesh2d<wbr>Instances</a></div></li><li><div class="item-name"><a class="struct" href="struct.SetMaterial2dBindGroup.html" title="struct bevy_sprite::SetMaterial2dBindGroup">SetMaterial2d<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.SetMesh2dBindGroup.html" title="struct bevy_sprite::SetMesh2dBindGroup">SetMesh2d<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.SetMesh2dViewBindGroup.html" title="struct bevy_sprite::SetMesh2dViewBindGroup">SetMesh2d<wbr>View<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.SetSpriteTextureBindGroup.html" title="struct bevy_sprite::SetSpriteTextureBindGroup">SetSprite<wbr>Texture<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.SetSpriteViewBindGroup.html" title="struct bevy_sprite::SetSpriteViewBindGroup">SetSprite<wbr>View<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.Sprite.html" title="struct bevy_sprite::Sprite">Sprite</a></div><div class="desc docblock-short">Describes a sprite to be rendered to a 2D camera</div></li><li><div class="item-name"><a class="struct" href="struct.SpriteAssetEvents.html" title="struct bevy_sprite::SpriteAssetEvents">Sprite<wbr>Asset<wbr>Events</a></div></li><li><div class="item-name"><a class="struct" href="struct.SpriteBatch.html" title="struct bevy_sprite::SpriteBatch">Sprite<wbr>Batch</a></div></li><li><div class="item-name"><a class="struct" href="struct.SpriteBundle.html" title="struct bevy_sprite::SpriteBundle">Sprite<wbr>Bundle</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">A <a href="../bevy_ecs/bundle/trait.Bundle.html" title="trait bevy_ecs::bundle::Bundle"><code>Bundle</code></a> of components for drawing a single sprite from an image.</div></li><li><div class="item-name"><a class="struct" href="struct.SpriteMeta.html" title="struct bevy_sprite::SpriteMeta">Sprite<wbr>Meta</a></div></li><li><div class="item-name"><a class="struct" href="struct.SpritePipeline.html" title="struct bevy_sprite::SpritePipeline">Sprite<wbr>Pipeline</a></div></li><li><div class="item-name"><a class="struct" href="struct.SpritePipelineKey.html" title="struct bevy_sprite::SpritePipelineKey">Sprite<wbr>Pipeline<wbr>Key</a></div></li><li><div class="item-name"><a class="struct" href="struct.SpritePlugin.html" title="struct bevy_sprite::SpritePlugin">Sprite<wbr>Plugin</a></div><div class="desc docblock-short">Adds support for 2D sprite rendering.</div></li><li><div class="item-name"><a class="struct" href="struct.SpriteSource.html" title="struct bevy_sprite::SpriteSource">Sprite<wbr>Source</a></div><div class="desc docblock-short">A component that marks entities that aren’t themselves sprites but become
sprites during rendering.</div></li><li><div class="item-name"><a class="struct" href="struct.SpriteViewBindGroup.html" title="struct bevy_sprite::SpriteViewBindGroup">Sprite<wbr>View<wbr>Bind<wbr>Group</a></div></li><li><div class="item-name"><a class="struct" href="struct.TextureAtlas.html" title="struct bevy_sprite::TextureAtlas">Texture<wbr>Atlas</a></div><div class="desc docblock-short">An index into a <a href="struct.TextureAtlasLayout.html" title="struct bevy_sprite::TextureAtlasLayout"><code>TextureAtlasLayout</code></a>, which corresponds to a specific section of a texture.</div></li><li><div class="item-name"><a class="struct" href="struct.TextureAtlasBuilder.html" title="struct bevy_sprite::TextureAtlasBuilder">Texture<wbr>Atlas<wbr>Builder</a></div><div class="desc docblock-short">A builder which is used to create a texture atlas from many individual
sprites.</div></li><li><div class="item-name"><a class="struct" href="struct.TextureAtlasLayout.html" title="struct bevy_sprite::TextureAtlasLayout">Texture<wbr>Atlas<wbr>Layout</a></div><div class="desc docblock-short">Stores a map used to lookup the position of a texture in a <a href="struct.TextureAtlas.html" title="struct bevy_sprite::TextureAtlas"><code>TextureAtlas</code></a>.
This can be used to either use and look up a specific section of a texture, or animate frame-by-frame as a sprite sheet.</div></li><li><div class="item-name"><a class="struct" href="struct.TextureAtlasSources.html" title="struct bevy_sprite::TextureAtlasSources">Texture<wbr>Atlas<wbr>Sources</a></div><div class="desc docblock-short">Stores a mapping from sub texture handles to the related area index.</div></li><li><div class="item-name"><a class="struct" href="struct.TextureSlice.html" title="struct bevy_sprite::TextureSlice">Texture<wbr>Slice</a></div><div class="desc docblock-short">Single texture slice, representing a texture rect to draw in a given area</div></li><li><div class="item-name"><a class="struct" href="struct.TextureSlicer.html" title="struct bevy_sprite::TextureSlicer">Texture<wbr>Slicer</a></div><div class="desc docblock-short">Slices a texture using the <strong>9-slicing</strong> technique. This allows to reuse an image at various sizes
without needing to prepare multiple assets. The associated texture will be split into nine portions,
so that on resize the different portions scale or tile in different ways to keep the texture in proportion.</div></li><li><div class="item-name"><a class="struct" href="struct.Wireframe2d.html" title="struct bevy_sprite::Wireframe2d">Wireframe2d</a></div><div class="desc docblock-short">Enables wireframe rendering for any entity it is attached to.
It will ignore the <a href="struct.Wireframe2dConfig.html" title="struct bevy_sprite::Wireframe2dConfig"><code>Wireframe2dConfig</code></a> global setting.</div></li><li><div class="item-name"><a class="struct" href="struct.Wireframe2dColor.html" title="struct bevy_sprite::Wireframe2dColor">Wireframe2d<wbr>Color</a></div><div class="desc docblock-short">Sets the color of the <a href="struct.Wireframe2d.html" title="struct bevy_sprite::Wireframe2d"><code>Wireframe2d</code></a> of the entity it is attached to.</div></li><li><div class="item-name"><a class="struct" href="struct.Wireframe2dConfig.html" title="struct bevy_sprite::Wireframe2dConfig">Wireframe2d<wbr>Config</a></div></li><li><div class="item-name"><a class="struct" href="struct.Wireframe2dMaterial.html" title="struct bevy_sprite::Wireframe2dMaterial">Wireframe2d<wbr>Material</a></div></li><li><div class="item-name"><a class="struct" href="struct.Wireframe2dPlugin.html" title="struct bevy_sprite::Wireframe2dPlugin">Wireframe2d<wbr>Plugin</a></div><div class="desc docblock-short">A <a href="../bevy_app/plugin/trait.Plugin.html" title="trait bevy_app::plugin::Plugin"><code>Plugin</code></a> that draws wireframes for 2D meshes.</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.AlphaMode2d.html" title="enum bevy_sprite::AlphaMode2d">Alpha<wbr>Mode2d</a></div><div class="desc docblock-short">Sets how a 2d material’s base color alpha channel is used for transparency.
Currently, this only works with <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d"><code>Mesh2d</code></a>. Sprites are always transparent.</div></li><li><div class="item-name"><a class="enum" href="enum.Anchor.html" title="enum bevy_sprite::Anchor">Anchor</a></div><div class="desc docblock-short">How a sprite is positioned relative to its <a href="../bevy_transform/components/transform/struct.Transform.html" title="struct bevy_transform::components::transform::Transform"><code>Transform</code></a>.
It defaults to <code>Anchor::Center</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.SliceScaleMode.html" title="enum bevy_sprite::SliceScaleMode">Slice<wbr>Scale<wbr>Mode</a></div><div class="desc docblock-short">Defines how a texture slice scales when resized</div></li><li><div class="item-name"><a class="enum" href="enum.SpriteImageMode.html" title="enum bevy_sprite::SpriteImageMode">Sprite<wbr>Image<wbr>Mode</a></div><div class="desc docblock-short">Controls how the image is altered when scaled.</div></li><li><div class="item-name"><a class="enum" href="enum.SpriteSystem.html" title="enum bevy_sprite::SpriteSystem">Sprite<wbr>System</a></div><div class="desc docblock-short">System set for sprite rendering.</div></li><li><div class="item-name"><a class="enum" href="enum.TextureAtlasBuilderError.html" title="enum bevy_sprite::TextureAtlasBuilderError">Texture<wbr>Atlas<wbr>Builder<wbr>Error</a></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.COLOR_MATERIAL_SHADER_HANDLE.html" title="constant bevy_sprite::COLOR_MATERIAL_SHADER_HANDLE">COLOR_<wbr>MATERIAL_<wbr>SHADER_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_BINDINGS_HANDLE.html" title="constant bevy_sprite::MESH2D_BINDINGS_HANDLE">MESH2D_<wbr>BINDINGS_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_FUNCTIONS_HANDLE.html" title="constant bevy_sprite::MESH2D_FUNCTIONS_HANDLE">MESH2D_<wbr>FUNCTIONS_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_SHADER_HANDLE.html" title="constant bevy_sprite::MESH2D_SHADER_HANDLE">MESH2D_<wbr>SHADER_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_TYPES_HANDLE.html" title="constant bevy_sprite::MESH2D_TYPES_HANDLE">MESH2D_<wbr>TYPES_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_VERTEX_OUTPUT.html" title="constant bevy_sprite::MESH2D_VERTEX_OUTPUT">MESH2D_<wbr>VERTEX_<wbr>OUTPUT</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_VIEW_BINDINGS_HANDLE.html" title="constant bevy_sprite::MESH2D_VIEW_BINDINGS_HANDLE">MESH2D_<wbr>VIEW_<wbr>BINDINGS_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.MESH2D_VIEW_TYPES_HANDLE.html" title="constant bevy_sprite::MESH2D_VIEW_TYPES_HANDLE">MESH2D_<wbr>VIEW_<wbr>TYPES_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.SPRITE_SHADER_HANDLE.html" title="constant bevy_sprite::SPRITE_SHADER_HANDLE">SPRITE_<wbr>SHADER_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.SPRITE_VIEW_BINDINGS_SHADER_HANDLE.html" title="constant bevy_sprite::SPRITE_VIEW_BINDINGS_SHADER_HANDLE">SPRITE_<wbr>VIEW_<wbr>BINDINGS_<wbr>SHADER_<wbr>HANDLE</a></div></li><li><div class="item-name"><a class="constant" href="constant.WIREFRAME_2D_SHADER_HANDLE.html" title="constant bevy_sprite::WIREFRAME_2D_SHADER_HANDLE">WIREFRAME_<wbr>2D_<wbr>SHADER_<wbr>HANDLE</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.Material2d.html" title="trait bevy_sprite::Material2d">Material2d</a></div><div class="desc docblock-short">Materials are used alongside <a href="struct.Material2dPlugin.html" title="struct bevy_sprite::Material2dPlugin"><code>Material2dPlugin</code></a>, <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d"><code>Mesh2d</code></a>, and <a href="struct.MeshMaterial2d.html" title="struct bevy_sprite::MeshMaterial2d"><code>MeshMaterial2d</code></a>
to spawn entities that are rendered with a specific <a href="trait.Material2d.html" title="trait bevy_sprite::Material2d"><code>Material2d</code></a> type. They serve as an easy to use high level
way to render <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d"><code>Mesh2d</code></a> entities with custom shader logic.</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.alpha_mode_pipeline_key.html" title="fn bevy_sprite::alpha_mode_pipeline_key">alpha_<wbr>mode_<wbr>pipeline_<wbr>key</a></div></li><li><div class="item-name"><a class="fn" href="fn.calculate_bounds_2d.html" title="fn bevy_sprite::calculate_bounds_2d">calculate_<wbr>bounds_<wbr>2d</a></div><div class="desc docblock-short">System calculating and inserting an <a href="../bevy_render/primitives/struct.Aabb.html" title="struct bevy_render::primitives::Aabb"><code>Aabb</code></a> component to entities with either:</div></li><li><div class="item-name"><a class="fn" href="fn.extract_mesh2d.html" title="fn bevy_sprite::extract_mesh2d">extract_<wbr>mesh2d</a></div></li><li><div class="item-name"><a class="fn" href="fn.extract_mesh_materials_2d.html" title="fn bevy_sprite::extract_mesh_materials_2d">extract_<wbr>mesh_<wbr>materials_<wbr>2d</a></div></li><li><div class="item-name"><a class="fn" href="fn.extract_sprite_events.html" title="fn bevy_sprite::extract_sprite_events">extract_<wbr>sprite_<wbr>events</a></div></li><li><div class="item-name"><a class="fn" href="fn.extract_sprites.html" title="fn bevy_sprite::extract_sprites">extract_<wbr>sprites</a></div></li><li><div class="item-name"><a class="fn" href="fn.prepare_mesh2d_bind_group.html" title="fn bevy_sprite::prepare_mesh2d_bind_group">prepare_<wbr>mesh2d_<wbr>bind_<wbr>group</a></div></li><li><div class="item-name"><a class="fn" href="fn.prepare_mesh2d_view_bind_groups.html" title="fn bevy_sprite::prepare_mesh2d_view_bind_groups">prepare_<wbr>mesh2d_<wbr>view_<wbr>bind_<wbr>groups</a></div></li><li><div class="item-name"><a class="fn" href="fn.prepare_sprite_image_bind_groups.html" title="fn bevy_sprite::prepare_sprite_image_bind_groups">prepare_<wbr>sprite_<wbr>image_<wbr>bind_<wbr>groups</a></div></li><li><div class="item-name"><a class="fn" href="fn.prepare_sprite_view_bind_groups.html" title="fn bevy_sprite::prepare_sprite_view_bind_groups">prepare_<wbr>sprite_<wbr>view_<wbr>bind_<wbr>groups</a></div></li><li><div class="item-name"><a class="fn" href="fn.queue_material2d_meshes.html" title="fn bevy_sprite::queue_material2d_meshes">queue_<wbr>material2d_<wbr>meshes</a></div></li><li><div class="item-name"><a class="fn" href="fn.queue_sprites.html" title="fn bevy_sprite::queue_sprites">queue_<wbr>sprites</a></div></li><li><div class="item-name"><a class="fn" href="fn.tonemapping_pipeline_key.html" title="fn bevy_sprite::tonemapping_pipeline_key">tonemapping_<wbr>pipeline_<wbr>key</a></div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ColorMesh2dBundle.html" title="type bevy_sprite::ColorMesh2dBundle">Color<wbr>Mesh2d<wbr>Bundle</a><wbr><span class="stab deprecated" title="">Deprecated</span></div><div class="desc docblock-short">A component bundle for entities with a <a href="../bevy_render/mesh/components/struct.Mesh2d.html" title="struct bevy_render::mesh::components::Mesh2d"><code>Mesh2d</code></a> and a <a href="struct.ColorMaterial.html" title="struct bevy_sprite::ColorMaterial"><code>ColorMaterial</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.DrawSprite.html" title="type bevy_sprite::DrawSprite">Draw<wbr>Sprite</a></div><div class="desc docblock-short"><a href="../bevy_render/render_phase/draw/trait.RenderCommand.html" title="trait bevy_render::render_phase::draw::RenderCommand"><code>RenderCommand</code></a> for sprite rendering.</div></li><li><div class="item-name"><a class="type" href="type.TextureAtlasBuilderResult.html" title="type bevy_sprite::TextureAtlasBuilderResult">Texture<wbr>Atlas<wbr>Builder<wbr>Result</a></div></li><li><div class="item-name"><a class="type" href="type.WithSprite.html" title="type bevy_sprite::WithSprite">With<wbr>Sprite</a></div><div class="desc docblock-short">A convenient alias for <code>Or&lt;With&lt;Sprite&gt;, With&lt;SpriteSource&gt;&gt;</code>, for use with
<a href="../bevy_render/view/visibility/struct.VisibleEntities.html" title="struct bevy_render::view::visibility::VisibleEntities"><code>bevy_render::view::VisibleEntities</code></a>.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink