GLSLExtensionAgent.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Map.hpp"
#include "CeresEngine/Foundation/Container/Set.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/Targets.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/ASTEnums.hpp"
#include "CeresEngine/Material/ShaderCompiler/Report/ReportHandler.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/Visitor/Visitor.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    // GLSL extension agent visitor. Determines which GLSL extension are required for a given GLSL target version.
    class GLSLExtensionAgent : private Visitor {
    private:
        ShaderTarget mShaderTarget = ShaderTarget::Undefined;
 
        // Target output GLSL version.
        OutputShaderVersion mTargetGLSLVersion = OutputShaderVersion::GLSL330;
 
        // Minimum required GLSL version.
        OutputShaderVersion mMinGLSLVersion = OutputShaderVersion::GLSL130;
 
        bool mAllowExtensions = false;
        bool mExplicitBinding = false;
 
        OnReportProc mOnReportExtension;
 
        // Resulting set of required GLSL extensions.
        Set<String> mExtensions;
 
        // Intrinsic name to GLSL extension map.
        Map<Intrinsic, const char*> mIntrinsicextensionMap;
 
    public:
        // Returns a set of strings with all required extensions for the specified program and target output GLSL version.
        Set<String> determineRequiredExtensions(Program& program, OutputShaderVersion& targetGLSLVersion, const ShaderTarget shaderTarget, bool allowExtensions,
            bool explicitBinding, bool separateShaders, const OnReportProc& onReportExtension = nullptr);
 
    private:
        void establishIntrinsicextensionMap();
        void acquireExtension(const String& extension, const String& reason = "", const AST* ast = nullptr);
 
    private: // Visitor implementation
        DECLARATION_VISIT_PROC(Program);
        DECLARATION_VISIT_PROC(Attribute);
 
        DECLARATION_VISIT_PROC(VarDeclaration);
        DECLARATION_VISIT_PROC(BufferDeclaration);
 
        DECLARATION_VISIT_PROC(FunctionDeclaration);
        DECLARATION_VISIT_PROC(UniformBufferDeclaration);
        DECLARATION_VISIT_PROC(BufferDeclarationStatement);
        DECLARATION_VISIT_PROC(BasicDeclarationStatement);
 
        DECLARATION_VISIT_PROC(BinaryExpression);
        DECLARATION_VISIT_PROC(UnaryExpression);
        DECLARATION_VISIT_PROC(CallExpression);
        DECLARATION_VISIT_PROC(AssignExpression);
        DECLARATION_VISIT_PROC(InitializerExpression);
        DECLARATION_VISIT_PROC(ArrayExpression);
    };
 
} // namespace CeresEngine::ShaderCompiler