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

   1 #ifndef DALI_INTERNAL_TEXTABSTRACTION_PLUGIN_EMBEDDED_ITEM_H
   2 #define DALI_INTERNAL_TEXTABSTRACTION_PLUGIN_EMBEDDED_ITEM_H
   3
   4 /*
   5  * Copyright (c) 2021 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   /**
  33    * Get metrics for glyph from image
  34    * @param[in] item The embedded image
  35    * @param[in,out] glyph The glyph to get metrics for
  36    */
  37   void GetGlyphMetrics(GlyphInfo& glyph);
  38
  39   /**
  40    * @brief Create a glyph bitmap from an embedded item if present in the cache
  41    *
  42    * @param[in]  pixelBufferCache The pixel buffer cache
  43    * @param[out] data The bitmap data.
  44    */
  45   void CreateBitmap(const std::vector<PixelBufferCacheItem>&            pixelBufferCache,
  46                     Dali::TextAbstraction::FontClient::GlyphBufferData& data);
  47
  48   PixelBufferId pixelBufferId; ///< Index to the vector of pixel buffers
  49   unsigned int  width;         ///< The desired width.
  50   unsigned int  height;        ///< The desired height.
  51 };
  52
  53 } // namespace Dali::TextAbstraction::Internal
  54
  55 #endif //DALI_INTERNAL_TEXTABSTRACTION_PLUGIN_EMBEDDED_ITEM_H