1 #ifndef DALI_SCENE_LOADER_RESOURCE_BUNDLE_H_
2 #define DALI_SCENE_LOADER_RESOURCE_BUNDLE_H_
4 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
10 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include "dali-scene-loader/public-api/mesh-definition.h"
22 #include "dali-scene-loader/public-api/material-definition.h"
23 #include "dali-scene-loader/public-api/environment-definition.h"
24 #include "dali-scene-loader/public-api/shader-definition.h"
25 #include "dali-scene-loader/public-api/skeleton-definition.h"
28 #include "dali/public-api/common/vector-wrapper.h"
29 #include "dali/public-api/rendering/shader.h"
30 #include "dali/public-api/rendering/texture-set.h"
40 * @brief The types of resources that .dli may define.
42 struct DALI_SCENE_LOADER_API ResourceType
52 ResourceType() = delete;
56 * @return The string value corresponding to the given resource @a type.
58 DALI_SCENE_LOADER_API const char* GetResourceTypeName(ResourceType::Value type);
60 using ResourceRefCounts = std::vector<Vector<uint32_t>>;
63 * @brief Stores all resource definitions along with the DALi resources that
64 * could be created from them, directly indexible into with values from a dli
67 class DALI_SCENE_LOADER_API ResourceBundle
77 ForceReload = NthBit(0), ///< Load resources [again] even if they were already loaded.
78 KeepUnused = NthBit(1) ///<s Don't reset handles to resources that had a 0 reference count.
82 using PathProvider = std::function<std::string(ResourceType::Value)>;
84 ResourceBundle() = default;
86 ResourceBundle(const ResourceBundle&) = delete;
87 ResourceBundle& operator=(const ResourceBundle&) = delete;
89 ResourceBundle(ResourceBundle&&) = default;
90 ResourceBundle& operator=(ResourceBundle&&) = default;
93 * @return A ResourceRefCounts object with the correct number of entries for
94 * all resource types (based on the various resource definition vectors),
95 * with all reference counts set to 0.
97 ResourceRefCounts CreateRefCounter() const;
100 * @brief Based on a ResourceRefCounts, and more specifically the reference
101 * count of materials therein, it will calculate the reference count of
104 void CountEnvironmentReferences(ResourceRefCounts& refCounts) const;
107 * @brief Performs the loading of all resources based on their respective
108 * reference count in @a refCounts. Resources that had a non-zero ref count will be
109 * loaded unless we already have a handle to them (OR the ForceReload option was specified).
110 * Any handles we have to resources that come in with a zero ref count will be reset,
111 * UNLESS the KeepUnused option was specified.
113 void LoadResources(const ResourceRefCounts& refCounts,
114 PathProvider pathProvider,
115 Options::Type options = Options::None);
118 EnvironmentDefinition::Vector mEnvironmentMaps;
119 ShaderDefinition::Vector mShaders;
120 MeshDefinition::Vector mMeshes;
121 MaterialDefinition::Vector mMaterials;
123 SkeletonDefinition::Vector mSkeletons;
129 #endif //DALI_SCENE_LOADER_RESOURCE_BUNDLE_H_