[dali_1.0.44] Merge branch 'devel/master'

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / internal / text / rendering / atlas / atlas-glyph-manager.h

diff --git a/dali-toolkit/internal/text/rendering/atlas/atlas-glyph-manager.h b/dali-toolkit/internal/text/rendering/atlas/atlas-glyph-manager.h
index a90efdb..fdc4141 100644 (file)
--- a/dali-toolkit/internal/text/rendering/atlas/atlas-glyph-manager.h
+++ b/dali-toolkit/internal/text/rendering/atlas/atlas-glyph-manager.h
@@ -34,11 +34,20 @@ class AtlasGlyphManager;
 }
 
 
-class DALI_IMPORT_API AtlasGlyphManager : public BaseHandle
+class AtlasGlyphManager : public BaseHandle
 {
 public:
 
   /**
+   * Description of GlyphManager state
+   */
+  struct Metrics
+  {
+    uint32_t mGlyphCount;                   // number of glyphs being managed
+    AtlasManager::Metrics mAtlasMetrics;    // metrics from the Atlas Manager
+  };
+
+  /**
    * @brief Create a AtlasGlyphManager handle.
    *
    * Calling member functions with an uninitialised handle is not allowed.
@@ -62,11 +71,13 @@ public:
   /**
    * @brief Ask Atlas Manager to add a glyph
    *
+   * @param[in] fontId fontId glyph comes from
    * @param[in] glyph glyph to add to an atlas
    * @param[in] bitmap bitmap to use for glyph addition
    * @param[out] slot information returned by atlas manager for addition
    */
-  void Add( const Text::GlyphInfo& glyph,
+  void Add( Text::FontId fontId,
+            const Text::GlyphInfo& glyph,
             const BufferImage& bitmap,
             AtlasManager::AtlasSlot& slot );
 
@@ -96,35 +107,57 @@ public:
    * @param[in] fontId The font that this glyph comes from
    * @param[in] index The GlyphIndex of this glyph
    * @param[out] slot container holding information about the glyph( mImage = 0 indicates not being cached )
+   *
+   * @return Whether glyph is cached or not ?
    */
-  void Cached( Text::FontId fontId,
+  bool Cached( Text::FontId fontId,
                Text::GlyphIndex index,
                AtlasManager::AtlasSlot& slot );
 
   /**
-   * @brief Set the Atlas size and block size for subsequent atlas generation
+   * @brief Retrieve the size of an atlas
    *
-   * @param[in] size size of the atlas in pixels
-   * @param[in] blockSize size of a block in this atlas in pixels
-   */
-  void SetAtlasSize( const Vector2& size,
-                     const Vector2& blockSize );
-
-  /**
-   * @brief Unreference an image from the atlas and remove from cache if no longer needed
+   * @param[in] atlasId Id of the atlas to interrogate
    *
-   * @param[in] imageId ID of the image
+   * @return The pixel size of the atlas
    */
-  void Remove( uint32_t imageId );
+  Vector2 GetAtlasSize( uint32_t atlasId );
+
+   /**
+    * @brief Set the atlas size and block size for subsequent Atlas generation
+    *
+    * @param[in] width width of atlas in pixels
+    * @param[in] height height of atlas in pixels
+    * @param[in] blockWidth width of a block in pixels
+    * @param[in] blockHeight height of a block in pixels
+    */
+  void SetNewAtlasSize( uint32_t width, uint32_t height, uint32_t blockWidth, uint32_t blockHeight );
 
   /**
    * @brief Get the Pixel Format used by an atlas
    *
-   * @param atlasId Id of atlas to check
+   * @param[in] atlasId Id of atlas to check
+   *
    * @return The pixel format of the atlas
    */
   Pixel::Format GetPixelFormat( uint32_t atlasId );
 
+  /**
+   * @brief Get Glyph Manager metrics
+   *
+   * @return const reference to glyph manager metrics
+   */
+  const Metrics& GetMetrics();
+
+  /**
+   * @brief Adjust the reference count for an imageId and remove cache entry if it becomes free
+   *
+   * @param[in] fontId the font this image came from
+   * @param[in] imageId The imageId
+   * @param[in] delta adjustment to make to reference count
+   */
+  void AdjustReferenceCount( Text::FontId fontId, uint32_t imageId, int32_t delta );
+
 private:
 
   explicit DALI_INTERNAL AtlasGlyphManager(Internal::AtlasGlyphManager *impl);