dali/internal/text/text-abstraction/plugin/embedded-item.h

   1 #ifndef DALI_INTERNAL_TEXT_ABSTRACTION_PLUGIN_EMBEDDED_ITEM_H
   2 #define DALI_INTERNAL_TEXT_ABSTRACTION_PLUGIN_EMBEDDED_ITEM_H
   3
   4 /*
   5  * Copyright (c) 2022 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 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  21 #include <dali/devel-api/text-abstraction/font-client.h>
  22 #include <dali/devel-api/text-abstraction/glyph-info.h>
  23 #include <dali/internal/text/text-abstraction/plugin/pixel-buffer-cache-item.h>
  24
  25 namespace Dali::TextAbstraction::Internal
  26 {
  27 /**
  28  * @brief Caches embedded items.
  29  */
  30 struct EmbeddedItem
  31 {
  32   // Default constructor.
  33   EmbeddedItem() = default;
  34
  35   // Default destructor.
  36   ~EmbeddedItem() = default;
  37
  38   /**
  39    * Get metrics for glyph from image
  40    * @param[in] item The embedded image
  41    * @param[in,out] glyph The glyph to get metrics for
  42    */
  43   void GetGlyphMetrics(GlyphInfo& glyph);
  44
  45   /**
  46    * @brief Create a glyph bitmap from an embedded item if present in the cache
  47    *
  48    * @param[in]  pixelBufferCache The pixel buffer cache
  49    * @param[out] data The bitmap data.
  50    */
  51   void CreateBitmap(const std::vector<PixelBufferCacheItem>& pixelBufferCache,
  52                     Dali::TextAbstraction::GlyphBufferData&  data);
  53
  54   PixelBufferId pixelBufferId{0u}; ///< Index to the vector of pixel buffers
  55   uint32_t      width{0u};         ///< The desired width.
  56   uint32_t      height{0u};        ///< The desired height.
  57   GlyphIndex    index{0u};         ///< The glyph index of this embedded items. Should be bigger than 0.
  58 };
  59
  60 } // namespace Dali::TextAbstraction::Internal
  61
  62 #endif //DALI_INTERNAL_TEXT_ABSTRACTION_PLUGIN_EMBEDDED_ITEM_H