// Copyright 2021 The Dawn & Tint Authors // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are met: // // 1. Redistributions of source code must retain the above copyright notice, this // list of conditions and the following disclaimer. // // 2. Redistributions in binary form must reproduce the above copyright notice, // this list of conditions and the following disclaimer in the documentation // and/or other materials provided with the distribution. // // 3. Neither the name of the copyright holder nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #ifndef SRC_TINT_LANG_WGSL_AST_TRANSFORM_CANONICALIZE_ENTRY_POINT_IO_H_ #define SRC_TINT_LANG_WGSL_AST_TRANSFORM_CANONICALIZE_ENTRY_POINT_IO_H_ #include <string> #include "src/tint/lang/wgsl/ast/internal_attribute.h" #include "src/tint/lang/wgsl/ast/transform/transform.h" #include "src/tint/utils/reflection/reflection.h" namespace tint::ast::transform { /// CanonicalizeEntryPointIO is a transform used to rewrite shader entry point /// interfaces into a form that the generators can handle. Each entry point /// function is stripped of all shader IO attributes and wrapped in a function /// that provides the shader interface. /// The transform config determines whether to use global variables, structures, /// or parameters for the shader inputs and outputs, and optionally adds /// additional builtins to the shader interface. /// /// Before: /// ``` /// struct Locations{ /// @location(1) loc1 : f32; /// @location(2) loc2 : vec4<u32>; /// }; /// /// @fragment /// fn frag_main(@builtin(position) coord : vec4<f32>, /// locations : Locations) -> @location(0) f32 { /// if (coord.w > 1.0) { /// return 0.0; /// } /// var col : f32 = (coord.x * locations.loc1); /// return col; /// } /// ``` /// /// After (using structures for all parameters): /// ``` /// struct Locations{ /// loc1 : f32; /// loc2 : vec4<u32>; /// }; /// /// struct frag_main_in { /// @builtin(position) coord : vec4<f32>; /// @location(1) loc1 : f32; /// @location(2) loc2 : vec4<u32> /// }; /// /// struct frag_main_out { /// @location(0) loc0 : f32; /// }; /// /// fn frag_main_inner(coord : vec4<f32>, /// locations : Locations) -> f32 { /// if (coord.w > 1.0) { /// return 0.0; /// } /// var col : f32 = (coord.x * locations.loc1); /// return col; /// } /// /// @fragment /// fn frag_main(in : frag_main_in) -> frag_main_out { /// let inner_retval = frag_main_inner(in.coord, Locations(in.loc1, in.loc2)); /// var wrapper_result : frag_main_out; /// wrapper_result.loc0 = inner_retval; /// return wrapper_result; /// } /// ``` /// /// @note Depends on the following transforms to have been run first: /// * Unshadow class CanonicalizeEntryPointIO final : public Castable<CanonicalizeEntryPointIO, Transform> { … }; } // namespace tint::ast::transform tint // namespace tint #endif // SRC_TINT_LANG_WGSL_AST_TRANSFORM_CANONICALIZE_ENTRY_POINT_IO_H_