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  */
  36 struct DALI_SCENE3D_API ShaderDefinition
  37 {
  38   using Vector = std::vector<std::pair<ShaderDefinition, Shader>>;
  39
  40   struct RawData
  41   {
  42     std::string mVertexShaderSource;
  43     std::string mFragmentShaderSource;
  44     std::string mShadowVertexShaderSource;
  45     std::string mShadowFragmentShaderSource;
  46   };
  47
  48   ShaderDefinition() = default;
  49
  50   ShaderDefinition(const ShaderDefinition& other);
  51   ShaderDefinition& operator=(const ShaderDefinition& other);
  52
  53   ShaderDefinition(ShaderDefinition&&) = default;
  54   ShaderDefinition& operator=(ShaderDefinition&&) = default;
  55
  56   /*
  57    * @brief Attempts to load the source of the vertex and fragment shaders,
  58    *  then performs pre-processing of defines.
  59    * @note This may be called from any thread.
  60    */
  61   RawData LoadRaw(const std::string& shadersPath) const;
  62
  63   /*
  64    * @brief Creates a DALi Shader from the sources in @a raw, traverses
  65    *  uniforms to get them to register their data against their name,
  66    *  then returns the Shader.
  67    * @note This must be called from the event thread.
  68    */
  69   Shader Load(RawData&& raw) const;
  70
  71 public: // DATA
  72   std::shared_ptr<RawData> mRawData;
  73   RendererState::Type      mRendererState = RendererState::NONE;
  74
  75   std::string                                mVertexShaderPath;
  76   std::string                                mFragmentShaderPath;
  77   std::vector<std::string>                   mDefines;
  78   std::vector<ShaderOption::MacroDefinition> mMacros;
  79   std::vector<std::string>                   mHints;
  80   Property::Map                              mUniforms;
  81   bool                                       mUseBuiltInShader{false};
  82 };
  83
  84 } // namespace Dali::Scene3D::Loader
  85
  86 #endif // DALI_SCENE3D_LOADER_SHADER_DEFINITION_H