DALi Version 2.2.11
[platform/core/uifw/dali-toolkit.git] / dali-scene3d / internal / common / image-based-light-observer.h
1 #ifndef DALI_SCENE3D_INTERNAL_IMAGE_BASED_LIGHT_OBSERVER_H
2 #define DALI_SCENE3D_INTERNAL_IMAGE_BASED_LIGHT_OBSERVER_H
3
4 /*
5  * Copyright (c) 2022 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali-toolkit/public-api/dali-toolkit-common.h>
23 #include <dali/public-api/rendering/texture.h>
24
25 namespace Dali
26 {
27 namespace Scene3D
28 {
29 namespace Internal
30 {
31 class ImageBasedLightObserver
32 {
33 public:
34   /**
35    * @brief Constructor.
36    */
37   ImageBasedLightObserver() = default;
38
39   /**
40    * @brief Virtual destructor.
41    */
42   virtual ~ImageBasedLightObserver() = default;
43
44   /**
45    * @brief Notifies Image Based Light Textures are changed by parent SceneView.
46    *
47    * @param[in] diffuseTexture cube map texture that can be used as a diffuse IBL source.
48    * @param[in] specularTexture cube map texture that can be used as a specular IBL source.
49    * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f]. Default value is 1.0f.
50    */
51   virtual void NotifyImageBasedLightTexture(Dali::Texture diffuseTexture, Dali::Texture specularTexture, float scaleFactor) = 0;
52
53   /**
54    * @brief Notifies Scale Factor of Image Based Light is changed by parent SceneView.
55    *
56    * @param[in] scaleFactor scale factor that controls light source intensity in [0.0f, 1.0f].
57    */
58   virtual void NotifyImageBasedLightScaleFactor(float scaleFactor) = 0;
59 };
60
61 } // namespace Internal
62
63 } // namespace Scene3D
64
65 } // namespace Dali
66
67 #endif // DALI_SCENE3D_INTERNAL_IMAGE_BASED_LIGHT_OBSERVER_H