dali-scene3d/public-api/loader/shader-definition.h

   1 #ifndef DALI_SCENE3D_LOADER_SHADER_DEFINITION_H
   2 #define DALI_SCENE3D_LOADER_SHADER_DEFINITION_H
   3 /*
   4  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 // INTERNAL INCLUDES
  21 #include "dali-scene3d/public-api/loader/renderer-state.h"
  22
  23 // EXTERNAL INCLUDES
  24 #include <memory>
  25 #include "dali/public-api/common/vector-wrapper.h"
  26 #include "dali/public-api/rendering/shader.h"
  27
  28 namespace Dali
  29 {
  30 namespace Scene3D
  31 {
  32 namespace Loader
  33 {
  34 /*
  35  * @brief Defines a shader with paths to the files which define its
  36  *  vertex and fragment components, and a mapping of uniform names (which are
  37  *  used to refer to them in GLSL) to data.
  38  */
  39 struct DALI_SCENE3D_API ShaderDefinition
  40 {
  41   using Vector = std::vector<std::pair<ShaderDefinition, Shader>>;
  42
  43   struct RawData
  44   {
  45     std::string mVertexShaderSource;
  46     std::string mFragmentShaderSource;
  47   };
  48
  49   /*
  50    * @brief Apply the defines values to shader.
  51    */
  52   static void ApplyDefine(std::string& shaderCode, const std::string& definevar);
  53
  54   ShaderDefinition() = default;
  55
  56   ShaderDefinition(const ShaderDefinition& other);
  57   ShaderDefinition& operator=(const ShaderDefinition& other);
  58
  59   ShaderDefinition(ShaderDefinition&&) = default;
  60   ShaderDefinition& operator=(ShaderDefinition&&) = default;
  61
  62   /*
  63    * @brief Attempts to load the source of the vertex and fragment shaders,
  64    *  then performs pre-processing of defines.
  65    * @note This may be called from any thread.
  66    */
  67   RawData LoadRaw(const std::string& shadersPath) const;
  68
  69   /*
  70    * @brief Creates a DALi Shader from the sources in @a raw, traverses
  71    *  uniforms to get them to register their data against their name,
  72    *  then returns the Shader.
  73    * @note This must be called from the event thread.
  74    */
  75   Shader Load(RawData&& raw) const;
  76
  77 public: // DATA
  78   RendererState::Type mRendererState = RendererState::NONE;
  79
  80   std::string              mVertexShaderPath;
  81   std::string              mFragmentShaderPath;
  82   std::vector<std::string> mDefines;
  83   std::vector<std::string> mHints;
  84   Property::Map            mUniforms;
  85   bool                     mUseBuiltInShader{false};
  86 };
  87
  88 } // namespace Loader
  89 } // namespace Scene3D
  90 } // namespace Dali
  91
  92 #endif //DALI_SCENE3D_LOADER_SHADER_DEFINITION_H