GLSLKeywords.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/SmartPtr.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Set.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/ASTEnums.hpp"
#include "CeresEngine/Material/ShaderCompiler/AST/Token.hpp"
 
#include <memory>
 
namespace CeresEngine::ShaderCompiler {
 
    // Returns the Keyword-to-Token map for GLSL.
    const KeywordMapType& glslKeywords();
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified data type or null on failure.
    const String* dataTypeToGLSLKeyword(const DataType t);
 
    // Returns the data type for the specified GLSL keyword or throws an std::runtime_error on failure.
    DataType glslKeywordToDataType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified storage class or null on failure.
    const String* storageClassToGLSLKeyword(const StorageClass t);
 
    // Returns the storage class for the specified GLSL keyword or throws an std::runtime_error on failure.
    StorageClass glslKeywordToStorageClass(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified interpolation modifier or null on failure.
    const String* interpModifierToGLSLKeyword(const InterpModifier t);
 
    // Returns the interpolation modifier for the specified GLSL keyword or throws an std::runtime_error on failure.
    InterpModifier glslKeywordToInterpModifier(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified buffer type or null on failure.
    const String* bufferTypeToGLSLKeyword(const BufferType t, bool useVulkanGLSL = false, bool separateSamplers = true);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified sampler type or null on failure.
    const String* samplerTypeToGLSLKeyword(const SamplerType t);
 
    // Returns the sampler type for the specified GLSL keyword or throws an std::runtime_error on failure.
    SamplerType glslKeywordToSamplerType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified attribut type or null on failure.
    const String* attributeTypeToGLSLKeyword(const AttributeType t);
 
    // Returns the attribute type for the specified GLSL keyword or returns AttributeValue::Undefined.
    AttributeType glslKeywordToAttributeType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified attribut value or null on failure.
    const String* attributeValueToGLSLKeyword(const AttributeValue t);
 
    // Returns the attribute value for the specified GLSL keyword or returns AttributeValue::Undefined.
    AttributeValue glslKeywordToAttributeValue(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified geometry primtive type or null on failure.
    const String* primitiveTypeToGLSLKeyword(const PrimitiveType t);
 
    // Returns the primitive type for the specified GLSL keyword or throws an std::runtime_error on failure.
    PrimitiveType glslKeywordToPrimitiveType(const String& keyword);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified image layout format or null on failure.
    const String* imageLayoutFormatToGLSLKeyword(const ImageLayoutFormat t);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the GLSL keyword for the specified semantic (special cases if 'useVulkanGLSL' is true).
    // see https://www.khronos.org/registry/vulkan/specs/misc/GL_KHR_vulkan_glsl.txt
    UPtr<String> semanticToGLSLKeyword(const IndexedSemantic& semantic, bool useVulkanGLSL = false);
 
    // Returns the GLSL data type for specified semantic.
    DataType semanticToGLSLDataType(const Semantic t);
 
    // ---------------------------------------------------------------------------------------------
 
    // Returns the set of all reserved GLSL keywords (functions, intrinsics, types etc.).
    const Set<String>& reservedGLSLKeywords();
 
} // namespace CeresEngine::ShaderCompiler