skottie::Shaper Class Reference

#include <TextShaper.h>

Classes
struct	Fragment
struct	Result
struct	RunRec
struct	ShapedGlyphs
struct	TextDesc

Public Types
enum class	VAlign : uint8_t {   kTop , kTopBaseline , kHybridTop , kHybridCenter ,   kHybridBottom , kVisualTop , kVisualCenter , kVisualBottom }
enum class	ResizePolicy : uint8_t { kNone , kScaleToFit , kDownscaleToFit }
enum class	LinebreakPolicy : uint8_t { kParagraph , kExplicit }
enum class	Direction : uint8_t { kLTR , kRTL }
enum class	Capitalization { kNone , kUpperCase }
enum	Flags : uint32_t { kNone = 0x00 , kFragmentGlyphs = 0x01 , kTrackFragmentAdvanceAscent = 0x02 , kClusters = 0x04 }

Static Public Member Functions
static Result	Shape (const SkString &text, const TextDesc &desc, const SkPoint &point, const sk_sp< SkFontMgr > &, const sk_sp< SkShapers::Factory > &)
static Result	Shape (const SkString &text, const TextDesc &desc, const SkRect &box, const sk_sp< SkFontMgr > &, const sk_sp< SkShapers::Factory > &)
static Result	Shape (const SkString &text, const TextDesc &desc, const SkPoint &point, const sk_sp< SkFontMgr > &)
static Result	Shape (const SkString &text, const TextDesc &desc, const SkRect &box, const sk_sp< SkFontMgr > &)

Detailed Description

Definition at line 37 of file TextShaper.h.

Member Enumeration Documentation

Capitalization

enum class skottie::Shaper::Capitalization

strong

Enumerator
kNone
kUpperCase

Definition at line 137 of file TextShaper.h.

                              {
        kNone,
        kUpperCase,
    };

Direction

enum class skottie::Shaper::Direction : uint8_t

strong

Enumerator
kLTR
kRTL

Definition at line 135 of file TextShaper.h.

: uint8_t { kLTR, kRTL };

Flags

enum skottie::Shaper::Flags : uint32_t

Enumerator
kNone
kFragmentGlyphs
kTrackFragmentAdvanceAscent
kClusters

Definition at line 142 of file TextShaper.h.

               : uint32_t {
        kNone                       = 0x00,
 
        // Split out individual glyphs into separate Fragments
        // (useful when the caller intends to manipulate glyphs independently).
        kFragmentGlyphs             = 0x01,
 
        // Compute the advance and ascent for each fragment.
        kTrackFragmentAdvanceAscent = 0x02,
 
        // Return cluster information.
        kClusters                   = 0x04,
    };

LinebreakPolicy

enum class skottie::Shaper::LinebreakPolicy : uint8_t

strong

Enumerator
kParagraph
kExplicit

Definition at line 127 of file TextShaper.h.

                               : uint8_t {
        // Break lines such that they fit in a non-empty paragraph box, horizontally.
        kParagraph,
        // Only break lines when requested explicitly (\r), regardless of paragraph box dimensions.
        kExplicit,
    };

ResizePolicy

enum class skottie::Shaper::ResizePolicy : uint8_t

strong

Enumerator
kNone
kScaleToFit
kDownscaleToFit

Definition at line 116 of file TextShaper.h.

                            : uint8_t {
        // Use the specified text size.
        kNone,
        // Resize the text such that the extent box fits (snuggly) in the text box,
        // both horizontally and vertically.
        kScaleToFit,
        // Same kScaleToFit if the text doesn't fit at the specified font size.
        // Otherwise, same as kNone.
        kDownscaleToFit,
    };

VAlign

enum class skottie::Shaper::VAlign : uint8_t

strong

Enumerator
kTop
kTopBaseline
kHybridTop
kHybridCenter
kHybridBottom
kVisualTop
kVisualCenter
kVisualBottom

Definition at line 89 of file TextShaper.h.

                      : uint8_t {
        // Align the first line typographical top with the text box top (AE box text).
        kTop,
        // Align the first line typographical baseline with the text box top (AE point text).
        kTopBaseline,
 
        // Skottie vertical alignment extensions
 
        // These are based on a hybrid extent box defined (in Y) as
        //
        //   ------------------------------------------------------
        //   MIN(visual_top_extent   , typographical_top_extent   )
        //
        //                         ...
        //
        //   MAX(visual_bottom_extent, typographical_bottom_extent)
        //   ------------------------------------------------------
        kHybridTop,     // extent box top    -> text box top
        kHybridCenter,  // extent box center -> text box center
        kHybridBottom,  // extent box bottom -> text box bottom
 
        // Visual alignement modes -- these are using tight visual bounds for the paragraph.
        kVisualTop,     // visual top    -> text box top
        kVisualCenter,  // visual center -> text box center
        kVisualBottom,  // visual bottom -> text box bottom
    };

Member Function Documentation

Shape() [1/4]

Shaper::Result skottie::Shaper::Shape ( const SkString &  text, const TextDesc &  desc, const SkPoint &  point, const sk_sp< SkFontMgr > &  fontmgr  )

static

Definition at line 748 of file TextShaper.cpp.

                                              {
    return Shaper::Shape(text, desc, point, fontmgr, SkShapers::BestAvailable());
}

Shape() [2/4]

Shaper::Result skottie::Shaper::Shape ( const SkString &  text, const TextDesc &  desc, const SkPoint &  point, const sk_sp< SkFontMgr > &  fontmgr, const sk_sp< SkShapers::Factory > &  shapingFactory  )

static

Definition at line 643 of file TextShaper.cpp.

                                                                                                             {
    const AdjustedText adjText(text, desc, shapingFactory->getUnicode());
 
    return (desc.fResize == ResizePolicy::kScaleToFit ||
            desc.fResize == ResizePolicy::kDownscaleToFit) // makes no sense in point mode
            ? Result()
            : ShapeImpl(adjText, desc, SkRect::MakeEmpty().makeOffset(point.x(), point.y()),
                        fontmgr, shapingFactory, nullptr);
}

Shape() [3/4]

Shaper::Result skottie::Shaper::Shape ( const SkString &  text, const TextDesc &  desc, const SkRect &  box, const sk_sp< SkFontMgr > &  fontmgr  )

static

Definition at line 753 of file TextShaper.cpp.

                                              {
    return Shaper::Shape(text, desc, box, fontmgr, SkShapers::BestAvailable());
}

Shape() [4/4]

Shaper::Result skottie::Shaper::Shape ( const SkString &  text, const TextDesc &  desc, const SkRect &  box, const sk_sp< SkFontMgr > &  fontmgr, const sk_sp< SkShapers::Factory > &  shapingFactory  )

static

Definition at line 654 of file TextShaper.cpp.

                                                                                                             {
    const AdjustedText adjText(text, desc, shapingFactory->getUnicode());
 
    switch(desc.fResize) {
    case ResizePolicy::kNone:
        return ShapeImpl(adjText, desc, box, fontmgr, shapingFactory, nullptr);
    case ResizePolicy::kScaleToFit:
        return ShapeToFit(adjText, desc, box, fontmgr, shapingFactory);
    case ResizePolicy::kDownscaleToFit: {
        SkSize size;
        auto result = ShapeImpl(adjText, desc, box, fontmgr, shapingFactory, &size);
 
        return result_fits(result, size, box, desc)
                ? result
                : ShapeToFit(adjText, desc, box, fontmgr, shapingFactory);
    }
    }
 
    SkUNREACHABLE;
}

---

The documentation for this class was generated from the following files:

• third_party/skia/modules/skottie/include/TextShaper.h
• third_party/skia/modules/skottie/src/text/TextShaper.cpp