dali-toolkit/internal/atlas-manager/atlas-manager-impl.h

   1 #ifndef __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__
   2 #define __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  */
  19
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/vector-wrapper.h>
  23 #include <dali/public-api/object/base-object.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/internal/atlas-manager/atlas-manager.h>
  27
  28 namespace Dali
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 class AtlasManager;
  35
  36 } // namespace Toolkit
  37
  38 namespace Toolkit
  39 {
  40
  41 namespace Internal
  42 {
  43
  44 typedef Dali::Vector< Toolkit::AtlasManager::AtlasSlot > slotContainer;
  45
  46 class AtlasManager;
  47 typedef IntrusivePtr<AtlasManager> AtlasManagerPtr;
  48
  49 class AtlasManager : public Dali::BaseObject
  50 {
  51 public:
  52
  53   typedef uint32_t SizeType;
  54   typedef SizeType AtlasId;
  55   typedef SizeType ImageId;
  56
  57   /**
  58    * @brief Internal storage of atlas attributes and image upload results
  59    */
  60   struct AtlasDescriptor
  61   {
  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
  72   };
  73
  74   struct AtlasSlotDescriptor
  75   {
  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
  81   };
  82
  83   AtlasManager();
  84
  85   /**
  86    * Create a new AtlasManager
  87    */
  88   static AtlasManagerPtr New();
  89
  90   virtual ~AtlasManager();
  91
  92   /**
  93    * @copydoc: Toolkit::AtlasManager::CreateAtlas
  94    */
  95   AtlasId CreateAtlas( const Toolkit::AtlasManager::AtlasSize& size, Pixel::Format pixelformat );
  96
  97   /**
  98    * @copydoc Toolkit::AtlasManager::SetAddPolicy
  99    */
 100   void SetAddPolicy( Toolkit::AtlasManager::AddFailPolicy policy );
 101
 102   /**
 103    * @copydoc Toolkit::AtlasManager::Add
 104    */
 105   void Add( const BufferImage& image,
 106             Toolkit::AtlasManager::AtlasSlot& slot,
 107             Toolkit::AtlasManager::AtlasId atlas );
 108
 109   /**
 110    * @copydoc Toolkit::AtlasManager::GenerateMeshData
 111    */
 112   void GenerateMeshData( ImageId id,
 113                          const Vector2& position,
 114                          Toolkit::AtlasManager::Mesh2D& mesh,
 115                          bool addReference );
 116
 117   /**
 118    * @copydoc Toolkit::AtlasManager::StitchMesh
 119    */
 120   void StitchMesh( Toolkit::AtlasManager::Mesh2D& first,
 121                    const Toolkit::AtlasManager::Mesh2D& second,
 122                    bool optimize );
 123
 124   /**
 125    * @copydoc Toolkit::AtlasManager::StitchMesh
 126    */
 127   void StitchMesh(  const Toolkit::AtlasManager::Mesh2D& first,
 128                     const Toolkit::AtlasManager::Mesh2D& second,
 129                     Toolkit::AtlasManager::Mesh2D& out,
 130                     bool optimize );
 131
 132   /**
 133    * @copydoc Toolkit::AtlasManager::Remove
 134    */
 135   bool Remove( ImageId id );
 136
 137   /**
 138    * @copydoc Toolkit::AtlasManager::GetAtlasContainer
 139    */
 140   Dali::Atlas GetAtlasContainer( AtlasId atlas ) const;
 141
 142   /**
 143    * @copydoc Toolkit::AtlasManager::GetAtlas
 144    */
 145   AtlasId GetAtlas( ImageId id ) const;
 146
 147   /**
 148    * @copydoc Toolkit::AtlasManager::SetNewAtlasSize
 149    */
 150   void SetNewAtlasSize( const Toolkit::AtlasManager::AtlasSize& size );
 151
 152   /**
 153    * @copydoc Toolkit::AtlasManager::GetAtlasSize
 154    */
 155   const Toolkit::AtlasManager::AtlasSize& GetAtlasSize( AtlasId atlas );
 156
 157   /**
 158    * @copydoc Toolkit::AtlasManager::GetBlockSize
 159    */
 160   Vector2 GetBlockSize( AtlasId atlas );
 161
 162   /**
 163    * @copydoc Toolkit::AtlasManager::GetFreeBlocks
 164    */
 165   SizeType GetFreeBlocks( AtlasId atlas ) const;
 166
 167   /*
 168    * @copydoc Toolkit::AtlasManager::GetAtlasCount
 169    */
 170   SizeType GetAtlasCount() const;
 171
 172   /**
 173    * @copydoc Toolkit::AtlasManager::GetPixelFormat
 174    */
 175   Pixel::Format GetPixelFormat( AtlasId atlas );
 176
 177   /**
 178    * @copydoc Toolkit::AtlasManager::GetMetrics
 179    */
 180   void GetMetrics( Toolkit::AtlasManager::Metrics& metrics );
 181
 182   /**
 183    * @copydoc Toolkit::AtlasManager::GetMaterial
 184    */
 185   Material GetMaterial( AtlasId atlas ) const;
 186
 187 /**
 188    * @copydoc Toolkit::AtlasManager::GetSampler
 189    */
 190   Sampler GetSampler( AtlasId atlas ) const;
 191
 192 private:
 193
 194   std::vector< AtlasDescriptor > mAtlasList;            // List of atlases created
 195   std::vector< AtlasSlotDescriptor > mImageList;        // List of bitmaps store in atlases
 196   Toolkit::AtlasManager::AtlasSize mNewAtlasSize;       // Atlas size to use in next creation
 197   Toolkit::AtlasManager::AddFailPolicy mAddFailPolicy;  // Policy for faling to add an Image
 198
 199   SizeType CheckAtlas( SizeType atlas,
 200                        SizeType width,
 201                        SizeType height,
 202                        Pixel::Format pixelFormat,
 203                        SizeType& blockArea );
 204
 205   void CreateMesh( SizeType atlas,
 206                    SizeType imageWidth,
 207                    SizeType imageHeight,
 208                    const Vector2& position,
 209                    SizeType widthInBlocks,
 210                    SizeType heightInBlocks,
 211                    Toolkit::AtlasManager::Mesh2D& mesh,
 212                    AtlasSlotDescriptor& desc );
 213
 214   void OptimizeMesh( const Toolkit::AtlasManager::Mesh2D& in,
 215                      Toolkit::AtlasManager::Mesh2D& out );
 216
 217   void UploadImage( const BufferImage& image,
 218                     const AtlasSlotDescriptor& desc );
 219
 220   void PrintMeshData( const Toolkit::AtlasManager::Mesh2D& mesh );
 221
 222   Shader mShaderL8;
 223   Shader mShaderRgba;
 224
 225 };
 226
 227 } // namespace Internal
 228
 229 inline const Internal::AtlasManager& GetImplementation(const Toolkit::AtlasManager& manager)
 230 {
 231   DALI_ASSERT_ALWAYS( manager && "AtlasManager handle is empty" );
 232
 233   const BaseObject& handle = manager.GetBaseObject();
 234
 235   return static_cast<const Internal::AtlasManager&>(handle);
 236 }
 237
 238 inline Internal::AtlasManager& GetImplementation(Toolkit::AtlasManager& manager)
 239 {
 240   DALI_ASSERT_ALWAYS( manager && "AtlasManager handle is empty" );
 241
 242   BaseObject& handle = manager.GetBaseObject();
 243
 244   return static_cast<Internal::AtlasManager&>(handle);
 245 }
 246
 247 } // namespace Toolkit
 248
 249 } // namespace Dali
 250
 251
 252  #endif // __DALI_TOOLKIT_ATLAS_MANAGER_IMPL_H__