HLSLKeywords.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/Material/ShaderCompiler/AST/ASTEnums.hpp"
#include "CeresEngine/Material/ShaderCompiler/AST/Token.hpp"
 
namespace CeresEngine::ShaderCompiler {
 
    // Returns the Keyword-to-Token map for HLSL.
    const KeywordMapType& hlslKeywords();
 
    // Returns the keywords map extension for Cg (i.e. only the additional keywords that are only part of Cg, e.g. "fixed4").
    const KeywordMapType& hlslKeywordsExtCg();
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the data type for the specified HLSL keyword or throws an std::runtime_error on failure.
    DataType hlslKeywordToDataType(const String& keyword);
 
    // Returns the data type for the specified Cg keyword or throws an std::runtime_error on failure.
    DataType hlslKeywordExtCgToDataType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the primitive type for the specified HLSL keyword or throws an std::runtime_error on failure.
    PrimitiveType hlslKeywordToPrimitiveType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the storage class for the specified HLSL keyword or throws an std::runtime_error on failure.
    StorageClass hlslKeywordToStorageClass(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the interpolation modifier for the specified HLSL keyword or throws an std::runtime_error on failure.
    InterpModifier hlslKeywordToInterpModifier(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the type modifier for the specified HLSL keyword or throws an std::runtime_error on failure.
    TypeModifier hlslKeywordToTypeModifier(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the uniform buffer type for the specified HLSL keyword or throws an std::runtime_error on failure.
    UniformBufferType hlslKeywordToUniformBufferType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the buffer type for the specified HLSL keyword or throws an std::runtime_error on failure.
    BufferType hlslKeywordToBufferType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the sampler type for the specified HLSL keyword or throws an std::runtime_error on failure.
    SamplerType hlslKeywordToSamplerType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the HLSL keyword for the specified attribut type or null on failure.
    const String* attributeTypeToHLSLKeyword(const AttributeType t);
 
    // Returns the attribute type for the specified HLSL keyword or returns AttributeType::Undefined.
    AttributeType hlslKeywordToAttributeType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the attribute value for the specified HLSL keyword or returns AttributeValue::Undefined.
    AttributeValue hlslKeywordToAttributeValue(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the semantic for the specified identifier or Semantic::UserDefined if the identifier is not reserved.
    IndexedSemantic hlslKeywordToSemantic(const String& ident, bool useD3D10Semantics = true);
 
    // ---------------------------------------------------------------------------------------------
 
    // Maps a keyword from "layout" attribute extension into an image layout format or returns ImageLayoutFormat::Undefined.
    ImageLayoutFormat extHLSLKeywordToImageLayoutFormat(const String& keyword);
 
} // namespace CeresEngine::ShaderCompiler