Files
Trac3r-rust/doc/spirv_headers/index.html
2020-01-23 23:13:36 -08:00

42 lines
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `spirv_headers` crate."><meta name="keywords" content="rust, rustlang, rust-lang, spirv_headers"><title>spirv_headers - 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='../spirv_headers/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate spirv_headers</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all spirv_headers's items</p></a><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'spirv_headers', ty: 'mod', relpath: '../'};</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/spirv_headers/lib.rs.html#15-33' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>spirv_headers</a></span></h1><div class='docblock'><p>The SPIR-V header.</p>
<p>This crate contains Rust definitions of all SPIR-V structs, enums,
and constants.</p>
<p>The version of this crate is the version of SPIR-V it contains.</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.FPFastMathMode.html" title='spirv_headers::FPFastMathMode struct'>FPFastMathMode</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_fp_fast_math_mode_a_fp_fast_math_mode">FPFastMathMode</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FunctionControl.html" title='spirv_headers::FunctionControl struct'>FunctionControl</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_function_control_a_function_control">FunctionControl</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ImageOperands.html" title='spirv_headers::ImageOperands struct'>ImageOperands</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_image_operands_a_image_operands">ImageOperands</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.KernelProfilingInfo.html" title='spirv_headers::KernelProfilingInfo struct'>KernelProfilingInfo</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_kernel_profiling_info_a_kernel_profiling_info">KernelProfilingInfo</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LoopControl.html" title='spirv_headers::LoopControl struct'>LoopControl</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_loop_control_a_loop_control">LoopControl</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MemoryAccess.html" title='spirv_headers::MemoryAccess struct'>MemoryAccess</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_memory_access_a_memory_access">MemoryAccess</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.MemorySemantics.html" title='spirv_headers::MemorySemantics struct'>MemorySemantics</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_memory_semantics_a_memory_semantics">MemorySemantics</a></p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SelectionControl.html" title='spirv_headers::SelectionControl struct'>SelectionControl</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_selection_control_a_selection_control">SelectionControl</a></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.AccessQualifier.html" title='spirv_headers::AccessQualifier enum'>AccessQualifier</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_access_qualifier_a_access_qualifier">AccessQualifier</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.AddressingModel.html" title='spirv_headers::AddressingModel enum'>AddressingModel</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_addressing_model_a_addressing_model">AddressingModel</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.BuiltIn.html" title='spirv_headers::BuiltIn enum'>BuiltIn</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_built_in_a_built_in">BuiltIn</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.CLOp.html" title='spirv_headers::CLOp enum'>CLOp</a></td><td class='docblock-short'><p><a href="https://www.khronos.org/registry/spir-v/specs/unified1/OpenCL.ExtendedInstructionSet.100.html">OpenCL.std</a> extended instruction opcode</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Capability.html" title='spirv_headers::Capability enum'>Capability</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_capability_a_capability">Capability</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Decoration.html" title='spirv_headers::Decoration enum'>Decoration</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_decoration_a_decoration">Decoration</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Dim.html" title='spirv_headers::Dim enum'>Dim</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_dim_a_dim">Dim</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ExecutionMode.html" title='spirv_headers::ExecutionMode enum'>ExecutionMode</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_execution_mode_a_execution_mode">ExecutionMode</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ExecutionModel.html" title='spirv_headers::ExecutionModel enum'>ExecutionModel</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_execution_model_a_execution_model">ExecutionModel</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.FPRoundingMode.html" title='spirv_headers::FPRoundingMode enum'>FPRoundingMode</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_fp_rounding_mode_a_fp_rounding_mode">FPRoundingMode</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.FunctionParameterAttribute.html" title='spirv_headers::FunctionParameterAttribute enum'>FunctionParameterAttribute</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_function_parameter_attribute_a_function_parameter_attribute">FunctionParameterAttribute</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.GLOp.html" title='spirv_headers::GLOp enum'>GLOp</a></td><td class='docblock-short'><p><a href="https://www.khronos.org/registry/spir-v/specs/unified1/GLSL.std.450.html">GLSL.std.450</a> extended instruction opcode</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.GroupOperation.html" title='spirv_headers::GroupOperation enum'>GroupOperation</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_group_operation_a_group_operation">GroupOperation</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ImageChannelDataType.html" title='spirv_headers::ImageChannelDataType enum'>ImageChannelDataType</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_image_channel_data_type_a_image_channel_data_type">ImageChannelDataType</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ImageChannelOrder.html" title='spirv_headers::ImageChannelOrder enum'>ImageChannelOrder</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_image_channel_order_a_image_channel_order">ImageChannelOrder</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ImageFormat.html" title='spirv_headers::ImageFormat enum'>ImageFormat</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_image_format_a_image_format">ImageFormat</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.KernelEnqueueFlags.html" title='spirv_headers::KernelEnqueueFlags enum'>KernelEnqueueFlags</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_kernel_enqueue_flags_a_kernel_enqueue_flags">KernelEnqueueFlags</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.LinkageType.html" title='spirv_headers::LinkageType enum'>LinkageType</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_linkage_type_a_linkage_type">LinkageType</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.MemoryModel.html" title='spirv_headers::MemoryModel enum'>MemoryModel</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_memory_model_a_memory_model">MemoryModel</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Op.html" title='spirv_headers::Op enum'>Op</a></td><td class='docblock-short'><p>SPIR-V <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_instructions_a_instructions">instructions</a> opcodes</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SamplerAddressingMode.html" title='spirv_headers::SamplerAddressingMode enum'>SamplerAddressingMode</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_sampler_addressing_mode_a_sampler_addressing_mode">SamplerAddressingMode</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SamplerFilterMode.html" title='spirv_headers::SamplerFilterMode enum'>SamplerFilterMode</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_sampler_filter_mode_a_sampler_filter_mode">SamplerFilterMode</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Scope.html" title='spirv_headers::Scope enum'>Scope</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_scope_a_scope">Scope</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SourceLanguage.html" title='spirv_headers::SourceLanguage enum'>SourceLanguage</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_source_language_a_source_language">SourceLanguage</a></p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.StorageClass.html" title='spirv_headers::StorageClass enum'>StorageClass</a></td><td class='docblock-short'><p>SPIR-V operand kind: <a href="https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_storage_class_a_storage_class">StorageClass</a></p>
</td></tr></table><h2 id='constants' class='section-header'><a href="#constants">Constants</a></h2>
<table><tr class='module-item'><td><a class="constant" href="constant.MAGIC_NUMBER.html" title='spirv_headers::MAGIC_NUMBER constant'>MAGIC_NUMBER</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="constant" href="constant.MAJOR_VERSION.html" title='spirv_headers::MAJOR_VERSION constant'>MAJOR_VERSION</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="constant" href="constant.MINOR_VERSION.html" title='spirv_headers::MINOR_VERSION constant'>MINOR_VERSION</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="constant" href="constant.REVISION.html" title='spirv_headers::REVISION constant'>REVISION</a></td><td class='docblock-short'></td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.Word.html" title='spirv_headers::Word type'>Word</a></td><td class='docblock-short'></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 = "spirv_headers";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>