dali-scene-loader/public-api/environment-definition.h

   1 #ifndef DALI_SCENE_LOADER_ENVIRONMENT_DEFINITION_H
   2 #define DALI_SCENE_LOADER_ENVIRONMENT_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-scene-loader/public-api/api.h"
  22 #include "dali-scene-loader/public-api/ktx-loader.h"
  23
  24 // EXTERNAL INCLUDES
  25 #include "dali/public-api/math/quaternion.h"
  26 #include "dali/public-api/rendering/texture.h"
  27
  28 namespace Dali
  29 {
  30 namespace SceneLoader
  31 {
  32 /**
  33  * @brief Defines an environment map with either or both of radiance
  34  *  and irradiance maps.
  35  */
  36 struct DALI_SCENE_LOADER_API EnvironmentDefinition
  37 {
  38   struct Textures
  39   {
  40     Texture mDiffuse;  // irradiance
  41     Texture mSpecular; // radiance
  42     Texture mBrdf;     // pre-computed brdf
  43
  44     bool IsLoaded() const
  45     {
  46       return mDiffuse || mSpecular;
  47     }
  48   };
  49
  50   struct RawData
  51   {
  52     CubeData  mDiffuse;
  53     CubeData  mSpecular;
  54     PixelData mBrdf;
  55   };
  56
  57   using EnvironmentData = std::pair<EnvironmentDefinition, Textures>;
  58   using Vector          = std::vector<EnvironmentData>;
  59
  60   EnvironmentDefinition() = default;
  61
  62   EnvironmentDefinition(const EnvironmentDefinition&) = delete;
  63   EnvironmentDefinition& operator=(const EnvironmentDefinition&) = delete;
  64
  65   EnvironmentDefinition(EnvironmentDefinition&&) = default;
  66   EnvironmentDefinition& operator=(EnvironmentDefinition&&) = default;
  67
  68   /**
  69    * @brief Loads raw pixel data for the given diffuse and specular maps.
  70    * @note This can be done on any thread.
  71    */
  72   RawData LoadRaw(const std::string& environmentsPath) const;
  73
  74   /**
  75    * @brief Creates DALi cubemap Textures from the pixel data in @a raw, then
  76    *  returns them in a Textures object.
  77    * @note This must only be called from the event thread.
  78    */
  79   Textures Load(RawData&& raw) const;
  80
  81 public: // DATA
  82   std::string mDiffuseMapPath;
  83   std::string mSpecularMapPath;
  84   Quaternion  mCubeOrientation = Quaternion::IDENTITY;
  85   Vector3     mYDirection      = Vector3::ONE;
  86   float       mIblIntensity    = 1.0f;
  87   bool        mUseBrdfTexture  = false;
  88 };
  89
  90 } // namespace SceneLoader
  91 } // namespace Dali
  92
  93 #endif //DALI_SCENE_LOADER_ENVIRONMENT_DEFINITION_H