| Flutter Impeller |

Public Member Functions | Static Public Member Functions | List of all members
impeller::TypographerContextSkia Class Reference

`#include <typographer_context_skia.h>`

Inheritance diagram for impeller::TypographerContextSkia:

## Public Member Functions
| TypographerContextSkia ()
| ~TypographerContextSkia () override
std::shared_ptr< GlyphAtlasContext > | CreateGlyphAtlasContext (GlyphAtlas::Type type) const override
std::shared_ptr< GlyphAtlas > | CreateGlyphAtlas (Context &context, GlyphAtlas::Type type, HostBuffer &host_buffer, const std::shared_ptr< GlyphAtlasContext > &atlas_context, const std::vector< std::shared_ptr< TextFrame >> &text_frames) const override
Public Member Functions inherited from impeller::TypographerContext
virtual | ~TypographerContext ()
virtual bool | IsValid () const

## Static Public Member Functions
static std::shared_ptr< TypographerContext > | Make ()

## Additional Inherited Members
Protected Member Functions inherited from impeller::TypographerContext
| TypographerContext ()
| Create a new context to render text that talks to an underlying graphics context. More...

## Detailed Description

Definition at line 12 of file typographer_context_skia.h.

## Constructor & Destructor Documentation

## ◆ TypographerContextSkia()

impeller::TypographerContextSkia::TypographerContextSkia | ( |  | ) |
| default

## ◆ ~TypographerContextSkia()

impeller::TypographerContextSkia::~TypographerContextSkia | ( |  | ) |
| override default

## Member Function Documentation

## ◆ CreateGlyphAtlas()

std::shared_ptr< GlyphAtlas > impeller::TypographerContextSkia::CreateGlyphAtlas | ( | Context & | context,
|  | GlyphAtlas::Type | type,
|  | HostBuffer & | host_buffer,
|  | const std::shared_ptr< GlyphAtlasContext > & | atlas_context,
|  | const std::vector< std::shared_ptr< TextFrame >> & | text_frames
| ) |  | const
| override virtual

Implements impeller::TypographerContext.

Definition at line 489 of file typographer_context_skia.cc.

494 {
495 TRACE_EVENT0("impeller", __FUNCTION__);
496 if (!IsValid()) {
497 return nullptr;
498 }
499 std::shared_ptr<GlyphAtlas> last_atlas = atlas_context->GetGlyphAtlas();
500 FML_DCHECK(last_atlas->GetType() == type);
501
502 if (text_frames.empty()) {
503 return last_atlas;
504 }
505
506 // ---------------------------------------------------------------------------
507 // Step 1: Determine if the atlas type and font glyph pairs are compatible
508 // with the current atlas and reuse if possible. For each new font and
509 // glyph pair, compute the glyph size at scale.
510 // ---------------------------------------------------------------------------
511 auto [new_glyphs, glyph_sizes] = CollectNewGlyphs(last_atlas, text_frames);
512 if (new_glyphs.size() == 0) {
513 return last_atlas;
514 }
515
516 // ---------------------------------------------------------------------------
517 // Step 2: Determine if the additional missing glyphs can be appended to the
518 // existing bitmap without recreating the atlas.
519 // ---------------------------------------------------------------------------
520 std::vector<Rect> glyph_positions;
521 glyph_positions.reserve(new_glyphs.size());
522 size_t first_missing_index = 0;
523
524 if (last_atlas->GetTexture()) {
525 // Append all glyphs that fit into the current atlas.
526 first_missing_index = AppendToExistingAtlas(
527 last_atlas, new_glyphs, glyph_positions, glyph_sizes,
528 atlas_context->GetAtlasSize(), atlas_context->GetHeightAdjustment(),
529 atlas_context->GetRectPacker());
530
531 // ---------------------------------------------------------------------------
532 // Step 3a: Record the positions in the glyph atlas of the newly added
533 // glyphs.
534 // ---------------------------------------------------------------------------
535 for (size_t i = 0; i < first_missing_index; i++) {
536 last_atlas->AddTypefaceGlyphPositionAndBounds(
537 new_glyphs[i], glyph_positions[i], glyph_sizes[i]);
538 }
539
540 std::shared_ptr<CommandBuffer> cmd_buffer = context.CreateCommandBuffer();
541 std::shared_ptr<BlitPass> blit_pass = cmd_buffer->CreateBlitPass();
542
543 fml::ScopedCleanupClosure closure([&]() {
544 blit_pass->EncodeCommands();
545 if (!context.EnqueueCommandBuffer(std::move(cmd_buffer))) {
546 VALIDATION_LOG << "Failed to submit glyph atlas command buffer";
547 }
548 });
549
550 // ---------------------------------------------------------------------------
551 // Step 4a: Draw new font-glyph pairs into the a host buffer and encode
552 // the uploads into the blit pass.
553 // ---------------------------------------------------------------------------
554 if (!UpdateAtlasBitmap(*last_atlas, blit_pass, host_buffer,
555 last_atlas->GetTexture(), new_glyphs, 0,
556 first_missing_index)) {
557 return nullptr;
558 }
559
560 // If all glyphs fit, just return the old atlas.
561 if (first_missing_index == new_glyphs.size()) {
562 return last_atlas;
563 }
564 }
565
566 int64_t height_adjustment = atlas_context->GetAtlasSize().height;
567 const int64_t max_texture_height =
568 context.GetResourceAllocator()->GetMaxTextureSizeSupported().height;
569
570 // IF the current atlas size is as big as it can get, then "GC" and create an
571 // atlas with only the required glyphs. OpenGLES cannot reliably perform the
572 // blit required here, as 1) it requires attaching textures as read and write
573 // framebuffers which has substantially smaller size limits that max textures
574 // and 2) is missing a GLES 2.0 implementation and cap check.
575 bool blit_old_atlas = true;
576 std::shared_ptr<GlyphAtlas> new_atlas = last_atlas;
577 if (atlas_context->GetAtlasSize().height >= max_texture_height ||
578 context.GetBackendType() == Context::BackendType::kOpenGLES) {
579 blit_old_atlas = false;
580 new_atlas = std::make_shared<GlyphAtlas>(
581 type, /*initial_generation=*/last_atlas->GetAtlasGeneration() + 1);
582
583 auto [update_glyphs, update_sizes] =
584 CollectNewGlyphs(new_atlas, text_frames);
585 new_glyphs = std::move(update_glyphs);
586 glyph_sizes = std::move(update_sizes);
587
588 glyph_positions.clear();
589 glyph_positions.reserve(new_glyphs.size());
590 first_missing_index = 0;
591
592 height_adjustment = 0;
593 atlas_context->UpdateRectPacker(nullptr);
594 atlas_context->UpdateGlyphAtlas(new_atlas, {0, 0}, 0);
595 }
596
597 // A new glyph atlas must be created.
598 ISize atlas_size = ComputeNextAtlasSize(atlas_context, //
599 new_glyphs, //
600 glyph_positions, //
601 glyph_sizes, //
602 first_missing_index, //
603 max_texture_height //
604 );
605
606 atlas_context->UpdateGlyphAtlas(new_atlas, atlas_size, height_adjustment);
607 if (atlas_size.IsEmpty()) {
608 return nullptr;
609 }
610 FML_DCHECK(new_glyphs.size() == glyph_positions.size());
611
612 TextureDescriptor descriptor;
613 switch (type) {
614 case GlyphAtlas::Type::kAlphaBitmap:
615 descriptor.format =
616 context.GetCapabilities()->GetDefaultGlyphAtlasFormat();
617 break;
618 case GlyphAtlas::Type::kColorBitmap:
619 descriptor.format = PixelFormat::kR8G8B8A8UNormInt;
620 break;
621 }
622 descriptor.size = atlas_size;
623 descriptor.storage_mode = StorageMode::kDevicePrivate;
624 descriptor.usage = TextureUsage::kShaderRead;
625 std::shared_ptr<Texture> new_texture =
626 context.GetResourceAllocator()->CreateTexture(descriptor);
627 if (!new_texture) {
628 return nullptr;
629 }
630
631 new_texture->SetLabel("GlyphAtlas");
632
633 std::shared_ptr<CommandBuffer> cmd_buffer = context.CreateCommandBuffer();
634 std::shared_ptr<BlitPass> blit_pass = cmd_buffer->CreateBlitPass();
635
636 fml::ScopedCleanupClosure closure([&]() {
637 blit_pass->EncodeCommands();
638 if (!context.EnqueueCommandBuffer(std::move(cmd_buffer))) {
639 VALIDATION_LOG << "Failed to submit glyph atlas command buffer";
640 }
641 });
642
643 // Now append all remaining glyphs. This should never have any missing data...
644 auto old_texture = new_atlas->GetTexture();
645 new_atlas->SetTexture(std::move(new_texture));
646
647 // ---------------------------------------------------------------------------
648 // Step 3a: Record the positions in the glyph atlas of the newly added
649 // glyphs.
650 // ---------------------------------------------------------------------------
651 for (size_t i = first_missing_index; i < glyph_positions.size(); i++) {
652 new_atlas->AddTypefaceGlyphPositionAndBounds(
653 new_glyphs[i], glyph_positions[i], glyph_sizes[i]);
654 }
655
656 // ---------------------------------------------------------------------------
657 // Step 4a: Draw new font-glyph pairs into the a host buffer and encode
658 // the uploads into the blit pass.
659 // ---------------------------------------------------------------------------
660 if (!BulkUpdateAtlasBitmap(*new_atlas, blit_pass, host_buffer,
661 new_atlas->GetTexture(), new_glyphs,
662 first_missing_index, new_glyphs.size())) {
663 return nullptr;
664 }
665
666 // Blit the old texture to the top left of the new atlas.
667 if (blit_old_atlas && old_texture) {
668 blit_pass->AddCopy(old_texture, new_atlas->GetTexture(),
669 IRect::MakeSize(new_atlas->GetTexture()->GetSize()),
670 {0, 0});
671 }
672
673 // ---------------------------------------------------------------------------
674 // Step 8b: Record the texture in the glyph atlas.
675 // ---------------------------------------------------------------------------
676
677 return new_atlas;
678 }

References impeller::AppendToExistingAtlas(), impeller::BulkUpdateAtlasBitmap(), impeller::ComputeNextAtlasSize(), impeller::Context::CreateCommandBuffer(), impeller::Context::EnqueueCommandBuffer(), impeller::TextureDescriptor::format, impeller::Context::GetBackendType(), impeller::Context::GetCapabilities(), impeller::Context::GetResourceAllocator(), impeller::TSize< T >::IsEmpty(), impeller::TypographerContext::IsValid(), impeller::GlyphAtlas::kAlphaBitmap, impeller::GlyphAtlas::kColorBitmap, impeller::kDevicePrivate, impeller::Context::kOpenGLES, impeller::kR8G8B8A8UNormInt, impeller::kShaderRead, impeller::TRect< T >::MakeSize(), impeller::TextureDescriptor::size, impeller::TextureDescriptor::storage_mode, type, impeller::UpdateAtlasBitmap(), and impeller::TextureDescriptor::usage.

## ◆ CreateGlyphAtlasContext()

std::shared_ptr< GlyphAtlasContext > impeller::TypographerContextSkia::CreateGlyphAtlasContext | ( | GlyphAtlas::Type | type | ) | const
| override virtual

Implements impeller::TypographerContext.

Definition at line 86 of file typographer_context_skia.cc.

86 {
87 return std::make_shared<GlyphAtlasContext>(type);
88 }

References type.

## ◆ Make()

std::shared_ptr< TypographerContext > impeller::TypographerContextSkia::Make | ( |  | ) |
| static

Definition at line 77 of file typographer_context_skia.cc.

77 {
78 return std::make_shared<TypographerContextSkia>();
79 }

Referenced by impeller::DlPlayground::OpenPlaygroundHere(), and impeller::testing::TEST_P().

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

- impeller/typographer/backends/skia/typographer_context_skia.h
- impeller/typographer/backends/skia/typographer_context_skia.cc

impeller::ISize
ISize64 ISize
Definition: size.h:174
impeller::GlyphAtlas::Type::kColorBitmap
@ kColorBitmap
impeller::GlyphAtlas::Type::kAlphaBitmap
@ kAlphaBitmap
impeller::UpdateAtlasBitmap
static bool UpdateAtlasBitmap(const GlyphAtlas &atlas, std::shared_ptr< BlitPass > &blit_pass, HostBuffer &host_buffer, const std::shared_ptr< Texture > &texture, const std::vector< FontGlyphPair > &new_pairs, size_t start_index, size_t end_index)
Definition: typographer_context_skia.cc:314
impeller::PixelFormat::kR8G8B8A8UNormInt
@ kR8G8B8A8UNormInt
impeller::BulkUpdateAtlasBitmap
static bool BulkUpdateAtlasBitmap(const GlyphAtlas &atlas, std::shared_ptr< BlitPass > &blit_pass, HostBuffer &host_buffer, const std::shared_ptr< Texture > &texture, const std::vector< FontGlyphPair > &new_pairs, size_t start_index, size_t end_index)
Batch render to a single surface.
Definition: typographer_context_skia.cc:255
impeller::ComputeNextAtlasSize
static ISize ComputeNextAtlasSize(const std::shared_ptr< GlyphAtlasContext > &atlas_context, const std::vector< FontGlyphPair > &extra_pairs, std::vector< Rect > &glyph_positions, const std::vector< Rect > &glyph_sizes, size_t glyph_index_start, int64_t max_texture_height)
Definition: typographer_context_skia.cc:167
impeller::Context::BackendType::kOpenGLES
@ kOpenGLES
impeller::StorageMode::kDevicePrivate
@ kDevicePrivate
type
GLenum type
Definition: blit_command_gles.cc:151
impeller::TRect::MakeSize
constexpr static TRect MakeSize(const TSize< U > &size)
Definition: rect.h:150
impeller::TextureUsage::kShaderRead
@ kShaderRead
impeller::AppendToExistingAtlas
static size_t AppendToExistingAtlas(const std::shared_ptr< GlyphAtlas > &atlas, const std::vector< FontGlyphPair > &extra_pairs, std::vector< Rect > &glyph_positions, const std::vector< Rect > &glyph_sizes, ISize atlas_size, int64_t height_adjustment, const std::shared_ptr< RectanglePacker > &rect_packer)
Definition: typographer_context_skia.cc:103
impeller::TypographerContext::IsValid
virtual bool IsValid() const
Definition: typographer_context.cc:17