15 lines
6.0 KiB
HTML
15 lines
6.0 KiB
HTML
<!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 `spvReflectGetPushConstantBlock` fn in crate `spirv_reflect`."><meta name="keywords" content="rust, rustlang, rust-lang, spvReflectGetPushConstantBlock"><title>spirv_reflect::ffi::spvReflectGetPushConstantBlock - 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 fn"><!--[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">☰</div><a href='../../spirv_reflect/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>spirv_reflect</a>::<wbr><a href='index.html'>ffi</a></p><script>window.sidebarCurrent = {name: 'spvReflectGetPushConstantBlock', ty: 'fn', 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'>−</span>]</a></span><a class='srclink' href='../../src/spirv_reflect/up/gen/bindings.rs.html#2028-2032' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>spirv_reflect</a>::<wbr><a href='index.html'>ffi</a>::<wbr><a class="fn" href=''>spvReflectGetPushConstantBlock</a></span></h1><pre class='rust fn'>pub unsafe extern "C" fn spvReflectGetPushConstantBlock(<br> p_module: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../../spirv_reflect/ffi/struct.SpvReflectShaderModule.html" title="struct spirv_reflect::ffi::SpvReflectShaderModule">SpvReflectShaderModule</a>, <br> index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> p_result: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="type" href="../../spirv_reflect/ffi/type.SpvReflectResult.html" title="type spirv_reflect::ffi::SpvReflectResult">SpvReflectResult</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*const </a><a class="struct" href="../../spirv_reflect/ffi/struct.SpvReflectBlockVariable.html" title="struct spirv_reflect::ffi::SpvReflectBlockVariable">SpvReflectBlockVariable</a></pre><div class='docblock'><p>@fn spvReflectGetPushConstantBlock</p>
|
||
<p>@param p_module Pointer to an instance of SpvReflectShaderModule.
|
||
@param index The index of the desired block within the module's
|
||
array of push constant blocks.
|
||
@param p_result If successful, SPV_REFLECT_RESULT_SUCCESS will be
|
||
written to *p_result. Otherwise, a error code
|
||
indicating the cause of the failure will be stored
|
||
here.
|
||
@return If the provided index is within range, a pointer to
|
||
the corresponding push constant block is returned.
|
||
The caller must not free this pointer.
|
||
If no match can be found, or if an unrelated error
|
||
occurs, the return value will be NULL. Detailed
|
||
error results are written to *pResult.</p>
|
||
</div></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>⏎</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 = "spirv_reflect";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |