Fix include_spv!() documentation (#81)

This commit is contained in:
JMS55 2020-05-23 19:59:11 -04:00 committed by GitHub
parent de21862c77
commit b55f75e157
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,12 +1,12 @@
//! Provides a macro and type for including SPIR-V shaders in const data. /// Provides a macro and type for including SPIR-V shaders in const data.
//! ///
//! In an ideal world, a shader will be compiled at build-time directly into the executable. This /// In an ideal world, a shader will be compiled at build-time directly into the executable. This
//! is opposed to the typical method of including a shader, which reads a GLSL source code file /// is opposed to the typical method of including a shader, which reads a GLSL source code file
//! from the file system at start, compiles it, and sends it to the GPU. That process adds a /// from the file system at start, compiles it, and sends it to the GPU. That process adds a
//! non-trivial amount of time to startup, and additional error handling code at runtime. /// non-trivial amount of time to startup, and additional error handling code at runtime.
//! ///
//! This macro moves all of that complexity to build-time. At least for the SPIR-V part of the /// This macro moves all of that complexity to build-time. At least for the SPIR-V part of the
//! shader pipeline. (`gfx-hal` backends have their own SPIR-V-to-native compilers at runtime.) /// shader pipeline. (`gfx-hal` backends have their own SPIR-V-to-native compilers at runtime.)
#[macro_export] #[macro_export]
macro_rules! include_spv { macro_rules! include_spv {