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/trait.VulkanObject.html

17 lines
56 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 `VulkanObject` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, VulkanObject"><title>vulkano::VulkanObject - 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 VulkanObject</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Object">Object</a></div><a class="sidebar-title" href="#associated-const">Associated Constants</a><div class="sidebar-links"><a href="#associatedconstant.TYPE">TYPE</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.internal_object">internal_object</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>vulkano</a></p><script>window.sidebarCurrent = {name: 'VulkanObject', 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/lib.rs.html#127-136' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>vulkano</a>::<wbr><a class="trait" href=''>VulkanObject</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait VulkanObject {
type <a href='#associatedtype.Object' class="type">Object</a>: <a class="trait" href="../vulkano/trait.VulkanHandle.html" title="trait vulkano::VulkanHandle">VulkanHandle</a>;
const <a href='#associatedconstant.TYPE' class="constant"><b>TYPE</b></a>: <a class="type" href="../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a>;
fn <a href='#tymethod.internal_object' class='fnname'>internal_object</a>(&amp;self) -&gt; Self::<a class="type" href="../vulkano/trait.VulkanObject.html#associatedtype.Object" title="type vulkano::VulkanObject::Object">Object</a>;
}</pre></div><div class='docblock'><p>Gives access to the internal identifier of an object.</p>
</div>
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Object' class='method'><code id='Object.t'>type <a href='#associatedtype.Object' class="type">Object</a>: <a class="trait" href="../vulkano/trait.VulkanHandle.html" title="trait vulkano::VulkanHandle">VulkanHandle</a></code></h3><div class='docblock'><p>The type of the object.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='associated-const' class='small-section-header'>Associated Constants<a href='#associated-const' class='anchor'></a></h2><div class='methods'><h3 id='associatedconstant.TYPE' class='method'><code id='TYPE.v'>const <a href='#associatedconstant.TYPE' class="constant"><b>TYPE</b></a>: <a class="type" href="../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a></code></h3><div class='docblock'><p>The <code>DebugReportObjectTypeEXT</code> of the internal Vulkan handle.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.internal_object' class='method'><code id='internal_object.v'>fn <a href='#tymethod.internal_object' class='fnname'>internal_object</a>(&amp;self) -&gt; Self::<a class="type" href="../vulkano/trait.VulkanObject.html#associatedtype.Object" title="type vulkano::VulkanObject::Object">Object</a></code></h3><div class='docblock'><p>Returns a reference to the object.</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-VulkanObject' class='impl'><code class='in-band'>impl VulkanObject for <a class="struct" href="../vulkano/buffer/sys/struct.UnsafeBuffer.html" title="struct vulkano::buffer::sys::UnsafeBuffer">UnsafeBuffer</a></code><a href='#impl-VulkanObject' class='anchor'></a><a class='srclink' href='../src/vulkano/buffer/sys.rs.html#302-311' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Object-1' class="type"><code id='Object.t-1'>type <a href='#associatedtype.Object-1' class="type">Object</a> = <a class="type" href="../vk_sys/type.Buffer.html" title="type vk_sys::Buffer">Buffer</a></code></h4><h4 id='associatedconstant.TYPE-1' class="associatedconstant hidden"><code id='TYPE.v-1'>const <a href='#associatedconstant.TYPE-1' class="constant"><b>TYPE</b></a>: <a class="type" href="../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a></code><a class='srclink' href='../src/vulkano/buffer/sys.rs.html#305' title='goto source code'>[src]</a></h4><h4 id='method.internal_object' class="method hidden"><code id='internal_object.v-1'>fn <a href='#method.internal_object' class='fnname'>internal_object</a>(&amp;self) -&gt; <a class="type" href="../vk_sys/type.Buffer.html" title="type vk_sys::Buffer">Buffer</a></code><a class='srclink' href='../src/vulkano/buffer/sys.rs.html#308-310' title='goto source code'>[src]</a></h4></div><h3 id='impl-VulkanObject-1' class='impl'><code class='in-band'>impl VulkanObject for <a class="struct" href="../vulkano/command_buffer/pool/struct.UnsafeCommandPool.html" title="struct vulkano::command_buffer::pool::UnsafeCommandPool">UnsafeCommandPool</a></code><a href='#impl-VulkanObject-1' class='anchor'></a><a class='srclink' href='../src/vulkano/command_buffer/pool/sys.rs.html#225-234' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Object-2' class="type"><code id='Object.t-2'>type <a href='#associatedtype.Object-2' class="type">Object</a> = <a class="type" href="../vk_sys/type.CommandPool.html" title="type vk_sys::CommandPool">CommandPool</a></code></h4><h4 id='associatedconstant.TYPE-2' class="associatedconstant hidden"><code id='TYPE.v-2'>const <a href='#associatedconstant.TYPE-2' class="constant"><b>TYPE</b></a>: <a class="type" href="../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a></code><a class='srclink' href='../src/vulkano/command_buffer/pool/sys.rs.html#228' title='goto source code'>[src]</a></h4><h4 id='method.internal_object-1' class="method hidden"><code id='internal_object.v-2'>fn <a href='#method.internal_object-1' class='fnname'>internal_object</a>(&amp;self) -&gt; <a class="type" href="../vk_sys/type.CommandPool.html" title="type vk_sys::CommandPool">CommandPool</a></code><a class='srclink' href='../src/vulkano/command_buffer/pool/sys.rs.html#231-233' title='goto source code'>[src]</a></h4></div><h3 id='impl-VulkanObject-2' class='impl'><code class='in-band'>impl VulkanObject for <a class="struct" href="../vulkano/command_buffer/pool/struct.UnsafeCommandPoolAlloc.html" title="struct vulkano::command_buffer::pool::UnsafeCommandPoolAlloc">UnsafeCommandPoolAlloc</a></code><a href='#impl-VulkanObject-2' class='anchor'></a><a class='srclink' href='../src/vulkano/command_buffer/pool/sys.rs.html#249-258' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Object-3' class="type"><code id='Object.t-3'>type <a href='#associatedtype.Object-3' class="type">Object</a> = <a class="type" href="../vk_sys/type.CommandBuffer.html" title="type vk_sys::CommandBuffer">CommandBuffer</a></code></h4><h4 id='associatedconstant.TYPE-3' class="associatedconstant hidden"><code id='TYPE.v-3'>const <a href='#associatedconstant.TYPE-3' class="constant"><b>TYPE</b></a>: <a class="type" href="../vk_sys/type.D
src="../implementors/vulkano/trait.VulkanObject.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>