ShaderCompiler.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 "IncludeHandler.hpp"
#include "Log.hpp"
#include "Reflection.hpp"
#include "Targets.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/SmartPtr.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Map.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
#include "CeresEngine/Foundation/Container/SmallVector.hpp"
 
#include <istream>
#include <memory>
#include <ostream>
 
namespace CeresEngine::ShaderCompiler {
 
    struct Warnings {
        enum : UInt32 {
            Basic = (1 << 0),
 
            Syntax = (1 << 1),
 
            PreProcessor = (1 << 2),
 
            UnusedVariables = (1 << 3),
 
            EmptyStatementBody = (1 << 4),
 
            ImplicitTypeConversions = (1 << 5),
 
            DeclarationShadowing = (1 << 6),
 
            UnlocatedObjects = (1 << 7),
 
            RequiredExtensions = (1 << 8),
 
            CodeReflection = (1 << 9),
 
            IndexBoundary = (1 << 10),
 
            All = (~0u),
        };
    };
 
    struct Extensions {
        enum : UInt32 {
            LayoutAttribute = (1 << 0),
 
            SpaceAttribute = (1 << 1),
 
            All = (~0u)
        };
    };
 
    struct Formatting {
        bool alwaysBracedScopes = true;
 
        bool blanks = true;
 
        bool compactWrappers = false;
 
        String indent = String(4, ' ');
 
        bool lineMarks = false;
 
        bool lineSeparation = true;
 
        bool newLineOpenScope = false;
    };
 
    struct Options {
        bool allowExtensions = false;
 
        bool autoBinding = false;
 
        Int32 autoBindingStartSlot = 0;
 
        bool explicitBinding = false;
 
        bool obfuscate = false;
 
        bool optimize = false;
 
        //TODO: maybe merge this option with "optimize" (preferWrappers == !optimize)
        bool preferWrappers = false;
 
        bool preprocessOnly = false;
 
        bool preserveComments = false;
 
        bool rowMajorAlignment = false;
 
        bool separateSamplers = false;
 
        bool separateShaders = false;
 
        bool showAST = false;
 
        bool showTimes = false;
 
        //TODO: remove this option, and determine automatically when unrolling initializers are required!
        bool unrollArrayInitializers = false;
 
        bool validateOnly = false;
 
        bool writeGeneratorHeader = true;
    };
 
    struct NameMangling {
        String inputPrefix = "xsv_";
 
        String outputPrefix = "xsv_";
 
        String reservedWordPrefix = "xsr_";
 
        String temporaryPrefix = "xst_";
 
        String namespacePrefix = "xsn_";
 
        bool useAlwaysSemantics = false;
 
        bool renameBufferFields = false;
    };
 
    struct ShaderInput {
        String filename;
 
        SPtr<std::istream> sourceCode;
 
        InputShaderVersion shaderVersion = InputShaderVersion::HLSL5;
 
        ShaderTarget shaderTarget = ShaderTarget::Undefined;
 
        String entryPoint = "main";
 
        String secondaryEntryPoint;
 
        UInt32 warnings = 0;
 
        UInt32 extensions = 0;
 
        IncludeHandler* includeHandler = nullptr;
    };
 
    struct VertexSemantic {
        String semantic;
 
        Int32 location;
    };
 
    struct UniformPacking {
        bool enabled = false;
 
        Int32 bindingSlot = 0;
 
        String bufferName = "xsp_buffer";
    };
 
    struct ShaderOutput {
        String filename;
 
        std::ostream* sourceCode = nullptr;
 
        OutputShaderVersion shaderVersion = OutputShaderVersion::GLSL;
 
        SmallVector<VertexSemantic, 10> vertexSemantics;
 
        UniformPacking uniformPacking;
 
        Options options;
 
        Formatting formatting;
 
        NameMangling nameMangling;
    };
 
    bool compileShader(const ShaderInput& inputDesc, const ShaderOutput& outputDesc, Log* log = nullptr, Reflection::ReflectionData* reflectionData = nullptr);
 
} // namespace CeresEngine::ShaderCompiler