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

6 lines
9.2 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 `bevy_mesh` crate."><title>bevy_mesh - 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_mesh" 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="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../bevy_mesh/index.html">bevy_<wbr>mesh</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></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_mesh</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_mesh/lib.rs.html#2-58">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"><code>pub use <a class="mod" href="primitives/index.html" title="mod bevy_mesh::primitives">primitives</a>::*;</code></div></li></ul><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="morph/index.html" title="mod bevy_mesh::morph">morph</a></div></li><li><div class="item-name"><a class="mod" href="primitives/index.html" title="mod bevy_mesh::primitives">primitives</a></div><div class="desc docblock-short">Mesh generation for <a href="../bevy_math/primitives/index.html" title="mod bevy_math::primitives">primitive shapes</a>.</div></li><li><div class="item-name"><a class="mod" href="skinning/index.html" title="mod bevy_mesh::skinning">skinning</a></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.BaseMeshPipelineKey.html" title="struct bevy_mesh::BaseMeshPipelineKey">Base<wbr>Mesh<wbr>Pipeline<wbr>Key</a></div><div class="desc docblock-short">Our base mesh pipeline key bits start from the highest bit and go
downward. The PBR mesh pipeline key bits start from the lowest bit and
go upward. This allows the PBR bits in the downstream crate <code>bevy_pbr</code>
to coexist in the same field without any shifts.</div></li><li><div class="item-name"><a class="struct" href="struct.Mesh.html" title="struct bevy_mesh::Mesh">Mesh</a></div><div class="desc docblock-short">A 3D object made out of vertices representing triangles, lines, or points,
with “attribute” values for each vertex.</div></li><li><div class="item-name"><a class="struct" href="struct.MeshVertexAttribute.html" title="struct bevy_mesh::MeshVertexAttribute">Mesh<wbr>Vertex<wbr>Attribute</a></div></li><li><div class="item-name"><a class="struct" href="struct.MeshVertexAttributeId.html" title="struct bevy_mesh::MeshVertexAttributeId">Mesh<wbr>Vertex<wbr>Attribute<wbr>Id</a></div></li><li><div class="item-name"><a class="struct" href="struct.MeshVertexBufferLayout.html" title="struct bevy_mesh::MeshVertexBufferLayout">Mesh<wbr>Vertex<wbr>Buffer<wbr>Layout</a></div></li><li><div class="item-name"><a class="struct" href="struct.MeshVertexBufferLayoutRef.html" title="struct bevy_mesh::MeshVertexBufferLayoutRef">Mesh<wbr>Vertex<wbr>Buffer<wbr>Layout<wbr>Ref</a></div><div class="desc docblock-short">Describes the layout of the mesh vertices in GPU memory.</div></li><li><div class="item-name"><a class="struct" href="struct.MeshVertexBufferLayouts.html" title="struct bevy_mesh::MeshVertexBufferLayouts">Mesh<wbr>Vertex<wbr>Buffer<wbr>Layouts</a></div><div class="desc docblock-short">Stores the single copy of each mesh vertex buffer layout.</div></li><li><div class="item-name"><a class="struct" href="struct.MissingVertexAttributeError.html" title="struct bevy_mesh::MissingVertexAttributeError">Missing<wbr>Vertex<wbr>Attribute<wbr>Error</a></div></li><li><div class="item-name"><a class="struct" href="struct.VertexAttributeDescriptor.html" title="struct bevy_mesh::VertexAttributeDescriptor">Vertex<wbr>Attribute<wbr>Descriptor</a></div></li><li><div class="item-name"><a class="struct" href="struct.VertexBufferLayout.html" title="struct bevy_mesh::VertexBufferLayout">Vertex<wbr>Buffer<wbr>Layout</a></div><div class="desc docblock-short">Describes how the vertex buffer is interpreted.</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.GenerateTangentsError.html" title="enum bevy_mesh::GenerateTangentsError">Generate<wbr>Tangents<wbr>Error</a></div><div class="desc docblock-short">Failed to generate tangents for the mesh.</div></li><li><div class="item-name"><a class="enum" href="enum.Indices.html" title="enum bevy_mesh::Indices">Indices</a></div><div class="desc docblock-short">An array of indices into the <a href="enum.VertexAttributeValues.html" title="enum bevy_mesh::VertexAttributeValues"><code>VertexAttributeValues</code></a> for a mesh.</div></li><li><div class="item-name"><a class="enum" href="enum.MeshTrianglesError.html" title="enum bevy_mesh::MeshTrianglesError">Mesh<wbr>Triangles<wbr>Error</a></div><div class="desc docblock-short">An error that occurred while trying to extract a collection of triangles from a <a href="struct.Mesh.html" title="struct bevy_mesh::Mesh"><code>Mesh</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.MeshWindingInvertError.html" title="enum bevy_mesh::MeshWindingInvertError">Mesh<wbr>Winding<wbr>Invert<wbr>Error</a></div><div class="desc docblock-short">An error that occurred while trying to invert the winding of a <a href="struct.Mesh.html" title="struct bevy_mesh::Mesh"><code>Mesh</code></a>.</div></li><li><div class="item-name"><a class="enum" href="enum.PrimitiveTopology.html" title="enum bevy_mesh::PrimitiveTopology">Primitive<wbr>Topology</a></div><div class="desc docblock-short">Primitive type the input mesh is composed of.</div></li><li><div class="item-name"><a class="enum" href="enum.VertexAttributeValues.html" title="enum bevy_mesh::VertexAttributeValues">Vertex<wbr>Attribute<wbr>Values</a></div><div class="desc docblock-short">Contains an array where each entry describes a property of a single vertex.
Matches the <a href="../wgpu_types/enum.VertexFormat.html" title="enum wgpu_types::VertexFormat"><code>VertexFormats</code></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.INDEX_BUFFER_ASSET_INDEX.html" title="constant bevy_mesh::INDEX_BUFFER_ASSET_INDEX">INDEX_<wbr>BUFFER_<wbr>ASSET_<wbr>INDEX</a></div></li><li><div class="item-name"><a class="constant" href="constant.VERTEX_ATTRIBUTE_BUFFER_ID.html" title="constant bevy_mesh::VERTEX_ATTRIBUTE_BUFFER_ID">VERTEX_<wbr>ATTRIBUTE_<wbr>BUFFER_<wbr>ID</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.VertexFormatSize.html" title="trait bevy_mesh::VertexFormatSize">Vertex<wbr>Format<wbr>Size</a></div></li></ul></section></div></main></body></html>