1 #ifndef __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__
2 #define __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__
5 * Copyright (c) 2015 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/common/vector-wrapper.h>
23 #include <dali/public-api/object/base-object.h>
26 #include <dali-toolkit/internal/atlas-manager/atlas-manager.h>
36 } // namespace Toolkit
44 typedef Dali::Vector< Toolkit::AtlasManager::AtlasSlot > slotContainer;
47 typedef IntrusivePtr<AtlasManager> AtlasManagerPtr;
49 class AtlasManager : public Dali::BaseObject
53 typedef uint32_t SizeType;
54 typedef SizeType AtlasId;
55 typedef SizeType ImageId;
58 * @brief Internal storage of atlas attributes and image upload results
60 struct AtlasDescriptor
62 Dali::Atlas mAtlas; // atlas image
63 Toolkit::AtlasManager::AtlasSize mSize; // size of atlas
64 Pixel::Format mPixelFormat; // pixel format used by atlas
65 BufferImage mHorizontalStrip; // Image used to pad upload
66 BufferImage mVerticalStrip; // Image used to pad upload
67 Material mMaterial; // material used for atlas texture
68 Sampler mSampler; // sampler used for atlas texture
69 SizeType mTotalBlocks; // total number of blocks in atlas
70 SizeType mAvailableBlocks; // number of blocks available in atlas
71 Dali::Vector< SizeType > mFreeBlocksList; // unless there are any previously freed blocks
74 struct AtlasSlotDescriptor
76 SizeType mCount; // Reference count for this slot
77 SizeType mImageWidth; // Width of image stored
78 SizeType mImageHeight; // Height of image stored
79 AtlasId mAtlasId; // Image is stored in this Atlas
80 Dali::Vector< SizeType > mBlocksList; // List of blocks within atlas used for image
86 * Create a new AtlasManager
88 static AtlasManagerPtr New();
90 virtual ~AtlasManager();
93 * @copydoc: Toolkit::AtlasManager::CreateAtlas
95 AtlasId CreateAtlas( const Toolkit::AtlasManager::AtlasSize& size, Pixel::Format pixelformat );
98 * @copydoc Toolkit::AtlasManager::SetAddPolicy
100 void SetAddPolicy( Toolkit::AtlasManager::AddFailPolicy policy );
103 * @copydoc Toolkit::AtlasManager::Add
105 void Add( const BufferImage& image,
106 Toolkit::AtlasManager::AtlasSlot& slot,
107 Toolkit::AtlasManager::AtlasId atlas );
110 * @copydoc Toolkit::AtlasManager::GenerateMeshData
112 void GenerateMeshData( ImageId id,
113 const Vector2& position,
114 Toolkit::AtlasManager::Mesh2D& mesh,
118 * @copydoc Toolkit::AtlasManager::StitchMesh
120 void StitchMesh( Toolkit::AtlasManager::Mesh2D& first,
121 const Toolkit::AtlasManager::Mesh2D& second,
125 * @copydoc Toolkit::AtlasManager::Remove
127 bool Remove( ImageId id );
130 * @copydoc Toolkit::AtlasManager::GetAtlasContainer
132 Dali::Atlas GetAtlasContainer( AtlasId atlas ) const;
135 * @copydoc Toolkit::AtlasManager::GetAtlas
137 AtlasId GetAtlas( ImageId id ) const;
140 * @copydoc Toolkit::AtlasManager::SetNewAtlasSize
142 void SetNewAtlasSize( const Toolkit::AtlasManager::AtlasSize& size );
145 * @copydoc Toolkit::AtlasManager::GetAtlasSize
147 const Toolkit::AtlasManager::AtlasSize& GetAtlasSize( AtlasId atlas );
150 * @copydoc Toolkit::AtlasManager::GetBlockSize
152 Vector2 GetBlockSize( AtlasId atlas );
155 * @copydoc Toolkit::AtlasManager::GetFreeBlocks
157 SizeType GetFreeBlocks( AtlasId atlas ) const;
160 * @copydoc Toolkit::AtlasManager::GetAtlasCount
162 SizeType GetAtlasCount() const;
165 * @copydoc Toolkit::AtlasManager::GetPixelFormat
167 Pixel::Format GetPixelFormat( AtlasId atlas );
170 * @copydoc Toolkit::AtlasManager::GetMetrics
172 void GetMetrics( Toolkit::AtlasManager::Metrics& metrics );
175 * @copydoc Toolkit::AtlasManager::GetMaterial
177 Material GetMaterial( AtlasId atlas ) const;
180 * @copydoc Toolkit::AtlasManager::GetSampler
182 Sampler GetSampler( AtlasId atlas ) const;
186 std::vector< AtlasDescriptor > mAtlasList; // List of atlases created
187 std::vector< AtlasSlotDescriptor > mImageList; // List of bitmaps store in atlases
188 Toolkit::AtlasManager::AtlasSize mNewAtlasSize; // Atlas size to use in next creation
189 Toolkit::AtlasManager::AddFailPolicy mAddFailPolicy; // Policy for faling to add an Image
191 SizeType CheckAtlas( SizeType atlas,
194 Pixel::Format pixelFormat,
195 SizeType& blockArea );
197 void CreateMesh( SizeType atlas,
199 SizeType imageHeight,
200 const Vector2& position,
201 SizeType widthInBlocks,
202 SizeType heightInBlocks,
203 Toolkit::AtlasManager::Mesh2D& mesh,
204 AtlasSlotDescriptor& desc );
206 void OptimizeMesh( const Toolkit::AtlasManager::Mesh2D& in,
207 Toolkit::AtlasManager::Mesh2D& out );
209 void UploadImage( const BufferImage& image,
210 const AtlasSlotDescriptor& desc );
212 void PrintMeshData( const Toolkit::AtlasManager::Mesh2D& mesh );
219 } // namespace Internal
221 inline const Internal::AtlasManager& GetImplementation(const Toolkit::AtlasManager& manager)
223 DALI_ASSERT_ALWAYS( manager && "AtlasManager handle is empty" );
225 const BaseObject& handle = manager.GetBaseObject();
227 return static_cast<const Internal::AtlasManager&>(handle);
230 inline Internal::AtlasManager& GetImplementation(Toolkit::AtlasManager& manager)
232 DALI_ASSERT_ALWAYS( manager && "AtlasManager handle is empty" );
234 BaseObject& handle = manager.GetBaseObject();
236 return static_cast<Internal::AtlasManager&>(handle);
239 } // namespace Toolkit
244 #endif // __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__