bringing docs up to date

This commit is contained in:
2020-02-04 23:02:43 -08:00
parent 8fcd26063a
commit f3f52becb4
140 changed files with 718 additions and 1612 deletions

View File

@@ -651,9 +651,6 @@
<span id="651">651</span>
<span id="652">652</span>
<span id="653">653</span>
<span id="654">654</span>
<span id="655">655</span>
<span id="656">656</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">command_buffer</span>::{<span class="ident">AutoCommandBufferBuilder</span>, <span class="ident">DynamicState</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::{<span class="ident">HashMap</span>, <span class="ident">HashSet</span>};
@@ -677,20 +674,19 @@
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">descriptor</span>::<span class="ident">descriptor</span>::<span class="ident">DescriptorDescTy</span>::<span class="ident">TexelBuffer</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">canvas_frame</span>::<span class="ident">CanvasFrame</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">hash</span>::<span class="ident">Hash</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">canvas_buffer</span>::{<span class="ident">CanvasImage</span>, <span class="ident">CanvasTexture</span>, <span class="ident">CanvasFont</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">util</span>::<span class="ident">vertex_3d</span>::{<span class="ident">Vertex3D</span>, <span class="ident">TextVertex3D</span>};
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">pipeline</span>::<span class="ident">depth_stencil</span>::{<span class="ident">StencilFaceFlags</span>, <span class="ident">DynamicStencilValue</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">shader</span>::<span class="ident">common</span>::{<span class="ident">CompiledGraphicsPipeline</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">shader</span>::<span class="ident">generic_shader</span>::<span class="ident">GenericShader</span>;
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">PotentialDedicatedAllocation</span>::<span class="ident">Generic</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">borrow</span>::<span class="ident">Borrow</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">shader</span>::<span class="ident">text_shader</span>::<span class="ident">GlyphInstance</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fs</span>::<span class="ident">File</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Read</span>;
<span class="kw">use</span> <span class="ident">rusttype</span>::{<span class="ident">Font</span>, <span class="ident">PositionedGlyph</span>, <span class="ident">Scale</span>, <span class="ident">Rect</span>, <span class="ident">point</span>, <span class="ident">GlyphId</span>};
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">pipeline</span>::<span class="ident">vertex</span>::<span class="ident">VertexDefinition</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::{<span class="ident">CanvasTextureHandle</span>, <span class="ident">CanvasImageHandle</span>, <span class="ident">CanvasFontHandle</span>, <span class="ident">CompiledGraphicsPipelineHandle</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">shader</span>::<span class="ident">dynamic_vertex</span>::<span class="ident">RuntimeVertexDef</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">managed</span>::<span class="ident">shader</span>::<span class="ident">dynamic_vertex</span>::<span class="ident">RuntimeVertexDef</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">managed</span>::<span class="ident">handles</span>::{<span class="ident">CanvasTextureHandle</span>, <span class="ident">CanvasImageHandle</span>, <span class="ident">CanvasFontHandle</span>, <span class="ident">CompiledGraphicsPipelineHandle</span>, <span class="ident">Handle</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">managed</span>::<span class="ident">gpu_buffers</span>::{<span class="ident">CanvasImage</span>, <span class="ident">CanvasTexture</span>, <span class="ident">CanvasFont</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">managed</span>::<span class="ident">shader</span>::<span class="ident">shader_common</span>::<span class="ident">CompiledGraphicsPipeline</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">canvas</span>::<span class="ident">managed</span>::<span class="ident">shader</span>::<span class="ident">generic_shader</span>::<span class="ident">GenericShader</span>;
<span class="comment">// I don&#39;t think this is going to work without getting into Box&#39;ing</span>
@@ -729,8 +725,6 @@
}
}
<span class="doccomment">/// Canvas state is used for storage of texture and image buffers in addition to vertex buffers</span>
<span class="doccomment">/// Canvas state also contains logic for writing the stored buffers to the command_buffer</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>)]</span>
@@ -897,7 +891,7 @@
<span class="doccomment">/// Return the image buffer from an input image handle</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_image</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">image_handle</span>: <span class="ident">Arc</span><span class="op">&lt;</span><span class="ident">CanvasImageHandle</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="ident">Arc</span><span class="op">&lt;</span><span class="ident">AttachmentImage</span><span class="op">&gt;</span> {
<span class="self">self</span>.<span class="ident">image_buffers</span>.<span class="ident">get</span>((<span class="kw-2">*</span><span class="ident">image_handle</span>).<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">unwrap</span>()
<span class="self">self</span>.<span class="ident">image_buffers</span>.<span class="ident">get</span>((<span class="kw-2">*</span><span class="ident">image_handle</span>).<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>).<span class="ident">unwrap</span>()
.<span class="ident">clone</span>().<span class="ident">buffer</span>.<span class="ident">clone</span>()
}
@@ -1064,7 +1058,7 @@
<span class="doccomment">/// Using the texture handle, grab the stored texture and return the buffer</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">get_texture</span>(<span class="kw-2">&amp;</span><span class="self">self</span>, <span class="ident">texture_handle</span>: <span class="ident">Arc</span><span class="op">&lt;</span><span class="ident">CanvasTextureHandle</span><span class="op">&gt;</span>)
<span class="op">-</span><span class="op">&gt;</span> <span class="ident">Arc</span><span class="op">&lt;</span><span class="ident">ImmutableImage</span><span class="op">&lt;</span><span class="ident">Format</span><span class="op">&gt;</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">texture_handle</span>.<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">texture_handle</span>.<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">i</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">texture_buffers</span>.<span class="ident">get</span>(<span class="ident">handle</span>) {
<span class="kw">return</span> <span class="ident">i</span>.<span class="ident">clone</span>().<span class="ident">buffer</span>.<span class="ident">clone</span>();
@@ -1196,7 +1190,7 @@
<span class="comment">// Solid colors</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">shader</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">shader_buffers</span>.<span class="ident">get</span>(
<span class="self">self</span>.<span class="ident">get_shader_handle</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">&quot;color-passthrough&quot;</span>))
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>
).<span class="ident">unwrap</span>();
<span class="comment">// This looks a little weird as colored_vertex_buffer is a vec of GPU allocated vecs.</span>
@@ -1214,12 +1208,12 @@
<span class="comment">// Images</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">shader</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">shader_buffers</span>.<span class="ident">get</span>(
<span class="self">self</span>.<span class="ident">get_shader_handle</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">&quot;simple_image&quot;</span>))
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>
).<span class="ident">unwrap</span>();
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">image_vertex_buffer</span>.<span class="ident">is_empty</span>() {
<span class="kw">for</span> (<span class="ident">image_handle</span>, <span class="ident">vertex_buffer</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">image_vertex_buffer</span>.<span class="ident">clone</span>() {
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">image_handle</span>.<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">image_handle</span>.<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="ident">descriptor_set</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">image_buffers</span>.<span class="ident">get</span>(<span class="ident">handle</span>).<span class="ident">clone</span>().<span class="ident">unwrap</span>().<span class="ident">clone</span>()
.<span class="ident">get_descriptor_set</span>(<span class="ident">shader</span>.<span class="ident">get_pipeline</span>().<span class="ident">clone</span>());
@@ -1235,12 +1229,12 @@
<span class="comment">// Textures</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">shader</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">shader_buffers</span>.<span class="ident">get</span>(
<span class="self">self</span>.<span class="ident">get_shader_handle</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">&quot;simple_texture&quot;</span>))
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>
).<span class="ident">unwrap</span>();
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">textured_vertex_buffer</span>.<span class="ident">is_empty</span>() {
<span class="kw">for</span> (<span class="ident">texture_handle</span>, <span class="ident">vertex_buffer</span>) <span class="kw">in</span> <span class="self">self</span>.<span class="ident">textured_vertex_buffer</span>.<span class="ident">clone</span>() {
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">texture_handle</span>.<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">texture_handle</span>.<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>;
<span class="kw">let</span> <span class="ident">descriptor_set</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">texture_buffers</span>.<span class="ident">get</span>(<span class="ident">handle</span>).<span class="ident">clone</span>().<span class="ident">unwrap</span>().<span class="ident">clone</span>()
.<span class="ident">get_descriptor_set</span>(<span class="ident">shader</span>.<span class="ident">get_pipeline</span>(), <span class="self">self</span>.<span class="ident">sampler</span>.<span class="ident">clone</span>());
@@ -1256,7 +1250,7 @@
<span class="comment">// Text</span>
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">shader</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">shader_buffers</span>.<span class="ident">get</span>(
<span class="self">self</span>.<span class="ident">get_shader_handle</span>(<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">&quot;simple_text&quot;</span>))
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">handle</span> <span class="kw">as</span> <span class="ident">usize</span>
.<span class="ident">unwrap</span>().<span class="ident">clone</span>().<span class="ident">get_handle</span>() <span class="kw">as</span> <span class="ident">usize</span>
).<span class="ident">unwrap</span>();
<span class="comment">//</span>