|
|
|
|
|
<!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 `shaderc` crate."><meta name="keywords" content="rust, rustlang, rust-lang, shaderc"><title>shaderc - 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">☰</div><a href='../shaderc/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate shaderc</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all shaderc'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="#functions">Functions</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'shaderc', 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'>−</span>]</a></span><a class='srclink' href='../src/shaderc/lib.rs.html#15-1889' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>shaderc</a></span></h1><div class='docblock'><p>Rust binding for the Shaderc library.</p>
|
|
|
|
|
|
<p>This crate contains the higher-level Rust-friendly interface for the
|
|
|
|
|
|
Shaderc library. For the lower-level C interface, please see the
|
|
|
|
|
|
<a href="https://docs.rs/shaderc-sys">shaderc-sys</a> crate.</p>
|
|
|
|
|
|
<p>The <a href="https://github.com/google/shaderc">Shaderc</a> library provides an API
|
|
|
|
|
|
for compiling GLSL/HLSL source code to SPIRV modules. It has been shipping
|
|
|
|
|
|
in the Android NDK since version r12b.</p>
|
|
|
|
|
|
<p>The order of preference in which the build script will attempt to obtain
|
|
|
|
|
|
Shaderc can be controlled by several options, which are passed through to
|
|
|
|
|
|
shaderc-sys when building shaderc-rs:</p>
|
|
|
|
|
|
<ol>
|
|
|
|
|
|
<li>The option <code>--features build-from-source</code> will prevent automatic library
|
|
|
|
|
|
detection and force building from source.</li>
|
|
|
|
|
|
<li>If the <code>SHADERC_LIB_DIR</code> environment variable is set to
|
|
|
|
|
|
<code>/path/to/shaderc/libs/</code>, it will take precedence and
|
|
|
|
|
|
<code>libshaderc_combined.a</code> (and the glslang and SPIRV libraries on Linux)
|
|
|
|
|
|
will be searched in the <code>/path/to/shaderc/libs/</code> directory.</li>
|
|
|
|
|
|
<li>On Linux, <code>/usr/lib/</code> will be automatically searched for system libraries
|
|
|
|
|
|
if none of the above were given.</li>
|
|
|
|
|
|
<li>If no other option was set or succeeded, shaderc-sys will fall back to
|
|
|
|
|
|
checking out and compiling a copy of Shaderc. This procedure is quite
|
|
|
|
|
|
slow.</li>
|
|
|
|
|
|
</ol>
|
|
|
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
|
|
|
<p>Compile a shader into SPIR-V binary module and assembly text:</p>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">shaderc</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">source</span> <span class="op">=</span> <span class="string">"#version 310 es\n void EP() {}"</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">compiler</span> <span class="op">=</span> <span class="ident">shaderc</span>::<span class="ident">Compiler</span>::<span class="ident">new</span>().<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">options</span> <span class="op">=</span> <span class="ident">shaderc</span>::<span class="ident">CompileOptions</span>::<span class="ident">new</span>().<span class="ident">unwrap</span>();
|
|
|
|
|
|
<span class="ident">options</span>.<span class="ident">add_macro_definition</span>(<span class="string">"EP"</span>, <span class="prelude-val">Some</span>(<span class="string">"main"</span>));
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">binary_result</span> <span class="op">=</span> <span class="ident">compiler</span>.<span class="ident">compile_into_spirv</span>(
|
|
|
|
|
|
<span class="ident">source</span>, <span class="ident">shaderc</span>::<span class="ident">ShaderKind</span>::<span class="ident">Vertex</span>,
|
|
|
|
|
|
<span class="string">"shader.glsl"</span>, <span class="string">"main"</span>, <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">options</span>)).<span class="ident">unwrap</span>();
|
|
|
|
|
|
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">0x07230203</span>), <span class="ident">binary_result</span>.<span class="ident">as_binary</span>().<span class="ident">first</span>());
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">text_result</span> <span class="op">=</span> <span class="ident">compiler</span>.<span class="ident">compile_into_spirv_assembly</span>(
|
|
|
|
|
|
<span class="ident">source</span>, <span class="ident">shaderc</span>::<span class="ident">ShaderKind</span>::<span class="ident">Vertex</span>,
|
|
|
|
|
|
<span class="string">"shader.glsl"</span>, <span class="string">"main"</span>, <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">options</span>)).<span class="ident">unwrap</span>();
|
|
|
|
|
|
|
|
|
|
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">text_result</span>.<span class="ident">as_text</span>().<span class="ident">starts_with</span>(<span class="string">"; SPIR-V\n"</span>));</pre></div>
|
|
|
|
|
|
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.CompilationArtifact.html" title='shaderc::CompilationArtifact struct'>CompilationArtifact</a></td><td class='docblock-short'><p>An opaque object containing the results of compilation.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CompileOptions.html" title='shaderc::CompileOptions struct'>CompileOptions</a></td><td class='docblock-short'><p>An opaque object managing options to compilation.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Compiler.html" title='shaderc::Compiler struct'>Compiler</a></td><td class='docblock-short'><p>An opaque object managing all compiler states.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ResolvedInclude.html" title='shaderc::ResolvedInclude struct'>ResolvedInclude</a></td><td class='docblock-short'><p>A representation of a successfully resolved include directive, containing the name of the include
|
|
|
|
|
|
and its contents.</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.Error.html" title='shaderc::Error enum'>Error</a></td><td class='docblock-short'><p>Error.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.GlslProfile.html" title='shaderc::GlslProfile enum'>GlslProfile</a></td><td class='docblock-short'><p>GLSL profile.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.IncludeType.html" title='shaderc::IncludeType enum'>IncludeType</a></td><td class='docblock-short'><p>Identifies the type of include directive. <code>Relative</code> is for include directives of the form
|
|
|
|
|
|
<code>#include "..."</code>, and <code>Standard</code> is for include directives of the form <code>#include <...></code>.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Limit.html" title='shaderc::Limit enum'>Limit</a></td><td class='docblock-short'><p>Resource limit.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.OptimizationLevel.html" title='shaderc::OptimizationLevel enum'>OptimizationLevel</a></td><td class='docblock-short'><p>Optimization level.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ResourceKind.html" title='shaderc::ResourceKind enum'>ResourceKind</a></td><td class='docblock-short'><p>Resource kinds.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ShaderKind.html" title='shaderc::ShaderKind enum'>ShaderKind</a></td><td class='docblock-short'><p>Shader kind.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SourceLanguage.html" title='shaderc::SourceLanguage enum'>SourceLanguage</a></td><td class='docblock-short'><p>Source language.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.TargetEnv.html" title='shaderc::TargetEnv enum'>TargetEnv</a></td><td class='docblock-short'><p>Target environment.</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.get_spirv_version.html" title='shaderc::get_spirv_version fn'>get_spirv_version</a></td><td class='docblock-short'><p>Returns the version and revision of the SPIR-V generated by this library.</p>
|
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.parse_version_profile.html" title='shaderc::parse_version_profile fn'>parse_version_profile</a></td><td class='docblock-short'><p>Parses the version and profile from the given <code>string</code>.</p>
|
|
|
|
|
|
</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.Result.html" title='shaderc::Result type'>Result</a></td><td class='docblock-short'><p>Compilation status.</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>⏎</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 = "shaderc";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
