src/client/shader.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2013 Kahrl <kahrl@gmx.net>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #pragma once
  22
  23 #include "irrlichttypes_bloated.h"
  24 #include <IMaterialRendererServices.h>
  25 #include <string>
  26 #include "tile.h"
  27 #include "nodedef.h"
  28
  29 class IGameDef;
  30
  31 /*
  32         shader.{h,cpp}: Shader handling stuff.
  33 */
  34
  35 /*
  36         Gets the path to a shader by first checking if the file
  37           name_of_shader/filename
  38         exists in shader_path and if not, using the data path.
  39
  40         If not found, returns "".
  41
  42         Utilizes a thread-safe cache.
  43 */
  44 std::string getShaderPath(const std::string &name_of_shader,
  45                 const std::string &filename);
  46
  47 struct ShaderInfo {
  48         std::string name = "";
  49         video::E_MATERIAL_TYPE base_material = video::EMT_SOLID;
  50         video::E_MATERIAL_TYPE material = video::EMT_SOLID;
  51         NodeDrawType drawtype = NDT_NORMAL;
  52         MaterialType material_type = TILE_MATERIAL_BASIC;
  53
  54         ShaderInfo() = default;
  55         virtual ~ShaderInfo() = default;
  56 };
  57
  58 /*
  59         Setter of constants for shaders
  60 */
  61
  62 namespace irr { namespace video {
  63         class IMaterialRendererServices;
  64 } }
  65
  66
  67 class IShaderConstantSetter {
  68 public:
  69         virtual ~IShaderConstantSetter() = default;
  70         virtual void onSetConstants(video::IMaterialRendererServices *services) = 0;
  71         virtual void onSetMaterial(const video::SMaterial& material)
  72         { }
  73 };
  74
  75
  76 class IShaderConstantSetterFactory {
  77 public:
  78         virtual ~IShaderConstantSetterFactory() = default;
  79         virtual IShaderConstantSetter* create() = 0;
  80 };
  81
  82
  83 template <typename T, std::size_t count=1>
  84 class CachedShaderSetting {
  85         const char *m_name;
  86         T m_sent[count];
  87         bool has_been_set = false;
  88         bool is_pixel;
  89 protected:
  90         CachedShaderSetting(const char *name, bool is_pixel) :
  91                 m_name(name), is_pixel(is_pixel)
  92         {}
  93 public:
  94         void set(const T value[count], video::IMaterialRendererServices *services)
  95         {
  96                 if (has_been_set && std::equal(m_sent, m_sent + count, value))
  97                         return;
  98                 if (is_pixel)
  99                         services->setPixelShaderConstant(services->getPixelShaderConstantID(m_name), value, count);
 100                 else
 101                         services->setVertexShaderConstant(services->getVertexShaderConstantID(m_name), value, count);
 102
 103                 std::copy(value, value + count, m_sent);
 104                 has_been_set = true;
 105         }
 106 };
 107
 108 template <typename T, std::size_t count = 1>
 109 class CachedPixelShaderSetting : public CachedShaderSetting<T, count> {
 110 public:
 111         CachedPixelShaderSetting(const char *name) :
 112                 CachedShaderSetting<T, count>(name, true){}
 113 };
 114
 115 template <typename T, std::size_t count = 1>
 116 class CachedVertexShaderSetting : public CachedShaderSetting<T, count> {
 117 public:
 118         CachedVertexShaderSetting(const char *name) :
 119                 CachedShaderSetting<T, count>(name, false){}
 120 };
 121
 122
 123 /*
 124         ShaderSource creates and caches shaders.
 125 */
 126
 127 class IShaderSource {
 128 public:
 129         IShaderSource() = default;
 130         virtual ~IShaderSource() = default;
 131
 132         virtual u32 getShaderIdDirect(const std::string &name,
 133                 MaterialType material_type, NodeDrawType drawtype = NDT_NORMAL){return 0;}
 134         virtual ShaderInfo getShaderInfo(u32 id){return ShaderInfo();}
 135         virtual u32 getShader(const std::string &name,
 136                 MaterialType material_type, NodeDrawType drawtype = NDT_NORMAL){return 0;}
 137 };
 138
 139 class IWritableShaderSource : public IShaderSource {
 140 public:
 141         IWritableShaderSource() = default;
 142         virtual ~IWritableShaderSource() = default;
 143
 144         virtual void processQueue()=0;
 145         virtual void insertSourceShader(const std::string &name_of_shader,
 146                 const std::string &filename, const std::string &program)=0;
 147         virtual void rebuildShaders()=0;
 148
 149         /// @note Takes ownership of @p setter.
 150         virtual void addShaderConstantSetterFactory(IShaderConstantSetterFactory *setter) = 0;
 151 };
 152
 153 IWritableShaderSource *createShaderSource();
 154
 155 void dumpShaderProgram(std::ostream &output_stream,
 156         const std::string &program_type, const std::string &program);