mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4b8fffc6bf'
${ noResults }
Trac3r-rust/doc/vulkano/command_buffer/validity/index.html

36 lines
13 KiB
Raw Blame History Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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 `validity` mod in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, validity"><title>vulkano::command_buffer::validity - 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 mod"><!--[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'>Module validity</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>command_buffer</a></p><script>window.sidebarCurrent = {name: 'validity', ty: 'mod', 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/command_buffer/validity/mod.rs.html#10-39' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>command_buffer</a>::<wbr><a class="mod" href=''>validity</a></span></h1><div class='docblock'><p>Functions that check the validity of commands.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.CheckCopyBuffer.html" title='vulkano::command_buffer::validity::CheckCopyBuffer struct'>CheckCopyBuffer</a></td><td class='docblock-short'><p>Information returned if <code>check_copy_buffer</code> succeeds.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CheckIndexBuffer.html" title='vulkano::command_buffer::validity::CheckIndexBuffer struct'>CheckIndexBuffer</a></td><td class='docblock-short'><p>Information returned if <code>check_index_buffer</code> succeeds.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CheckVertexBuffer.html" title='vulkano::command_buffer::validity::CheckVertexBuffer struct'>CheckVertexBuffer</a></td><td class='docblock-short'><p>Information returned if <code>check_vertex_buffer</code> succeeds.</p>
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.CheckBlitImageError.html" title='vulkano::command_buffer::validity::CheckBlitImageError enum'>CheckBlitImageError</a></td><td class='docblock-short'><p>Error that can happen from <code>check_clear_color_image</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckClearColorImageError.html" title='vulkano::command_buffer::validity::CheckClearColorImageError enum'>CheckClearColorImageError</a></td><td class='docblock-short'><p>Error that can happen from <code>check_clear_color_image</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckCopyBufferError.html" title='vulkano::command_buffer::validity::CheckCopyBufferError enum'>CheckCopyBufferError</a></td><td class='docblock-short'><p>Error that can happen from <code>check_copy_buffer</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckCopyBufferImageError.html" title='vulkano::command_buffer::validity::CheckCopyBufferImageError enum'>CheckCopyBufferImageError</a></td><td class='docblock-short'><p>Error that can happen from <code>check_copy_buffer_image</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckCopyBufferImageTy.html" title='vulkano::command_buffer::validity::CheckCopyBufferImageTy enum'>CheckCopyBufferImageTy</a></td><td class='docblock-short'><p>Type of operation to check.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckCopyImageError.html" title='vulkano::command_buffer::validity::CheckCopyImageError enum'>CheckCopyImageError</a></td><td class='docblock-short'><p>Error that can happen from <code>check_copy_image</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckDescriptorSetsValidityError.html" title='vulkano::command_buffer::validity::CheckDescriptorSetsValidityError enum'>CheckDescriptorSetsValidityError</a></td><td class='docblock-short'><p>Error that can happen when checking descriptor sets validity.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckDispatchError.html" title='vulkano::command_buffer::validity::CheckDispatchError enum'>CheckDispatchError</a></td><td class='docblock-short'><p>Error that can happen when checking dispatch command validity.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckDynamicStateValidityError.html" title='vulkano::command_buffer::validity::CheckDynamicStateValidityError enum'>CheckDynamicStateValidityError</a></td><td class='docblock-short'><p>Error that can happen when validating dynamic states.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckFillBufferError.html" title='vulkano::command_buffer::validity::CheckFillBufferError enum'>CheckFillBufferError</a></td><td class='docblock-short'><p>Error that can happen when attempting to add a <code>fill_buffer</code> command.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckIndexBufferError.html" title='vulkano::command_buffer::validity::CheckIndexBufferError enum'>CheckIndexBufferError</a></td><td class='docblock-short'><p>Error that can happen when checking whether binding an index buffer is valid.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckPushConstantsValidityError.html" title='vulkano::command_buffer::validity::CheckPushConstantsValidityError enum'>CheckPushConstantsValidityError</a></td><td class='docblock-short'><p>Error that can happen when checking push constants validity.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckUpdateBufferError.html" title='vulkano::command_buffer::validity::CheckUpdateBufferError enum'>CheckUpdateBufferError</a></td><td class='docblock-short'><p>Error that can happen when attempting to add an <code>update_buffer</code> command.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CheckVertexBufferError.html" title='vulkano::command_buffer::validity::CheckVertexBufferError enum'>CheckVertexBufferError</a></td><td class='docblock-short'><p>Error that can happen when checking whether the vertex buffers are valid.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.check_blit_image.html" title='vulkano::command_buffer::validity::check_blit_image fn'>check_blit_image</a></td><td class='docblock-short'><p>Checks whether a blit image command is valid.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_clear_color_image.html" title='vulkano::command_buffer::validity::check_clear_color_image fn'>check_clear_color_image</a></td><td class='docblock-short'><p>Checks whether a clear color image command is valid.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_copy_buffer.html" title='vulkano::command_buffer::validity::check_copy_buffer fn'>check_copy_buffer</a></td><td class='docblock-short'><p>Checks whether a copy buffer command is valid.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_copy_buffer_image.html" title='vulkano::command_buffer::validity::check_copy_buffer_image fn'>check_copy_buffer_image</a></td><td class='docblock-short'><p>Checks whether a copy buffer-image command is valid. Can check both buffer-to-image copies and
image-to-buffer copies.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_copy_image.html" title='vulkano::command_buffer::validity::check_copy_image fn'>check_copy_image</a></td><td class='docblock-short'><p>Checks whether a copy image command is valid.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_descriptor_sets_validity.html" title='vulkano::command_buffer::validity::check_descriptor_sets_validity fn'>check_descriptor_sets_validity</a></td><td class='docblock-short'><p>Checks whether descriptor sets are compatible with the pipeline.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_dispatch.html" title='vulkano::command_buffer::validity::check_dispatch fn'>check_dispatch</a></td><td class='docblock-short'><p>Checks whether the dispatch dimensions are supported by the device.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_dynamic_state_validity.html" title='vulkano::command_buffer::validity::check_dynamic_state_validity fn'>check_dynamic_state_validity</a></td><td class='docblock-short'><p>Checks whether states that are about to be set are correct.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_fill_buffer.html" title='vulkano::command_buffer::validity::check_fill_buffer fn'>check_fill_buffer</a></td><td class='docblock-short'><p>Checks whether a fill buffer command is valid.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_index_buffer.html" title='vulkano::command_buffer::validity::check_index_buffer fn'>check_index_buffer</a></td><td class='docblock-short'><p>Checks whether an index buffer can be bound.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_push_constants_validity.html" title='vulkano::command_buffer::validity::check_push_constants_validity fn'>check_push_constants_validity</a></td><td class='docblock-short'><p>Checks whether push constants are compatible with the pipeline.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_update_buffer.html" title='vulkano::command_buffer::validity::check_update_buffer fn'>check_update_buffer</a></td><td class='docblock-short'><p>Checks whether an update buffer command is valid.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.check_vertex_buffers.html" title='vulkano::command_buffer::validity::check_vertex_buffers fn'>check_vertex_buffers</a></td><td class='docblock-short'><p>Checks whether vertex buffers can be bound.</p>
</td></tr></table></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>
Reference in new issue View Git Blame Copy Permalink