IEffects.h

Go to the documentation of this file.

#pragma once
 
#include "VertexFormat.h"
 
#include "Foundation/StringView.h"
 
namespace Cogs
{
  typedef std::pair<std::string, std::string> PreprocessorDefinition;
 
  typedef std::vector<PreprocessorDefinition> PreprocessorDefinitions;
 
  struct EffectFlags
  {
    enum EEffectFlags
    {
      None = 0,
      HLSL = 0x1,
      GLSL = 0x2,
      GeometryShader = 0x4,
      Pinned = 0x8,
      LogShaderInfo = 0x10,
      LogShaderSource = 0x20,
      WGSL = 0x40,
    };
  };
 
  enum class EffectDescriptionType
  {
    File,
    Source,
  };
 
  struct EffectDescription
  {
    StringView vertexShader;
 
    StringView hullShader;
 
    StringView domainShader;
 
    StringView geometryShader;
 
    StringView pixelShader;
 
    StringView effect;
 
    StringView vsEntryPoint;
 
    StringView hsEntryPoint;
 
    StringView dsEntryPoint;
 
    StringView gsEntryPoint;
 
    StringView psEntryPoint;
 
    StringView name;
 
    PreprocessorDefinitions definitions;
 
    EffectFlags::EEffectFlags flags = EffectFlags::None;
    
    EffectDescriptionType type = EffectDescriptionType::File;
  };
 
  struct IIOHandler
  {
    virtual ~IIOHandler() {}
 
    virtual bool openFile(const StringView & fileName, std::string & content) = 0;
 
    virtual bool resolveFile(const StringView & source, const StringView & fileName, std::string & content) = 0;
 
    enum class FileType
    {
      ShaderDump = 0,
      ShaderCache,
      PipelineCache
    };
 
    virtual bool exists(FileType type, const StringView & fileName) = 0;
 
    virtual bool writeBinaryFile(FileType type, const StringView & fileName, const void * content, size_t contentSize) = 0;
    virtual bool openBinaryFile(FileType type, const StringView & fileName, std::vector<uint8_t> & content) = 0;
 
    virtual void pushSearchPaths() = 0;
    virtual void addSearchPath(const StringView & path) = 0;
    virtual void popSearchPaths() = 0;
  };
 
  struct IEffects
  {
    virtual EffectHandle loadEffect(const EffectDescription & description) = 0;
 
    virtual EffectHandle loadEffect(const StringView & fileName, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual EffectHandle loadComputeEffect(const StringView & fileName, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual EffectHandle loadComputeEffect(const StringView & fileName, const PreprocessorDefinitions & definitions, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual EffectHandle loadEffect(const StringView & vsFileName, const StringView & psFileName, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
    
    virtual EffectHandle loadEffect(const StringView & vsFileName, const StringView & psFileName, const PreprocessorDefinitions & definitions, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual EffectHandle loadEffectSource(const StringView & vsSource, const StringView & psSource, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual EffectHandle loadEffectSource(const StringView & vsSource, const StringView & gsSource, const StringView & psSource, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
    
    virtual EffectHandle loadEffectSource(const StringView & vsSource, const StringView & psSource, const PreprocessorDefinitions & definitions, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual EffectHandle loadEffectSource(const StringView & vsSource, const StringView & gsSource, const StringView & psSource, const PreprocessorDefinitions & definitions, EffectFlags::EEffectFlags effectFlags = EffectFlags::None) = 0;
 
    virtual void releaseEffect(EffectHandle effectHandle) = 0;
 
    virtual EffectVariableHandle getEffectVariable(EffectHandle effectHandle, const StringView & name) = 0;
 
    virtual ConstantBufferBindingHandle getConstantBufferBinding(EffectHandle effectHandle, const StringView & name) = 0;
 
    virtual TextureBindingHandle getTextureBinding(EffectHandle effectHandle, const StringView & name, const unsigned int slot) = 0;
 
    virtual BufferBindingHandle getBufferBinding(EffectHandle effectHandle, const StringView & name) = 0;
 
    virtual void releaseBufferBinding(BufferBindingHandle bufferBindingHandle) = 0;
 
    virtual SamplerStateBindingHandle getSamplerStateBinding(EffectHandle effectHandle, const StringView & name, const unsigned int slot) = 0;
 
    virtual void releaseResources() = 0;
 
    virtual void annotate(EffectHandle handle, const StringView & name) { (void)handle; (void)name; }
 
    virtual void annotateVS(EffectHandle handle, const StringView & name) { (void)handle; (void)name; }
 
    virtual void annotateGS(EffectHandle handle, const StringView & name) { (void)handle; (void)name; }
 
    virtual void annotatePS(EffectHandle handle, const StringView & name) { (void)handle; (void)name; }
 
    virtual void annotateCS(EffectHandle handle, const StringView & name) { (void)handle; (void)name; }
 
    virtual void setIOHandler(IIOHandler * handler) = 0;
 
    virtual IIOHandler * getIOHandler() { return nullptr; }
  };
}