|
|
<!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_sys` crate."><meta name="keywords" content="rust, rustlang, rust-lang, shaderc_sys"><title>shaderc_sys - 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_sys/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate shaderc_sys</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all shaderc_sys'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></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'shaderc_sys', 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_sys/lib.rs.html#15-216' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>shaderc_sys</a></span></h1><div class='docblock'><p>Shaderc system library FFI, building, and linking</p>
|
|
|
<p>This crate contains the lower-level C interface for the Shaderc library.
|
|
|
For the higher-level Rust-friendly interface, please see the
|
|
|
<a href="https://docs.rs/shaderc">shaderc</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>This crate contains Rust FFI inteface to the Shaderc library. It also
|
|
|
handles system library detection and building from source if no system
|
|
|
library installed via <code>build.rs</code>.</p>
|
|
|
<p>The order of preference in which the build script will attempt to obtain
|
|
|
Shaderc can be controlled by several options:</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>
|
|
|
<p>The build script also tries to check whether <a href="https://ninja-build.org/">Ninja</a>
|
|
|
is available on <code>PATH</code>. Ninja is required to build with Visual Studio because
|
|
|
MSBuild does not support paths longer than MAX_PATH. On other platforms,
|
|
|
Ninja is optional but is generally faster than the default build tool.</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.shaderc_include_result.html" title='shaderc_sys::shaderc_include_result struct'>shaderc_include_result</a></td><td class='docblock-short'></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.ShadercCompilationResult.html" title='shaderc_sys::ShadercCompilationResult enum'>ShadercCompilationResult</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.ShadercCompileOptions.html" title='shaderc_sys::ShadercCompileOptions enum'>ShadercCompileOptions</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.ShadercCompiler.html" title='shaderc_sys::ShadercCompiler enum'>ShadercCompiler</a></td><td class='docblock-short'></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.shaderc_assemble_into_spv.html" title='shaderc_sys::shaderc_assemble_into_spv fn'>shaderc_assemble_into_spv</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_into_preprocessed_text.html" title='shaderc_sys::shaderc_compile_into_preprocessed_text fn'>shaderc_compile_into_preprocessed_text</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_into_spv.html" title='shaderc_sys::shaderc_compile_into_spv fn'>shaderc_compile_into_spv</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_into_spv_assembly.html" title='shaderc_sys::shaderc_compile_into_spv_assembly fn'>shaderc_compile_into_spv_assembly</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_add_macro_definition.html" title='shaderc_sys::shaderc_compile_options_add_macro_definition fn'>shaderc_compile_options_add_macro_definition</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_clone.html" title='shaderc_sys::shaderc_compile_options_clone fn'>shaderc_compile_options_clone</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_initialize.html" title='shaderc_sys::shaderc_compile_options_initialize fn'>shaderc_compile_options_initialize</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_release.html" title='shaderc_sys::shaderc_compile_options_release fn'>shaderc_compile_options_release</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_auto_bind_uniforms.html" title='shaderc_sys::shaderc_compile_options_set_auto_bind_uniforms fn'>shaderc_compile_options_set_auto_bind_uniforms</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_binding_base.html" title='shaderc_sys::shaderc_compile_options_set_binding_base fn'>shaderc_compile_options_set_binding_base</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_binding_base_for_stage.html" title='shaderc_sys::shaderc_compile_options_set_binding_base_for_stage fn'>shaderc_compile_options_set_binding_base_for_stage</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_forced_version_profile.html" title='shaderc_sys::shaderc_compile_options_set_forced_version_profile fn'>shaderc_compile_options_set_forced_version_profile</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_generate_debug_info.html" title='shaderc_sys::shaderc_compile_options_set_generate_debug_info fn'>shaderc_compile_options_set_generate_debug_info</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_hlsl_io_mapping.html" title='shaderc_sys::shaderc_compile_options_set_hlsl_io_mapping fn'>shaderc_compile_options_set_hlsl_io_mapping</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_hlsl_offsets.html" title='shaderc_sys::shaderc_compile_options_set_hlsl_offsets fn'>shaderc_compile_options_set_hlsl_offsets</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_hlsl_register_set_and_binding.html" title='shaderc_sys::shaderc_compile_options_set_hlsl_register_set_and_binding fn'>shaderc_compile_options_set_hlsl_register_set_and_binding</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_hlsl_register_set_and_binding_for_stage.html" title='shaderc_sys::shaderc_compile_options_set_hlsl_register_set_and_binding_for_stage fn'>shaderc_compile_options_set_hlsl_register_set_and_binding_for_stage</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_include_callbacks.html" title='shaderc_sys::shaderc_compile_options_set_include_callbacks fn'>shaderc_compile_options_set_include_callbacks</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_limit.html" title='shaderc_sys::shaderc_compile_options_set_limit fn'>shaderc_compile_options_set_limit</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_optimization_level.html" title='shaderc_sys::shaderc_compile_options_set_optimization_level fn'>shaderc_compile_options_set_optimization_level</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_source_language.html" title='shaderc_sys::shaderc_compile_options_set_source_language fn'>shaderc_compile_options_set_source_language</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_suppress_warnings.html" title='shaderc_sys::shaderc_compile_options_set_suppress_warnings fn'>shaderc_compile_options_set_suppress_warnings</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_target_env.html" title='shaderc_sys::shaderc_compile_options_set_target_env fn'>shaderc_compile_options_set_target_env</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compile_options_set_warnings_as_errors.html" title='shaderc_sys::shaderc_compile_options_set_warnings_as_errors fn'>shaderc_compile_options_set_warnings_as_errors</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compiler_initialize.html" title='shaderc_sys::shaderc_compiler_initialize fn'>shaderc_compiler_initialize</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_compiler_release.html" title='shaderc_sys::shaderc_compiler_release fn'>shaderc_compiler_release</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_get_spv_version.html" title='shaderc_sys::shaderc_get_spv_version fn'>shaderc_get_spv_version</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_parse_version_profile.html" title='shaderc_sys::shaderc_parse_version_profile fn'>shaderc_parse_version_profile</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_get_bytes.html" title='shaderc_sys::shaderc_result_get_bytes fn'>shaderc_result_get_bytes</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_get_compilation_status.html" title='shaderc_sys::shaderc_result_get_compilation_status fn'>shaderc_result_get_compilation_status</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_get_error_message.html" title='shaderc_sys::shaderc_result_get_error_message fn'>shaderc_result_get_error_message</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_get_length.html" title='shaderc_sys::shaderc_result_get_length fn'>shaderc_result_get_length</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_get_num_errors.html" title='shaderc_sys::shaderc_result_get_num_errors fn'>shaderc_result_get_num_errors</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_get_num_warnings.html" title='shaderc_sys::shaderc_result_get_num_warnings fn'>shaderc_result_get_num_warnings</a><a title='unsafe function' href='#'><sup>⚠</sup></a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.shaderc_result_release.html" title='shaderc_sys::shaderc_result_release fn'>shaderc_result_release</a><a title='unsafe function' href='#'><sup>⚠</sup></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>⏎</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_sys";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
