[dali_2.3.22] Merge branch 'devel/master'
[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / common / environment-map.h
1 #ifndef DALI_SCENE3D_COMMON_ENVIRONMENT_MAP_H
2 #define DALI_SCENE3D_COMMON_ENVIRONMENT_MAP_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 namespace Dali
21 {
22 namespace Scene3D
23 {
24
25 /**
26  * @brief The Environment Map types
27  * @SINCE_2_2.11
28  */
29 enum class EnvironmentMapType
30 {
31   AUTO,           ///< Automatically detects the type of input environment map.
32                   ///  DALi finds the closest aspect ratio of the input texture to guess the environment map type.
33   CUBEMAP,        ///< Environment map in cubemap
34                   ///  DALi supports cross and array type of cube map for the vertical and horizontal direction.
35                   ///  For example, if the aspect ratio of a texture is 4x3, the texture is classified as a horizontal cross type.
36                   ///  On the other hand, if the aspect ratio is 6x1, it can be sorted as a horizontal array.
37   EQUIRECTANGULAR ///< Environment map in equirectangular projection. Usually equirectangular image has 2x1 aspect ratio.
38 };
39
40 } // namespace Scene3D
41 } // namespace Dali
42
43 #endif // DALI_SCENE3D_COMMON_ENVIRONMENT_MAP_H