HLSLIntrinsics.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/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Container/Map.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/ShaderVersion.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/ASTEnums.hpp"
#include "CeresEngine/Material/ShaderCompiler/AST/TypeDenoter.hpp"
#include "CeresEngine/Material/ShaderCompiler/Frontend/IntrinsicAdept.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    struct HLSLIntrinsicEntry {
        inline HLSLIntrinsicEntry(const Intrinsic intrinsic, const Int32 major, const Int32 minor) : intrinsic{intrinsic}, minShaderModel{major, minor} {}
 
        Intrinsic intrinsic;
        ShaderVersion minShaderModel;
    };
 
    using HLSLIntrinsicsMap = Map<String, HLSLIntrinsicEntry>;
 
    // IntrinsicAdept interface implementation for HLSL frontend.
    class HLSLIntrinsicAdept : public IntrinsicAdept {
    public:
        HLSLIntrinsicAdept();
 
        [[nodiscard]] TypeDenoterPtr getIntrinsicReturnType(const Intrinsic intrinsic, const Vector<ExpressionPtr>& args,
            const TypeDenoterPtr& prefixTypeDenoter = nullptr) const override;
 
        [[nodiscard]] Vector<TypeDenoterPtr> getIntrinsicParameterTypes(const Intrinsic intrinsic, const Vector<ExpressionPtr>& args) const override;
 
        [[nodiscard]] Vector<std::size_t> getIntrinsicOutputParameterIndices(const Intrinsic intrinsic) const override;
 
        // Returns the intrinsics map (Intrinsic name -> Intrinsic ID and minimum HLSL shader model).
        static const HLSLIntrinsicsMap& getIntrinsicMap();
 
    private:
        [[nodiscard]] TypeDenoterPtr deriveReturnType(const Intrinsic intrinsic, const Vector<ExpressionPtr>& args) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeMul(const Vector<ExpressionPtr>& args) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeMulPrimary(const Vector<ExpressionPtr>& args, const TypeDenoterPtr& type0, const TypeDenoterPtr& type1) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeTranspose(const Vector<ExpressionPtr>& args) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeVectorCompare(const Vector<ExpressionPtr>& args) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeTextureSample(const BaseTypeDenoterPtr& genericTypeDenoter) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeTextureSampleCmp(const BaseTypeDenoterPtr& genericTypeDenoter) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeTextureGather(const BaseTypeDenoterPtr& genericTypeDenoter) const;
        [[nodiscard]] TypeDenoterPtr deriveReturnTypeTextureGatherCmp(const BaseTypeDenoterPtr& genericTypeDenoter) const;
 
        void deriveParameterTypes(Vector<TypeDenoterPtr>& paramTypeDenoters, const Intrinsic intrinsic, const Vector<ExpressionPtr>& args,
            bool useMinDimension = false) const;
 
        void deriveParameterTypesMul(Vector<TypeDenoterPtr>& paramTypeDenoters, const Vector<ExpressionPtr>& args) const;
        void deriveParameterTypesTranspose(Vector<TypeDenoterPtr>& paramTypeDenoters, const Vector<ExpressionPtr>& args) const;
        void deriveParameterTypesFirstBit(Vector<TypeDenoterPtr>& paramTypeDenoters, const Vector<ExpressionPtr>& args, const Intrinsic intrinsic) const;
 
        [[nodiscard]] BaseTypeDenoterPtr getGenericTextureTypeFromPrefix(const Intrinsic intrinsic, const TypeDenoterPtr& prefixTypeDenoter) const;
    };
 
} // namespace CeresEngine::ShaderCompiler