bringing docs up to date

This commit is contained in:
2020-02-13 17:14:29 -08:00
parent 659cd98a1f
commit fcfa40e335
112 changed files with 869 additions and 1837 deletions

View File

@@ -6,8 +6,8 @@
}</pre></div><div class='docblock'><p>Inheriting this gives private functions to grab resources</p>
</div>
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.get_path' class='method'><code id='get_path.v'>fn <a href='#method.get_path' class='fnname'>get_path</a>(filename: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, shader_type: <a class="enum" href="../../../../../sfml_rust/canvas/managed/shader/shader_common/enum.ShaderType.html" title="enum sfml_rust::canvas::managed::shader::shader_common::ShaderType">ShaderType</a>) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a></code></h3><h3 id='method.compile' class='method'><code id='compile.v'>fn <a href='#method.compile' class='fnname'>compile</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;filepath: <a class="struct" href="https://doc.rust-lang.org/nightly/std/path/struct.PathBuf.html" title="struct std::path::PathBuf">PathBuf</a>, <br>&nbsp;&nbsp;&nbsp;&nbsp;device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;Device&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;shader_type: <a class="enum" href="../../../../../sfml_rust/canvas/managed/shader/shader_common/enum.ShaderType.html" title="enum sfml_rust::canvas::managed::shader::shader_common::ShaderType">ShaderType</a><br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Entry, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;ShaderModule&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><h3 id='method.convert_vk' class='method'><code id='convert_vk.v'>fn <a href='#method.convert_vk' class='fnname'>convert_vk</a>(shader_type: <a class="enum" href="../../../../../sfml_rust/canvas/managed/shader/shader_common/enum.ShaderType.html" title="enum sfml_rust::canvas::managed::shader::shader_common::ShaderType">ShaderType</a>) -&gt; GraphicsShaderType</code></h3><h3 id='method.convert_sr' class='method'><code id='convert_sr.v'>fn <a href='#method.convert_sr' class='fnname'>convert_sr</a>(shader_type: <a class="enum" href="../../../../../sfml_rust/canvas/managed/shader/shader_common/enum.ShaderType.html" title="enum sfml_rust::canvas::managed::shader::shader_common::ShaderType">ShaderType</a>) -&gt; ShaderKind</code></h3></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-CompiledGraphicsPipelineResources' class='impl'><code class='in-band'>impl CompiledGraphicsPipelineResources for <a class="struct" href="../../../../../sfml_rust/canvas/managed/shader/generic_shader/struct.GenericShader.html" title="struct sfml_rust::canvas::managed::shader::generic_shader::GenericShader">GenericShader</a></code><a href='#impl-CompiledGraphicsPipelineResources' class='anchor'></a><a class='srclink' href='../../../../../src/sfml_rust/canvas/managed/shader/generic_shader.rs.html#39' title='goto source code'>[src]</a></h3><div class='docblock'><p>Gives CanvasShader the resource functions</p>
</div><div class='impl-items'></div><h3 id='impl-CompiledGraphicsPipelineResources-1' class='impl'><code class='in-band'>impl CompiledGraphicsPipelineResources for <a class="struct" href="../../../../../sfml_rust/canvas/managed/shader/text_shader/struct.TextShader.html" title="struct sfml_rust::canvas::managed::shader::text_shader::TextShader">TextShader</a></code><a href='#impl-CompiledGraphicsPipelineResources-1' class='anchor'></a><a class='srclink' href='../../../../../src/sfml_rust/canvas/managed/shader/text_shader.rs.html#45' title='goto source code'>[src]</a></h3><div class='docblock'><p>Gives CanvasShader the resource functions</p>
<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-CompiledGraphicsPipelineResources' class='impl'><code class='in-band'>impl CompiledGraphicsPipelineResources for <a class="struct" href="../../../../../sfml_rust/canvas/managed/shader/generic_shader/struct.GenericShader.html" title="struct sfml_rust::canvas::managed::shader::generic_shader::GenericShader">GenericShader</a></code><a href='#impl-CompiledGraphicsPipelineResources' class='anchor'></a><a class='srclink' href='../../../../../src/sfml_rust/canvas/managed/shader/generic_shader.rs.html#38' title='goto source code'>[src]</a></h3><div class='docblock'><p>Gives CanvasShader the resource functions</p>
</div><div class='impl-items'></div><h3 id='impl-CompiledGraphicsPipelineResources-1' class='impl'><code class='in-band'>impl CompiledGraphicsPipelineResources for <a class="struct" href="../../../../../sfml_rust/canvas/managed/shader/text_shader/struct.TextShader.html" title="struct sfml_rust::canvas::managed::shader::text_shader::TextShader">TextShader</a></code><a href='#impl-CompiledGraphicsPipelineResources-1' class='anchor'></a><a class='srclink' href='../../../../../src/sfml_rust/canvas/managed/shader/text_shader.rs.html#44' title='goto source code'>[src]</a></h3><div class='docblock'><p>Gives CanvasShader the resource functions</p>
</div><div class='impl-items'></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../../../../implementors/sfml_rust/canvas/managed/shader/shader_common/trait.CompiledGraphicsPipelineResources.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 = "sfml_rust";</script><script src="../../../../../aliases.js"></script><script src="../../../../../main.js"></script><script defer src="../../../../../search-index.js"></script></body></html>