GxShaderCompiler.h

Go to the documentation of this file.

//===========================================================================
//===========================================================================
#pragma once
 
GX_CORE_NAMESPACE_BEGIN()
 
#if GX_DEVELOP
class GxShaderCompileMessenger;
//===========================================================================
//===========================================================================
class GxShaderCompiler
{
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    enum class COMPILE_SHADER
    {
        INVALID = -1,                           
 
        VERTEX_2_0 = 0,                         
        VERTEX_3_0,                             
        PIXEL_2_0,                              
        PIXEL_3_0,                              
#if GX_SHADER_MODEL >= GX_SHADER_MODEL_4
        VERTEX_4_0,                             
        PIXEL_4_0,                              
#if GX_ENABLE_TESSELLATION
        HULL_4_0,                               
        DOMAIN_4_0,                             
#endif //GX_ENABLE_TESSELLATION
#endif //GX_SHADER_MODEL >= GX_SHADER_MODEL_4
#if GX_SHADER_MODEL >= GX_SHADER_MODEL_5
        VERTEX_5_0,                             
        PIXEL_5_0,                              
#if GX_ENABLE_TESSELLATION
        HULL_5_0,                               
        DOMAIN_5_0,                             
#endif //GX_ENABLE_TESSELLATION
        COMPUTE_5_0,                            
#endif //GX_SHADER_MODEL >= GX_SHADER_MODEL_5
#if GX_USE_DX12
        VERTEX_6_0,                             
        PIXEL_6_0,                              
#endif //GX_USE_DX12
        MAX,                                    
    };
    static const GX_CHAR* COMPILE_SHADER_TEXT[static_cast<u32>(COMPILE_SHADER::MAX)];
public:
    struct GxShaderCompilerMemorySuite
    {
        void*                               (*_pMallocFunction)(size_t size);
        void                                (*_pFreeFunction)(void* pPointer);      
    };
 
    struct GxConstantRegisterTypeInformation
    {
        u32                                 _registerTableCount;    
        u32                                 _registerStart;         
        u32                                 _registerEnd;           
    };
 
    struct GxConstantRegisterElement
    {
        static constexpr u32 PARAMETER_NAME_MAX = GxMath::VALUE_64;                 
#if GX_USE_OPENGL
        u32                                 _bindingLocationIndex;  
#endif //GX_USE_OPENGL
        GxRenderShader::REGISTER_SET_TYPE   _registerSet;           
        u32                                 _registerIndex;         
        u32                                 _registerCount;         
        GxRenderShader::PARAMETER_TYPE      _type;                  
        GX_CHAR                             _name[PARAMETER_NAME_MAX];  
    };
 
public:
    static GX_CSTR      VERTEX_SHADER_PROFILE_2_0;
    static GX_CSTR      VERTEX_SHADER_PROFILE_3_0;
    static GX_CSTR      PIXEL_SHADER_PROFILE_2_0;
    static GX_CSTR      PIXEL_SHADER_PROFILE_3_0;                   
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    GxShaderCompiler(void);
    ~GxShaderCompiler(void);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    static void setMemoryFunction(const GxShaderCompilerMemorySuite& memoryFunctionSuite);
 
    void clear(void);
    b32  compile(const void* pSrcData, u32 size, COMPILE_SHADER shaderType, GX_CSTR entryName, GX_CSTR* ppPragmaArray = nullptr, b32 noneRegisterSpace = true);
 
private:
    static void* allocateMemory(u32 size);
    static void  freeMemory(void* pAddress);
    static void* allocateDevelopMemory(size_t size);
    static void  freeDevelopMemory(void* pAddress);
    static b32   convertShader(const void* pSrcData, u32 srcSize, void** ppDstData, u32& dstSize, GX_CSTR* ppPragmaArray = nullptr);
    static b32   isCommentLine(GX_CSTR text);
    static b32   isReturnCode(GX_CSTR text, u32& codeSize);
    static b32   addReturnCode(GX_STR& pDst, u32& size);
 
#if defined(_NX64)
    b32 compileLocal(const void* pSrcData, u32 size, COMPILE_SHADER shaderType);
    static GxRenderShader::REGISTER_SET_TYPE getRegisterType(GLSLCpiqUniformKind kind, GLSLCpiqTypeEnum type);
    static u32               getRegisterCount(const GLSLCuniformInfo* pUniformData);
    static GxRenderShader::PARAMETER_TYPE getParameterType(GLSLCpiqTypeEnum type);
#endif //_NX64
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    static GX_CSTR getShaderFolder(b32 isGlsl, u32 shaderModel);
    u32 getShaderSize(void)                                                 const;
    void getShaderCode(void* pDst, u32 size)                                const;
    u32 getConstantRegisterTableTotal(void)                                 const;
    u32 getConstantRegisterTableCount(GxRenderShader::REGISTER_SET_TYPE type)   const;
    u32 getConstantRegisterStart(GxRenderShader::REGISTER_SET_TYPE type)    const;
    u32 getConstantRegisterCount(GxRenderShader::REGISTER_SET_TYPE type)    const;
    u32 getConstantRegisterTotal(GxRenderShader::REGISTER_SET_TYPE type)    const;
    const GxConstantRegisterElement* getConstantRegisterElement(u32 index)  const;
    u32 getUsageInputSemantics(void)                                        const;
    b32 isUsageInputSemantics(RENDER_SEMANTICS semantics)                   const;
    u32 getConstantBufferSize(void)                                         const;
    GX_CSTR getShaderVersion(void)  const { return _shaderVersion; }
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
private:
    static GxShaderCompilerMemorySuite  _memoryManager;         
 
    GX_CSTR                             _shaderVersion;         
    u32                                 _registerTotal;         
    GxConstantRegisterTypeInformation   _registerTypeInformation[static_cast<s32>(GxRenderShader::REGISTER_SET_TYPE::MAX)];     
    GxConstantRegisterElement*          _pRegisterElementTable; 
    u32                                 _constantBufferSize;    
 
#if defined(_XBOX_XS)
    ComPtr<IDxcBlob>                    _pShader;               
#elif GX_USE_DX11 || GX_USE_DX12
    ID3DBlob*                           _pShader;               
#elif defined(_NX64) || defined(_PS5)
    void*                               _pProgram;              
    u32                                 _programSize;           
#endif //_NX64 || _PS5
 
#if ENABLE_PARARELL_SHADER_COMPILE
    GxShaderCompileMessenger*           _pCompileMessenger;     
    u32                                 _currentCount;          
#endif //ENABLE_PARARELL_SHADER_COMPILE
};
 
#if GX_USE_DX11 || (GX_USE_DX12 && !defined(_XBOX_XS))
//===========================================================================
//===========================================================================
class GxShaderMacro
{
    //-----------------------------------------------------------
    //-----------------------------------------------------------
private:
    struct MacroInformation
    {
    public:
        GX_CSTR             _name;          
        GX_CSTR             _attribute;     
        struct MacroInformation* _pNext;    
    };
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
public:
    GxShaderMacro(void) : _pTop(nullptr), _pLast(nullptr), _pMacro(nullptr){}
    ~GxShaderMacro(void);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
 
    void push(GX_CSTR name, GX_CSTR attribute);
    s32 count(void);
    void clear(void);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
 
    D3D10_SHADER_MACRO* getD3D10(void);
 
    //-----------------------------------------------------------
    //-----------------------------------------------------------
private:
    MacroInformation*       _pTop;      
    MacroInformation*       _pLast;     
    D3D10_SHADER_MACRO*     _pMacro;    
 
};
#endif //GX_USE_DX11 || (GX_USE_DX12 && !_XBOX_XS)
 
#endif  // GX_DEVELOP
 
GX_CORE_NAMESPACE_END()