1 #ifndef DALI_TOOLKIT_NPATCH_LOADER_H
2 #define DALI_TOOLKIT_NPATCH_LOADER_H
5 * Copyright (c) 2020 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.
22 #include <dali/public-api/rendering/texture-set.h>
23 #include <dali/devel-api/common/owner-container.h>
24 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
27 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
28 #include <dali-toolkit/devel-api/utility/npatch-utilities.h>
40 * The manager for loading Npatch textures.
41 * It caches them internally for better performance; i.e. to avoid loading and
42 * parsing the files over and over.
44 * Cache is not cleaned during app lifecycle as N patches take considerably
45 * small space and there's not usually a lot of them. Usually N patches are specified in
46 * toolkit default style and there is 1-2 per control that are shared across the whole application.
54 UNINITIALIZED_ID = 0 ///< uninitialised id, use to initialize ids
66 loadCompleted( false ),
67 renderingMap{ nullptr }
72 using ObserverListType = Dali::Vector< TextureUploadObserver* >;
74 ObserverListType observerList; ///< Container used to store all observer clients of this Texture
75 std::string url; ///< Url of the N-Patch
76 TextureSet textureSet; ///< Texture containing the cropped image
77 NPatchUtility::StretchRanges stretchPixelsX; ///< X stretch pixels
78 NPatchUtility::StretchRanges stretchPixelsY; ///< Y stretch pixels
79 std::size_t hash; ///< Hash code for the Url
80 uint32_t croppedWidth; ///< Width of the cropped middle part of N-patch
81 uint32_t croppedHeight; ///< Height of the cropped middle part of N-patch
82 Rect< int > border; ///< The size of the border
83 bool loadCompleted; ///< True if the data loading is completed
84 void* renderingMap; ///< NPatch rendering data
95 * Destructor, non-virtual as not a base class
100 * @brief Retrieve a texture matching the n-patch url.
102 * @param [in] textureManager that will be used to loading image
103 * @param [in] textureObserver The NPatchVisual that requested loading.
104 * @param [in] url to retrieve
105 * @param [in] border The border size of the image
106 * @param [in,out] preMultiplyOnLoad True if the image color should be multiplied by it's alpha. Set to false if the
107 * image has no alpha channel
108 * @param [in] synchronousLoading True if the image will be loaded in synchronous time.
109 * @return id of the texture.
111 std::size_t Load( TextureManager& textureManager, TextureUploadObserver* textureObserver, const std::string& url, const Rect< int >& border, bool& preMultiplyOnLoad, bool synchronousLoading );
114 * @brief Set loaded PixelBuffer and its information
116 * @param [in] loadSuccess True if the texture load was successful (i.e. the resource is available). If false, then the resource failed to load.
117 * @param [in] id cache data id
118 * @param [in] pixelBuffer of loaded image
119 * @param [in] url The url address of the loaded image.
120 * @param [in] preMultiplied True if the image had pre-multiplied alpha applied
122 void SetNPatchData( bool loadSuccess, std::size_t id, Devel::PixelBuffer& pixelBuffer, const Internal::VisualUrl& url, bool preMultiplied );
125 * @brief Retrieve N patch data matching to an id
126 * @param [in] id of data
127 * @param [out] data const pointer to the data
128 * @return true if data matching to id was really found
130 bool GetNPatchData( std::size_t id, const Data*& data );
135 * Undefined copy constructor.
137 NPatchLoader(const NPatchLoader&);
140 * Undefined assignment operator.
142 NPatchLoader& operator=(const NPatchLoader& rhs);
146 OwnerContainer< Data* > mCache;
152 } // namespace Toolkit
156 #endif // DALI_TOOLKIT_NPATCH_LOADER_H