You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/vulkano/pipeline/trait.GraphicsPipelineAbstr...

35 lines
26 KiB

5 years ago
<!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 `GraphicsPipelineAbstract` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, GraphicsPipelineAbstract"><title>vulkano::pipeline::GraphicsPipelineAbstract - Rust</title><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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../vulkano/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png' alt='logo'></div></a><p class='location'>Trait GraphicsPipelineAbstract</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.has_dynamic_depth_bounds">has_dynamic_depth_bounds</a><a href="#tymethod.has_dynamic_line_width">has_dynamic_line_width</a><a href="#tymethod.has_dynamic_scissors">has_dynamic_scissors</a><a href="#tymethod.has_dynamic_stencil_compare_mask">has_dynamic_stencil_compare_mask</a><a href="#tymethod.has_dynamic_stencil_reference">has_dynamic_stencil_reference</a><a href="#tymethod.has_dynamic_stencil_write_mask">has_dynamic_stencil_write_mask</a><a href="#tymethod.has_dynamic_viewports">has_dynamic_viewports</a><a href="#tymethod.inner">inner</a><a href="#tymethod.num_viewports">num_viewports</a><a href="#tymethod.subpass_index">subpass_index</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.subpass">subpass</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>pipeline</a></p><script>window.sidebarCurrent = {name: 'GraphicsPipelineAbstract', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><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><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#327-364' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>pipeline</a>::<wbr><a class="trait" href=''>GraphicsPipelineAbstract</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait GraphicsPipelineAbstract: <a class="trait" href
fn <a href='#tymethod.inner' class='fnname'>inner</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/pipeline/struct.GraphicsPipelineSys.html" title="struct vulkano::pipeline::GraphicsPipelineSys">GraphicsPipelineSys</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.subpass_index' class='fnname'>subpass_index</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_line_width' class='fnname'>has_dynamic_line_width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.num_viewports' class='fnname'>num_viewports</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_viewports' class='fnname'>has_dynamic_viewports</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_scissors' class='fnname'>has_dynamic_scissors</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_depth_bounds' class='fnname'>has_dynamic_depth_bounds</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_stencil_compare_mask' class='fnname'>has_dynamic_stencil_compare_mask</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_stencil_write_mask' class='fnname'>has_dynamic_stencil_write_mask</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.has_dynamic_stencil_reference' class='fnname'>has_dynamic_stencil_reference</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
fn <a href='#method.subpass' class='fnname'>subpass</a>(self) -&gt; <a class="struct" href="../../vulkano/framebuffer/struct.Subpass.html" title="struct vulkano::framebuffer::Subpass">Subpass</a>&lt;Self&gt;<br>&nbsp;&nbsp;&nbsp; <span class="where">where<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
{ ... }
}</pre></div><div class='docblock'><p>Trait implemented on objects that reference a graphics pipeline. Can be made into a trait
object.
When using this trait <code>AutoCommandBufferBuilder::draw*</code> calls will need the buffers to be
wrapped in a <code>vec!()</code>.</p>
</div>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.inner' class='method'><code id='inner.v'>fn <a href='#tymethod.inner' class='fnname'>inner</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/pipeline/struct.GraphicsPipelineSys.html" title="struct vulkano::pipeline::GraphicsPipelineSys">GraphicsPipelineSys</a></code></h3><div class='docblock'><p>Returns an opaque object that represents the inside of the graphics pipeline.</p>
</div><h3 id='tymethod.subpass_index' class='method'><code id='subpass_index.v'>fn <a href='#tymethod.subpass_index' class='fnname'>subpass_index</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Returns the index of the subpass this graphics pipeline is rendering to.</p>
</div><h3 id='tymethod.has_dynamic_line_width' class='method'><code id='has_dynamic_line_width.v'>fn <a href='#tymethod.has_dynamic_line_width' class='fnname'>has_dynamic_line_width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the line width used by this pipeline is dynamic.</p>
</div><h3 id='tymethod.num_viewports' class='method'><code id='num_viewports.v'>fn <a href='#tymethod.num_viewports' class='fnname'>num_viewports</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Returns the number of viewports and scissors of this pipeline.</p>
</div><h3 id='tymethod.has_dynamic_viewports' class='method'><code id='has_dynamic_viewports.v'>fn <a href='#tymethod.has_dynamic_viewports' class='fnname'>has_dynamic_viewports</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the viewports used by this pipeline are dynamic.</p>
</div><h3 id='tymethod.has_dynamic_scissors' class='method'><code id='has_dynamic_scissors.v'>fn <a href='#tymethod.has_dynamic_scissors' class='fnname'>has_dynamic_scissors</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the scissors used by this pipeline are dynamic.</p>
</div><h3 id='tymethod.has_dynamic_depth_bounds' class='method'><code id='has_dynamic_depth_bounds.v'>fn <a href='#tymethod.has_dynamic_depth_bounds' class='fnname'>has_dynamic_depth_bounds</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the depth bounds used by this pipeline are dynamic.</p>
</div><h3 id='tymethod.has_dynamic_stencil_compare_mask' class='method'><code id='has_dynamic_stencil_compare_mask.v'>fn <a href='#tymethod.has_dynamic_stencil_compare_mask' class='fnname'>has_dynamic_stencil_compare_mask</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the stencil compare masks used by this pipeline are dynamic.</p>
</div><h3 id='tymethod.has_dynamic_stencil_write_mask' class='method'><code id='has_dynamic_stencil_write_mask.v'>fn <a href='#tymethod.has_dynamic_stencil_write_mask' class='fnname'>has_dynamic_stencil_write_mask</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the stencil write masks used by this pipeline are dynamic.</p>
</div><h3 id='tymethod.has_dynamic_stencil_reference' class='method'><code id='has_dynamic_stencil_reference.v'>fn <a href='#tymethod.has_dynamic_stencil_reference' class='fnname'>has_dynamic_stencil_reference</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the stencil references used by this pipeline are dynamic.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.subpass' class='method'><code id='subpass.v'>fn <a href='#method.subpass' class='fnname'>subpass</a>(self) -&gt; <a class="struct" href="../../vulkano/framebuffer/struct.Subpass.html" title="struct vulkano::framebuffer::Subpass">Subpass</a>&lt;Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></h3><div class='docblock'><p>Returns the subpass this graphics pipeline is rendering to.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-GraphicsPipelineAbstract' class='impl'><code class='in-band'>impl&lt;Mv, L, Rp&gt; GraphicsPipelineAbstract for <a class="struct" href="../../vulkano/pipeline/struct.GraphicsPipeline.html" title="struct vulkano::pipeline::GraphicsPipeline">GraphicsPipeline</a>&lt;Mv, L, Rp&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;L: <a class="trait" href="../../vulkano/descriptor/pipeline_layout/trait.PipelineLayoutAbstract.html" title="trait vulkano::descriptor::pipeline_layout::PipelineLayoutAbstract">PipelineLayoutAbstract</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;Rp: <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassAbstract.html" title="trait vulkano::framebuffer::RenderPassAbstract">RenderPassAbstract</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;Mv: <a class="trait" href="../../vulkano/pipeline/vertex/trait.VertexSource.html" title="trait vulkano::pipeline::vertex::VertexSource">VertexSource</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;dyn <a class="trait" href="../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>&gt;&gt;&gt;,&nbsp;</span></code><a href='#impl-GraphicsPipelineAbstract' class='anchor'></a><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#366-420' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.inner' class="method hidden"><code id='inner.v-1'>fn <a href='#method.inner' class='fnname'>inner</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/pipeline/struct.GraphicsPipelineSys.html" title="struct vulkano::pipeline::GraphicsPipelineSys">GraphicsPipelineSys</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#372-374' title='goto source code'>[src]</a></h4><h4 id='method.subpass_index' class="method hidden"><code id='subpass_index.v-1'>fn <a href='#method.subpass_index' class='fnname'>subpass_index</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#377-379' title='goto source code'>[src]</a></h4><h4 id='method.has_dynamic_line_width' class="method hidden"><code id='has_dynamic_line_width.v-1'>fn <a href='#method.has_dynamic_line_width' class='fnname'>has_dynamic_line_width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#382-384' title='goto source code'>[src]</a></h4><h4 id='method.num_viewports' class="method hidden"><code id='num_viewports.v-1'>fn <a href='#method.num_viewports' class='fnname'>num_viewports</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#387-389' title='goto source code'>[src]</a></h4><h4 id='method.has_dynamic_viewports' class="method hidden"><code id='has_dynamic_viewports.v-1'>fn <a href='#method.has_dynamic_viewports' class='fnname'>has_dynamic_viewports</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#392-394' title='goto source code'>[src]</a></h4><h4 id='method.h
src="../../implementors/vulkano/pipeline/trait.GraphicsPipelineAbstract.js">
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd></kbd></dt><dd>Move up in search results</dd><dt><kbd></kbd></dt><dd>Move down in search results</dd><dt><kbd></kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "vulkano";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>