dali-scene3d/public-api/loader/environment-map-loader.h

   1 #ifndef DALI_SCENE3D_LOADER_ENVIRONMENT_MAP_LOADER_H
   2 #define DALI_SCENE3D_LOADER_ENVIRONMENT_MAP_LOADER_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 // INTERNAL INCLUDES
  21 #include <dali-scene3d/public-api/api.h>
  22 #include <dali-scene3d/public-api/common/environment-map.h>
  23 #include <dali-scene3d/public-api/loader/environment-map-data.h>
  24
  25 namespace Dali::Scene3D::Loader
  26 {
  27 /**
  28  * @brief Loads environment map data from a environment map file.
  29  *
  30  * @SINCE_2_1.32
  31  * @param[in] environmentMapUrl The environment map file url.
  32  * @param[out] environmentMapData The data structure with all pixel data objects.
  33  * @return bool True if the loading is succeded.
  34  */
  35 bool DALI_SCENE3D_API LoadEnvironmentMap(const std::string& environmentMapUrl, EnvironmentMapData& environmentMapData);
  36
  37 } // namespace Dali::Scene3D::Loader
  38
  39 #endif // DALI_SCENE3D_LOADER_ENVIRONMENT_MAP_LOADER_H