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) 2023 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 // EXTERNAL INCLUDES
  21 #include <dali/public-api/common/vector-wrapper.h>
  22 #include <dali/public-api/rendering/shader.h>
  23 #include <memory>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-scene3d/public-api/loader/renderer-state.h>
  27 #include <dali-scene3d/public-api/loader/shader-option.h>
  28
  29 namespace Dali::Scene3D::Loader
  30 {
  31 /**
  32  * @brief Defines a shader with paths to the files which define its
  33  *  vertex and fragment components, and a mapping of uniform names (which are
  34  *  used to refer to them in GLSL) to data.
  35  * @SINCE_2_0.7
  36  */
  37 struct DALI_SCENE3D_API ShaderDefinition
  38 {
  39   using Vector = std::vector<std::pair<ShaderDefinition, Shader>>;
  40
  41   struct RawData
  42   {
  43     std::string mVertexShaderSource;
  44     std::string mFragmentShaderSource;
  45     std::string mShadowVertexShaderSource;
  46     std::string mShadowFragmentShaderSource;
  47   };
  48
  49   ShaderDefinition() = default;
  50
  51   ShaderDefinition(const ShaderDefinition& other);
  52   ShaderDefinition& operator=(const ShaderDefinition& other) = delete;
  53
  54   ShaderDefinition(ShaderDefinition&&) = default;
  55   ShaderDefinition& operator=(ShaderDefinition&&) = default;
  56
  57   /**
  58    * @brief Attempts to load the source of the vertex and fragment shaders,
  59    *  then performs pre-processing of defines.
  60    * @SINCE_2_0.7
  61    * @note This may be called from any thread.
  62    */
  63   RawData LoadRaw(const std::string& shadersPath) const;
  64
  65   /**
  66    * @brief Creates a DALi Shader from the sources in @a raw, traverses
  67    *  uniforms to get them to register their data against their name,
  68    *  then returns the Shader.
  69    * @SINCE_2_0.7
  70    * @note This must be called from the event thread.
  71    */
  72   Shader Load(RawData&& raw) const;
  73
  74 public: // DATA
  75   std::shared_ptr<RawData> mRawData;
  76   RendererState::Type      mRendererState = RendererState::NONE;
  77
  78   std::string                                mVertexShaderPath;
  79   std::string                                mFragmentShaderPath;
  80   std::vector<std::string>                   mDefines;
  81   std::vector<ShaderOption::MacroDefinition> mMacros;
  82   std::vector<std::string>                   mHints;
  83   Property::Map                              mUniforms;
  84   bool                                       mUseBuiltInShader{false};
  85 };
  86
  87 } // namespace Dali::Scene3D::Loader
  88
  89 #endif // DALI_SCENE3D_LOADER_SHADER_DEFINITION_H