dali-scene3d/public-api/loader/gltf2-loader.h

   1 #ifndef DALI_SCENE3D_LOADER_GLTF2_LOADER_H
   2 #define DALI_SCENE3D_LOADER_GLTF2_LOADER_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-scene3d/public-api/api.h"
  22
  23 // EXTERNAL INCLUDES
  24 #include <string>
  25
  26 namespace Dali
  27 {
  28 namespace Scene3D
  29 {
  30 namespace Loader
  31 {
  32 struct CameraParameters;
  33 struct LoadResult;
  34 class ShaderDefinitionFactory;
  35
  36 /**
  37  * @brief Initialize glTF Loader.
  38  * @note This method should be called once before LoadGltfScene() is called.
  39  */
  40 DALI_SCENE3D_API void InitializeGltfLoader();
  41
  42 /**
  43  * @brief Loads the scene from the glTF file located at @a url, storing the results in @a params.
  44  * @note Will throw std::runtime_error for JSON entities with types mismatching expectations, carrying
  45  *  invalid values, or I/O errors.
  46  * @note InitializeGltfLoader() should be called once before this function is called.
  47  */
  48 DALI_SCENE3D_API void LoadGltfScene(const std::string& url, ShaderDefinitionFactory& shaderFactory, LoadResult& params);
  49
  50 } // namespace Loader
  51 } // namespace Scene3D
  52 } // namespace Dali
  53
  54 #endif //DALI_SCENE3D_LOADER_GLTF2_LOADER_H