1 #ifndef DALI_TOOLKIT_IMAGE_ATLAS_MANAGER_H
2 #define DALI_TOOLKIT_IMAGE_ATLAS_MANAGER_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 #include <dali/public-api/common/vector-wrapper.h>
22 #include <dali/public-api/object/ref-object.h>
23 #include <dali/public-api/rendering/texture-set.h>
27 #include <dali-toolkit/devel-api/image-loader/image-atlas.h>
33 class AtlasUploadObserver;
38 * The manager for automatic image atlasing. Owned by VisualFactory
40 class ImageAtlasManager : public RefObject
43 typedef std::vector<Toolkit::ImageAtlas> AtlasContainer;
44 typedef std::vector<TextureSet> TextureSetContainer;
54 * @brief Add an image to the atlas.
56 * @note To make the atlasing efficient, an valid size should be provided.
57 * If size is not provided, then the image file will be opened to read the actual size for loading.
59 * SamplingMode::BOX_THEN_LINEAR is used to sampling pixels from the input image while fitting it to desired size.
61 * @param [out] textureRect The texture area of the resource image in the atlas.
62 * @param [in] url The URL of the resource image file to use.
63 * @param [in, out] size The width and height to fit the loaded image to.
64 * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
65 * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
66 * @param [in] atlasUploadObserver The object to observe the uploading state inside ImageAtlas.
67 * @return The texture set containing the image.
69 TextureSet Add(Vector4& textureRect,
70 const std::string& url,
71 ImageDimensions& size,
72 FittingMode::Type fittingMode = FittingMode::DEFAULT,
73 bool orientationCorrection = true,
74 AtlasUploadObserver* atlasUploadObserver = NULL);
76 * @brief Add a pixel buffer to the atlas
78 * @param [out] textureRect The texture area of the resource image in the atlas.
79 * @param [in] pixelData The pixel data.
80 * @return The texture set containing the image.
82 TextureSet Add(Vector4& textureRect,
86 * Remove the image at the given rectangle from the texture set.
88 * @param [in] textureSet The texture set containing the atlas image.
89 * @param [in] textureRect The texture area to be removed.
91 void Remove(TextureSet textureSet, const Vector4& textureRect);
94 * @brief Set the broken image which is used to replace the image if loading fails.
96 * @param[in] brokenImageUrl The url of the broken image.
98 void SetBrokenImage(const std::string& brokenImageUrl);
103 Shader GetShader() const;
107 * @brief Create a new atlas.
109 * This method is called when the newly added image or pixel buffer cannot fit into the current atlas list.
111 void CreateNewAtlas();
117 ~ImageAtlasManager() override;
120 * Undefined copy constructor.
122 ImageAtlasManager(const ImageAtlasManager&);
125 * Undefined assignment operator.
127 ImageAtlasManager& operator=(const ImageAtlasManager& rhs);
130 AtlasContainer mAtlasList;
131 TextureSetContainer mTextureSetList;
132 std::string mBrokenImageUrl;
135 } // namespace Internal
137 } // namespace Toolkit
141 #endif // DALI_TOOLKIT_ATLAS_MANAGER_H