X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Finternal%2Ftext%2Frendering%2Ftext-typesetter.h;h=3a71c31435c6520bb8b27e9a45d785c1b91b392a;hp=453541b78dd7d09b77ce3ed446c2eddc00268edf;hb=d783bae0658096314bd94361be75d5999797735e;hpb=01db027faaf245de80dfee0928fbd6f72360f7bd diff --git a/dali-toolkit/internal/text/rendering/text-typesetter.h b/dali-toolkit/internal/text/rendering/text-typesetter.h index 453541b..3a71c31 100644 --- a/dali-toolkit/internal/text/rendering/text-typesetter.h +++ b/dali-toolkit/internal/text/rendering/text-typesetter.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_TEXT_TYPESETTER_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,23 +19,20 @@ */ // EXTERNAL INCLUDES +#include +#include +#include #include -#include -#include #include -#include -#include -#include +#include +#include namespace Dali { - namespace Toolkit { - namespace Text { - class ModelInterface; class ViewModel; class Typesetter; @@ -48,16 +45,16 @@ typedef IntrusivePtr TypesetterPtr; class Typesetter : public RefObject { public: - /** * @brief Behaviours of how to render the text. */ enum RenderBehaviour { - RENDER_TEXT_AND_STYLES, ///< Render both the text and its styles - RENDER_NO_TEXT, ///< Do not render the text itself - RENDER_NO_STYLES, ///< Do not render any styles - RENDER_MASK ///< Render an alpha mask (for color glyphs with no color animation, e.g. emoji) + RENDER_TEXT_AND_STYLES, ///< Render both the text and its styles + RENDER_NO_TEXT, ///< Do not render the text itself but render the background styles such as outline and background. + RENDER_NO_STYLES, ///< Do not render any styles + RENDER_MASK, ///< Render an alpha mask (for color glyphs with no color animation, e.g. emoji) + RENDER_OVERLAY_STYLE ///< Do not render the text itself but render the style but overlay the style on the text (foreground styles such as strikethrough and underline) }; /** @@ -65,13 +62,14 @@ public: */ enum Style { - STYLE_NONE, ///< No style - STYLE_MASK, ///< Alpha mask - STYLE_SHADOW, ///< Hard shadow - STYLE_SOFT_SHADOW, ///< Soft shadow - STYLE_UNDERLINE, ///< Underline - STYLE_OUTLINE, ///< Outline - STYLE_BACKGROUND ///< Text background + STYLE_NONE, ///< No style + STYLE_MASK, ///< Alpha mask + STYLE_SHADOW, ///< Hard shadow + STYLE_SOFT_SHADOW, ///< Soft shadow + STYLE_UNDERLINE, ///< Underline + STYLE_OUTLINE, ///< Outline + STYLE_BACKGROUND, ///< Text background + STYLE_STRIKETHROUGH ///< Strikethrough }; public: // Constructor. @@ -83,7 +81,7 @@ public: // Constructor. * * @param[in] model Pointer to the text's data model. */ - static TypesetterPtr New( const ModelInterface* const model ); + static TypesetterPtr New(const ModelInterface* const model); public: /** @@ -110,7 +108,7 @@ public: * * @return A pixel data with the text rendered. */ - PixelData Render( const Vector2& size, Toolkit::DevelText::TextDirection::Type textDirection, RenderBehaviour behaviour = RENDER_TEXT_AND_STYLES, bool ignoreHorizontalAlignment = false, Pixel::Format pixelFormat = Pixel::RGBA8888 ); + PixelData Render(const Vector2& size, Toolkit::DevelText::TextDirection::Type textDirection, RenderBehaviour behaviour = RENDER_TEXT_AND_STYLES, bool ignoreHorizontalAlignment = false, Pixel::Format pixelFormat = Pixel::RGBA8888); private: /** @@ -118,16 +116,16 @@ private: * * @param[in] model Pointer to the text's data model. */ - Typesetter( const ModelInterface* const model ); + Typesetter(const ModelInterface* const model); // Declared private and left undefined to avoid copies. - Typesetter( const Typesetter& handle ); + Typesetter(const Typesetter& handle); // Declared private and left undefined to avoid copies. - Typesetter& operator=( const Typesetter& handle ); + Typesetter& operator=(const Typesetter& handle); /** - * @brief Create the image buffer for the given range of the glyphs in the given style. + * @brief Create & draw the image buffer for the given range of the glyphs in the given style. * * Does the following operations: * - Retrieves the data buffers from the text model. @@ -146,29 +144,66 @@ private: * * @return An image buffer with the text. */ - 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 ); + Devel::PixelBuffer CreateImageBuffer(const uint32_t bufferWidth, const uint32_t bufferHeight, const Typesetter::Style style, const bool ignoreHorizontalAlignment, const Pixel::Format pixelFormat, const int32_t horizontalOffset, const int32_t verticalOffset, const TextAbstraction::GlyphIndex fromGlyphIndex, const TextAbstraction::GlyphIndex toGlyphIndex); + + /** + * @brief Apply behaviour of tags if the markup-processor is enabled. + * + * @param[in] topPixelBuffer The top layer buffer. + * @param[in] bufferWidth The width of the image buffer. + * @param[in] bufferHeight The height of the image buffer. + * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default. + * @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). + * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position. + * @param[in] verticalOffset The vertical offset to be added to the glyph's position. + * + * @return The image buffer with the markup. + */ + Devel::PixelBuffer ApplyMarkupProcessorOnPixelBuffer(Devel::PixelBuffer topPixelBuffer, const uint32_t bufferWidth, const uint32_t bufferHeight, const bool ignoreHorizontalAlignment, const Pixel::Format pixelFormat, const int32_t horizontalOffset, const int32_t verticalOffset); /** - * @brief Combine the two RGBA image buffers together. + * @brief Apply markup underline tags. * - * The top layer buffer will blend over the bottom layer buffer: - * - If the pixel is not fully opaque from either buffer, it will be blended with - * the pixel from the other buffer and copied to the combined buffer. - * - If the pixels from both buffers are fully opaque, the pixels from the top layer - * buffer will be copied to the combined buffer. + * The properties on TextLabel override the behavior of Markup. + * Because the markup will be the bottom layer buffer + * - i.e: If you set property UNDERLINE to enabled and blue. + * And the TEXT is "Hello World Hello World". + * Then the output of the whole text is underlined by blue line. * * @param[in] topPixelBuffer The top layer buffer. - * @param[in] bottomPixelBuffer The bottom layer buffer. * @param[in] bufferWidth The width of the image buffer. * @param[in] bufferHeight The height of the image buffer. + * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default. + * @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). + * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position. + * @param[in] verticalOffset The vertical offset to be added to the glyph's position. + * + * @return The image buffer with the markup. + */ + Devel::PixelBuffer ApplyUnderlineMarkupImageBuffer(Devel::PixelBuffer topPixelBuffer, const uint32_t bufferWidth, const uint32_t bufferHeight, const bool ignoreHorizontalAlignment, const Pixel::Format pixelFormat, const int32_t horizontalOffset, const int32_t verticalOffset); + + /** + * @brief Apply markup strikethrough tags. * - * @return The combined image buffer with the text. + * The properties on TextLabel override the behavior of Markup. + * Because the markup will be the bottom layer buffer + * - i.e: If you set property STRIKETHROUGH to enabled and blue. + * And the TEXT is "Hello World Hello World". + * Then the whole text will have a blue line strikethrough. * + * @param[in] topPixelBuffer The top layer buffer. + * @param[in] bufferWidth The width of the image buffer. + * @param[in] bufferHeight The height of the image buffer. + * @param[in] ignoreHorizontalAlignment Whether to ignore the horizontal alignment, not ignored by default. + * @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). + * @param[in] horizontalOffset The horizontal offset to be added to the glyph's position. + * @param[in] verticalOffset The vertical offset to be added to the glyph's position. + * + * @return The image buffer with the markup. */ - Devel::PixelBuffer CombineImageBuffer( Devel::PixelBuffer topPixelBuffer, Devel::PixelBuffer bottomPixelBuffer, const unsigned int bufferWidth, const unsigned int bufferHeightbool ); + Devel::PixelBuffer ApplyStrikethroughMarkupImageBuffer(Devel::PixelBuffer topPixelBuffer, const uint32_t bufferWidth, const uint32_t bufferHeight, const bool ignoreHorizontalAlignment, const Pixel::Format pixelFormat, const int32_t horizontalOffset, const int32_t verticalOffset); protected: - /** * @brief A reference counted object may only be deleted by calling Unreference(). * @@ -177,8 +212,7 @@ protected: virtual ~Typesetter(); private: - - ViewModel* mModel; + ViewModel* mModel; }; } // namespace Text @@ -187,4 +221,4 @@ private: } // namespace Dali -#endif // DALI_TOOLKIT_TEXT_TYPESETTER_H +#endif // DALI_TOOLKIT_TEXT_TYPESETTER_H \ No newline at end of file