#ifndef EvaluateVertexGeometry
#define EvaluateVertexGeometry EvaluateVertexGeometry_BasePBR
#endif

VsOutput EvaluateVertexGeometry_BasePBR() 
...

#pragma once

#include <Atom/Features/SrgSemantics.azsli>

// 以下定义为材质着色器代码提供有关当前着色器功能的信息。
// 例如,深度着色器(不带自定义 z)没有像素着色器阶段,因此材质着色器只需要定义 'EvaluatePixelGeometry()' 和相关结构体。
#define MATERIALPIPELINE_SHADER_HAS_PIXEL_STAGE 1
#define OUTPUT_DEPTH 0
#define FORCE_OPAQUE 1
#define OUTPUT_SUBSURFACE 0
#define ENABLE_TRANSMISSION 0
#define ENABLE_SHADER_DEBUGGING 1
#define ENABLE_CLEAR_COAT 0

//////////////////////////////////////////////////////////////////////////////////////////////////
#ifdef MATERIAL_TYPE_DEFINES_AZSLI_FILE_PATH
#include MATERIAL_TYPE_DEFINES_AZSLI_FILE_PATH
// -------------------------------------------------------------------------------------------------
// 这是在文件 'BasePBR.materialtype' 中声明的---特别是在字段 "materialShaderDefines" 中,在此示例中其值为 "BasePBR_Defines.azsli"。
//
// 材质需要在此文件中定义以下 SRG 和结构体:

// #if PIPELINE_HAS_OBJECT_SRG
// ShaderResourceGroup ObjectSrg : SRG_PerObject {};
// #endif /* PIPELINE_HAS_OBJECT_SRG */
//
// #if PIPELINE_HAS_DRAW_SRG
// ShaderResourceGroup DrawSrg : SRG_PerDraw {};
// #endif /* PIPELINE_HAS_DRAW_SRG */
//
// 通常通过包含 DefaultDrawSrg.azsli 和 DefaultObjectSrg.azsli 来声明这些。然而,使用自定义 SRG 时,至少应该存在相同的字段,
// 因为它们在创建绘制项时由特征处理器填充。
// 注意:延迟管道或光线追踪管道不能有 ObjectSRG 或 DrawSRG,这意味着相关定义将设置为 0,并且信息必须以不同的方式提供。
//
// struct MaterialParameters{};
// 材质的参数输入。这通常由材质管道生成,并通过使用 '#include MATERIAL_PARAMETERS_AZSLI_FILE_PATH' 工作。
// 当手动定义此结构体时,不能使用 SceneMaterialSrg,因为结构体的布局在 C++ 中未知,并且参数无法存储在结构化缓冲区中。
//
// ShaderResourceGroup MaterialSrg : SRG_PerMaterial {};
// MaterialSrg 的定义相当严格,通常最简单的方法是使用 '#include <Atom/Features/Materials/MaterialSrg.azsli>',它使用 MaterialParameters 结构体。
// 虽然可以使用自定义 MaterialSrg,但适用与上面的 MaterialParameters 结构体相同的限制:不能使用 SceneMaterialSrg。
//
// SceneMaterialSrg 是一次访问多组材质参数所必需的,例如在延迟管道中。
//
// 这些通常不是由材质完全定义的,而是由多个定义控制:参见 'BasePBR_VertexData.azsli' 与 'ForwardPassVertexData.azsli' 结合使用。
// struct VsInput{};            // 顶点着色器的输入
// struct VsOutput{};           // 顶点着色器的输出,像素着色器的输入
// struct VsSystemValues{};     // 渲染管道特有的值(例如 Forward+ 的 `instanceId`),通常被视为传递给各种实用函数的不透明结构体,并且从不由材质直接声明。
//   所有内容如何组合在一起可能会变得复杂。例如,InstanceId 需要从顶点着色器传递到像素着色器,因此,仅在 Forward+ 管道中需要成为 VsOutput 结构体的一部分。

// struct PixelGeometryData{}; // 将 VsOutput 转换为表面数据的输入;
                               // 理想情况下,这会处理视差和 Alpha 裁剪,以便自定义 z 通道可以在此之后停止。
                               // 实际上,Alpha 裁剪当前发生在表面上。
// See 'BasePBR_PixelGeometryData.azsli'

// struct SurfaceData{};       // 包含评估像素光照所需的所有表面数据。
                               // 通常在创建此结构体时采样纹理。
// See 'BasePBR_SurfaceData.azsli'

// struct LightingData{};      // 包含实际光照评估的输入和输出。
                               // 光照评估函数在评估不同光源类型时使用此结构体。
                               // 着色器将其转换为像素着色器的实际输出(取决于渲染管道)。
                               // 这意味着结构体需要至少具有这些函数和着色器所期望的成员。
// See 'BasePBR_LightingData.azsli'

// -------------------------------------------------------------------------------------------------
#endif

//////////////////////////////////////////////////////////////////////////////////////////////////

#include <viewsrg_all.srgi>  // 收集 'partial ShaderResourceGroup ViewSrg {};'
#include <scenesrg_all.srgi> // 收集 'partial ShaderResourceGroup SceneSrg {};'
#include <Atom/Features/Pipeline/Forward/ForwardPassSrg.azsli>  // 定义 'ShaderResourceGroup PassSrg : SRG_PerPass {};' 为主管道中的前向通道提供支持。
#include <Atom/Features/Pipeline/Forward/ForwardPassVertexData.azsli>  // 使用材质创建的定义,并实际声明结构体 VsInput、VsOutput 和 VsSystemValues。
#include <Atom/Features/Pipeline/Forward/ForwardPassPipelineCallbacks.azsli> // 访问 DrawSrg/ObjectSrg/MaterialSrg 等的包装函数。
                                                                             // 当前,定义了以下函数:
                                                                             // 'uint GetLightingChannelMask(VsSystemValues SV);'
                                                                             // 'float4x4 GetObjectToWorldMatrix(VsSystemValues SV);'
                                                                             // 'float3x3 GetObjectToWorldMatrixInverseTranspose(VsSystemValues SV);'
                                                                             // 'float4x4 GetViewProjectionMatrix(VsSystemValues SV);'
                                                                             // 'bool HasGoboTexture(int index);'
                                                                             // 'Texture2D<float> GetGoboTexture(int index);'
                                                                             // 当定义了 MATERIALPIPELINE_USES_PREV_VERTEX_POSITION 时:
                                                                             // 'float4x4 GetObjectToWorldMatrixPrev(VsSystemValues SV);'
                                                                             // 'float4x4 GetViewProjectionPrevMatrix(VsSystemValues SV);'

 
//////////////////////////////////////////////////////////////////////////////////////////////////

#include MATERIAL_TYPE_AZSLI_FILE_PATH
// -------------------------------------------------------------------------------------------------
// 这是在文件 'BasePBR.materialtype' 中声明的,特别是在字段 "materialShaderCode" 中,在此示例中其值为 "BasePBR.azsli"
//
// 材质至少需要定义以下函数:
// 
// - 'VsOutput EvaluateVertexGeometry(VsInput IN, VsSystemValues SV, const MaterialParameters params);'
//     在顶点着色器中调用(至少在 Forward+ 管道中),并将 VsInput 转换为 VsOutput,即执行视图投影变换。
//     如果材质不需要自定义 z 着色器,则只会为深度通道调用此函数。
//
// - 'PixelGeometryData EvaluatePixelGeometry(VsOutput IN, VsSystemValues SV, bool isFrontFace, const MaterialParameters params);'
//     在像素着色器中调用,并将 VsOutput IN 转换为 PixelGeometryData。
//
// - 'Surface EvaluateSurface(VsOutput IN, PixelGeometryData geoData, const MaterialParameters params);'
//     在像素着色器中调用。它将 PixelGeometryData 转换为表面数据。
//     大多数纹理采样在此函数中进行,材质通常在此评估大多数材质参数(和着色器选项)。
//     为了方便,材质输入也应该在此处使用,例如 'BaseColorInput.azsli' 提供 'GetBaseColorInput()' 和 'BlendBaseColor()',可以与使用 'COMMON_OPTIONS_BASE_COLOR' 定义的着色器选项一起使用,并且它使用在 'BaseColorPropertyGroup.json' 中定义的材质参数。
//     注意: 'COMMON_SRG_INPUTS_BASE_COLOR' 已过时;它们用于在结构体 MaterialParameters 存在之前手动创建 MaterialSRG。
//
// - 'real3 GetDiffuseLighting(Surface surface, LightingData lightingData, real3 lightIntensity, real3 dirToLight);'
// - 'real3 GetSpecularLighting(Surface surface, LightingData lightingData, const real3 lightIntensity, const real3 dirToLight);'
//     在(默认)光照评估期间调用。它允许材质提供自己的 BRDF:
//
// - 'void InitializeLightingData(inout Surface surface, float3 viewPosition, inout LightingData lightingData);'
// - 'void FinalizeLightingData(Surface surface, inout LightingData lightingData);'
//     在光照评估之前和之后调用。
//
// - class CapsuleLightUtil
//   {
//     static bool CheckLightChannel(CapsuleLight light, LightingData lightingData);
//     static CapsuleLightUtil Init(CapsuleLight light, Surface surface, float3 cameraPositionWS);
//     real GetFalloff();
//     void Apply(CapsuleLight light, Surface surface, [real litRatio], inout LightingData lightingData);
//     static void ApplySampled(CapsuleLight light, Surface surface, inout LightingData lightingData, const uint sampleCount); // 可选
//   };
//     在光照评估期间用于每种光源类型(capsule、directional、disk、point、polygon、quad、simple point light、simple spot light)。
//     如果要在自定义着色器中使用默认 PBR 实现,必须包含 "Atom/Features/PBR/Lights/Lights.azsli"。它为每个支持的光源类型提供默认的 <Type>LightUtil 类。
//
// -------------------------------------------------------------------------------------------------
//////////////////////////////////////////////////////////////////////////////////////////////////

// 来自前向通道的光照评估函数,使用材质定义的函数和类
#include <Atom/Features/Pipeline/Forward/ForwardPassEvaluateLighting.azsli>
// - 'EvaluateLighting(Surface surface, float4 screenPosition, float3 viewPosition);'
//     此函数特定于 Forward+ 管道。它使用 PassSrg 中的 TileLightingIterator 迭代每个分配的光源,
//     评估阴影(如果适用),并使用 '<Type>LightUtil' 类将光源应用于表面(或跳过它)。

// 实际的顶点和像素着色器代码:
#include "ForwardPassVertexAndPixel.azsli"
// 顶点着色器调用:
//    'VsOutput OUT = EvaluateVertexGeometry(VsInput IN, VsSystemValues SV, MaterialParameters params);'
// 像素着色器随后调用:
//    'PixelGeometryData geoData = EvaluatePixelGeometry(VsOutput IN, VsSystemValues SV, bool isFrontFace, MaterialParameters params);'
//    'Surface surface = EvaluateSurface(VsOutput IN, PixelGeometryData geoData, MaterialParameters paramn);'
//    'LightingData lightingData = EvaluateLighting(Surface surface, float4 IN.position, float3 ViewSrg::m_worldPosition.xyz);'
// 然后将 'lightingData' 转换为当前通道所需的任何输出。