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/public-api/math/uint-16-pair.h>
24 #include <dali/devel-api/common/owner-container.h>
25 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
28 #include <dali-toolkit/internal/visuals/texture-manager-impl.h>
39 namespace NPatchBuffer
42 void GetRedOffsetAndMask( Dali::Pixel::Format pixelFormat, int& byteOffset, int& bitMask );
44 } // namespace NPatchBuffer
47 * The manager for loading Npatch textures.
48 * It caches them internally for better performance; i.e. to avoid loading and
49 * parsing the files over and over.
51 * Cache is not cleaned during app lifecycle as N patches take considerably
52 * small space and there's not usually a lot of them. Usually N patches are specified in
53 * toolkit default style and there is 1-2 per control that are shared across the whole application.
59 typedef Dali::Vector< Uint16Pair > StretchRanges;
63 UNINITIALIZED_ID = 0 ///< uninitialised id, use to initialize ids
75 loadCompleted( false )
78 std::string url; ///< Url of the N-Patch
79 TextureSet textureSet; ///< Texture containing the cropped image
80 StretchRanges stretchPixelsX; ///< X stretch pixels
81 StretchRanges stretchPixelsY; ///< Y stretch pixels
82 std::size_t hash; ///< Hash code for the Url
83 uint32_t croppedWidth; ///< Width of the cropped middle part of N-patch
84 uint32_t croppedHeight; ///< Height of the cropped middle part of N-patch
85 Rect< int > border; ///< The size of the border
86 bool loadCompleted; ///< True if the data loading is completed
97 * Destructor, non-virtual as not a base class
102 * @brief Retrieve a texture matching the n-patch url.
104 * @param [in] textureManager that will be used to loading image
105 * @param [in] textureObserver The NPatchVisual that requested loading.
106 * @param [in] url to retrieve
107 * @param [in] border The border size of the image
108 * @param [in,out] preMultiplyOnLoad True if the image color should be multiplied by it's alpha. Set to false if the
109 * image has no alpha channel
110 * @param [in] synchronousLoading True if the image will be loaded in synchronous time.
111 * @return id of the texture.
113 std::size_t Load( TextureManager& textureManager, TextureUploadObserver* textureObserver, const std::string& url, const Rect< int >& border, bool& preMultiplyOnLoad, bool synchronousLoading );
116 * @brief Set loaded PixelBuffer and its information
118 * @param [in] id cache data id
119 * @param [in] pixelBuffer of loaded image
121 void SetNPatchData( std::size_t id, Devel::PixelBuffer& pixelBuffer );
124 * @brief Retrieve N patch data matching to an id
125 * @param [in] id of data
126 * @param [out] data const pointer to the data
127 * @return true if data matching to id was really found
129 bool GetNPatchData( std::size_t id, const Data*& data );
134 * Undefined copy constructor.
136 NPatchLoader(const NPatchLoader&);
139 * Undefined assignment operator.
141 NPatchLoader& operator=(const NPatchLoader& rhs);
145 OwnerContainer< Data* > mCache;
151 } // namespace Toolkit
155 #endif // DALI_TOOLKIT_NPATCH_LOADER_H