dali-toolkit/internal/text/rendering/text-typesetter.h

   1 #ifndef DALI_TOOLKIT_TEXT_TYPESETTER_H
   2 #define DALI_TOOLKIT_TEXT_TYPESETTER_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
  21 // EXTERNAL INCLUDES
  22 #include <dali-toolkit/devel-api/text/text-enumerations-devel.h>
  23 #include <dali/devel-api/adaptor-framework/pixel-buffer.h>
  24 #include <dali/devel-api/text-abstraction/text-abstraction-definitions.h>
  25 #include <dali/public-api/common/intrusive-ptr.h>
  26 #include <dali/public-api/images/pixel-data.h>
  27 #include <dali/public-api/images/pixel.h>
  28 #include <dali/public-api/object/ref-object.h>
  29
  30 namespace Dali
  31 {
  32 namespace Toolkit
  33 {
  34 namespace Text
  35 {
  36 class ModelInterface;
  37 class ViewModel;
  38 class Typesetter;
  39
  40 typedef IntrusivePtr<Typesetter> TypesetterPtr;
  41
  42 /**
  43  * @brief This class is responsible of controlling the data flow of the text's rendering process.
  44  */
  45 class Typesetter : public RefObject
  46 {
  47 public:
  48   /**
  49    * @brief Behaviours of how to render the text.
  50    */
  51   enum RenderBehaviour
  52   {
  53     RENDER_TEXT_AND_STYLES, ///< Render both the text and its styles
  54     RENDER_NO_TEXT,         ///< Do not render the text itself
  55     RENDER_NO_STYLES,       ///< Do not render any styles
  56     RENDER_MASK             ///< Render an alpha mask (for color glyphs with no color animation, e.g. emoji)
  57   };
  58
  59   /**
  60    * @brief Styles of the text.
  61    */
  62   enum Style
  63   {
  64     STYLE_NONE,        ///< No style
  65     STYLE_MASK,        ///< Alpha mask
  66     STYLE_SHADOW,      ///< Hard shadow
  67     STYLE_SOFT_SHADOW, ///< Soft shadow
  68     STYLE_UNDERLINE,   ///< Underline
  69     STYLE_OUTLINE,     ///< Outline
  70     STYLE_BACKGROUND   ///< Text background
  71   };
  72
  73 public: // Constructor.
  74   /**
  75    * @brief Creates a Typesetter instance.
  76    *
  77    * The typesetter composes the final text retrieving the glyphs and the
  78    * styles from the text's model.
  79    *
  80    * @param[in] model Pointer to the text's data model.
  81    */
  82   static TypesetterPtr New(const ModelInterface* const model);
  83
  84 public:
  85   /**
  86    * @brief Retrieves the pointer to the view model.
  87    *
  88    * @return A pointer to the view model.
  89    */
  90   ViewModel* GetViewModel();
  91
  92   /**
  93    * @brief Renders the text.
  94    *
  95    * Does the following operations:
  96    * - Finds the visible pages needed to be rendered.
  97    * - Elide glyphs if needed.
  98    * - Creates image buffers for diffrent text styles with the given size.
  99    * - Combines different image buffers to create the pixel data used to generate the final image
 100    *
 101    * @param[in] size The renderer size.
 102    * @param[in] textDirection The direction of the text.
 103    * @param[in] behaviour The behaviour of how to render the text (i.e. whether to render the text only or the styles only or both).
 104    * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment (i.e. always render as if HORIZONTAL_ALIGN_BEGIN).
 105    * @param[in] pixelFormat The format of the pixel in the image that the text is rendered as (i.e. either Pixel::BGRA8888 or Pixel::L8).
 106    *
 107    * @return A pixel data with the text rendered.
 108    */
 109   PixelData Render(const Vector2& size, Toolkit::DevelText::TextDirection::Type textDirection, RenderBehaviour behaviour = RENDER_TEXT_AND_STYLES, bool ignoreHorizontalAlignment = false, Pixel::Format pixelFormat = Pixel::RGBA8888);
 110
 111 private:
 112   /**
 113    * @brief Private constructor.
 114    *
 115    * @param[in] model Pointer to the text's data model.
 116    */
 117   Typesetter(const ModelInterface* const model);
 118
 119   // Declared private and left undefined to avoid copies.
 120   Typesetter(const Typesetter& handle);
 121
 122   // Declared private and left undefined to avoid copies.
 123   Typesetter& operator=(const Typesetter& handle);
 124
 125   /**
 126    * @brief Create the image buffer for the given range of the glyphs in the given style.
 127    *
 128    * Does the following operations:
 129    * - Retrieves the data buffers from the text model.
 130    * - Creates the pixel data used to generate the final image with the given size.
 131    * - Traverse the visible glyphs, retrieve their bitmaps and compose the final pixel data.
 132    *
 133    * @param[in] bufferWidth The width of the image buffer.
 134    * @param[in] bufferHeight The height of the image buffer.
 135    * @param[in] style The style of the text.
 136    * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default.
 137    * @param[in] pixelFormat The format of the pixel in the image that the text is rendered as (i.e. either Pixel::BGRA8888 or Pixel::L8).
 138    * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position.
 139    * @param[in] verticalOffset The vertical offset to be added to the glyph's position.
 140    * @param[in] fromGlyphIndex The index of the first glyph within the text to be drawn
 141    * @param[in] toGlyphIndex The index of the last glyph within the text to be drawn
 142    *
 143    * @return An image buffer with the text.
 144    */
 145   Devel::PixelBuffer CreateImageBuffer(const unsigned int bufferWidth, const unsigned int bufferHeight, Typesetter::Style style, bool ignoreHorizontalAlignment, Pixel::Format pixelFormat, int horizontalOffset, int verticalOffset, TextAbstraction::GlyphIndex fromGlyphIndex, TextAbstraction::GlyphIndex toGlyphIndex);
 146
 147   /**
 148    * @brief Combine the two RGBA image buffers together.
 149    *
 150    * The top layer buffer will blend over the bottom layer buffer:
 151    * - If the pixel is not fully opaque from either buffer, it will be blended with
 152    *   the pixel from the other buffer and copied to the combined buffer.
 153    * - If the pixels from both buffers are fully opaque, the pixels from the top layer
 154    *   buffer will be copied to the combined buffer.
 155    *
 156    * @param[in] topPixelBuffer The top layer buffer.
 157    * @param[in] bottomPixelBuffer The bottom layer buffer.
 158    * @param[in] bufferWidth The width of the image buffer.
 159    * @param[in] bufferHeight The height of the image buffer.
 160    *
 161    * @return The combined image buffer with the text.
 162    *
 163    */
 164   Devel::PixelBuffer CombineImageBuffer(Devel::PixelBuffer topPixelBuffer, Devel::PixelBuffer bottomPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeightbool);
 165
 166 protected:
 167   /**
 168    * @brief A reference counted object may only be deleted by calling Unreference().
 169    *
 170    * Destroys the visual model.
 171    */
 172   virtual ~Typesetter();
 173
 174 private:
 175   ViewModel* mModel;
 176 };
 177
 178 } // namespace Text
 179
 180 } // namespace Toolkit
 181
 182 } // namespace Dali
 183
 184 #endif // DALI_TOOLKIT_TEXT_TYPESETTER_H