Flutter Impeller
impeller::TypographerContextSkia Class Reference

#include <typographer_context_skia.h>

Inheritance diagram for impeller::TypographerContextSkia:
impeller::TypographerContext

Public Member Functions

 TypographerContextSkia ()
 
 ~TypographerContextSkia () override
 
std::shared_ptr< GlyphAtlasContextCreateGlyphAtlasContext (GlyphAtlas::Type type) const override
 
std::shared_ptr< GlyphAtlasCreateGlyphAtlas (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< TypographerContextMake ()
 

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 ( )
overridedefault

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
overridevirtual

Implements impeller::TypographerContext.

Definition at line 488 of file typographer_context_skia.cc.

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

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
overridevirtual

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: