Skip to content

Commit

Permalink
Fix include_spv!() documentation (parasyte#81)
Browse files Browse the repository at this point in the history
  • Loading branch information
JMS55 authored May 23, 2020
1 parent de21862 commit b55f75e
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/macros.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
//! 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
//! 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
//! 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
//! shader pipeline. (`gfx-hal` backends have their own SPIR-V-to-native compilers at runtime.)
/// 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
/// 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
/// 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
/// shader pipeline. (`gfx-hal` backends have their own SPIR-V-to-native compilers at runtime.)
#[macro_export]
macro_rules! include_spv {
Expand Down

0 comments on commit b55f75e

Please sign in to comment.