flutter::DlVertices::Builder Class Reference

A utility class to build up a |DlVertices| object one set of data at a time. More...

#include <dl_vertices.h>

Classes
union	Flags
	flags to indicate/promise which of the optional texture coordinates or colors will be supplied during the build phase. More...

Public Member Functions
	Builder (DlVertexMode mode, int vertex_count, Flags flags, int index_count)
	Constructs a Builder and prepares room for the required and optional data.
bool	is_valid () const
	Returns true iff the underlying object was successfully allocated.
void	store_vertices (const DlPoint vertices[])
	Copies the indicated list of points as vertices.
void	store_vertices (const float coordinates[])
	Copies the indicated list of float pairs as vertices.
void	store_texture_coordinates (const DlPoint points[])
	Copies the indicated list of points as texture coordinates.
void	store_texture_coordinates (const float coordinates[])
	Copies the indicated list of float pairs as texture coordinates.
void	store_colors (const DlColor colors[])
	Copies the indicated list of colors as vertex colors.
void	store_colors (const uint32_t colors[])
	Copies the indicated list of unsigned ints as vertex colors in the 32-bit RGBA format.
void	store_indices (const uint16_t indices[])
	Copies the indicated list of 16-bit indices as vertex indices.
void	store_bounds (DlRect bounds)
	Overwrite the internal bounds with a precomputed bounding rect.
std::shared_ptr< DlVertices >	build ()
	Finalizes and the constructed DlVertices object.

Static Public Attributes
static constexpr Flags	kNone = {{false, false}}
static constexpr Flags	kHasTextureCoordinates = {{true, false}}
static constexpr Flags	kHasColors = {{false, true}}

Detailed Description

A utility class to build up a |DlVertices| object one set of data at a time.

Definition at line 73 of file dl_vertices.h.

Constructor & Destructor Documentation

Builder()

flutter::DlVertices::Builder::Builder	(	DlVertexMode	mode,
		int	vertex_count,
		Flags	flags,
		int	index_count
	)

Constructs a Builder and prepares room for the required and optional data.

Vertices are always required. Optional texture coordinates and optional colors are reserved depending on the |Flags|. Optional indices will be reserved if the index_count is positive (>0).

The caller must provide all data that is promised by the supplied |flags| and |index_count| parameters before calling the |build()| method.

Definition at line 207 of file dl_vertices.cc.

    : needs_texture_coords_(flags.has_texture_coordinates),
      needs_colors_(flags.has_colors),
      needs_indices_(index_count > 0) {
  vertex_count = std::max(vertex_count, 0);
  index_count = std::max(index_count, 0);
  void* storage =
      ::operator new(bytes_needed(vertex_count, flags, index_count));
  vertices_.reset(new (storage)
                      DlVertices(mode, vertex_count, flags, index_count),
                  DlVerticesDeleter);
}

References flutter::bytes_needed(), flutter::DlVerticesDeleter(), flutter::DlVertices::index_count(), flutter::DlVertices::mode(), and flutter::DlVertices::vertex_count().

Member Function Documentation

build()

std::shared_ptr< DlVertices > flutter::DlVertices::Builder::build

(

)

Finalizes and the constructed DlVertices object.

fails if any of the optional data promised in the constructor is missing.

Definition at line 301 of file dl_vertices.cc.

                                                   {
  FML_DCHECK(is_valid());
  if (vertices_->vertex_count() <= 0) {
    // We set this to true in the constructor to make sure that they
    // call store_vertices() only once, but if there are no vertices
    // then we will not object to them never having stored any vertices
    needs_vertices_ = false;
  }
  FML_DCHECK(!needs_vertices_);
  FML_DCHECK(!needs_texture_coords_);
  FML_DCHECK(!needs_colors_);
  FML_DCHECK(!needs_indices_);
 
  if (needs_bounds_) {
    vertices_->bounds_ =
        compute_bounds(vertices_->vertex_data(), vertices_->vertex_count_);
  }
 
  return std::move(vertices_);
}

References flutter::compute_bounds(), and FML_DCHECK.

Referenced by flutter::Vertices::init(), flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

is_valid()

bool flutter::DlVertices::Builder::is_valid ( ) const

inline

Returns true iff the underlying object was successfully allocated.

Definition at line 113 of file dl_vertices.h.

{ return vertices_ != nullptr; }

Referenced by flutter::Vertices::init(), flutter::testing::TEST(), and flutter::testing::TEST().

store_bounds()

void flutter::DlVertices::Builder::store_bounds

(

DlRect

bounds

)

Overwrite the internal bounds with a precomputed bounding rect.

Definition at line 296 of file dl_vertices.cc.

                                                  {
  vertices_->bounds_ = bounds;
  needs_bounds_ = false;
}

Referenced by flutter::DlVertices::Make().

store_colors() [1/2]

void flutter::DlVertices::Builder::store_colors

(

const DlColor

colors[]

)

Copies the indicated list of colors as vertex colors.

fails if colors have already been supplied or if they were not promised by the flags.has_colors.

Definition at line 266 of file dl_vertices.cc.

                                                           {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_colors_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  size_t bytes = vertices_->vertex_count_ * sizeof(colors[0]);
  memcpy(pod + vertices_->colors_offset_, colors, bytes);
  needs_colors_ = false;
}

References flutter::DlVertices::colors(), and FML_DCHECK.

Referenced by flutter::Vertices::init(), flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::testing::TEST().

store_colors() [2/2]

void flutter::DlVertices::Builder::store_colors

(

const uint32_t

colors[]

)

Copies the indicated list of unsigned ints as vertex colors in the 32-bit RGBA format.

fails if colors have already been supplied or if they were not promised by the flags.has_colors.

Definition at line 275 of file dl_vertices.cc.

                                                            {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_colors_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  DlColor* dlcolors_ptr =
      reinterpret_cast<DlColor*>(pod + vertices_->colors_offset_);
  for (int i = 0; i < vertices_->vertex_count_; ++i) {
    *dlcolors_ptr++ = DlColor(colors[i]);
  }
  needs_colors_ = false;
}

References flutter::DlVertices::colors(), FML_DCHECK, and i.

store_indices()

void flutter::DlVertices::Builder::store_indices

(

const uint16_t

indices[]

)

Copies the indicated list of 16-bit indices as vertex indices.

fails if indices have already been supplied or if they were not promised by (index_count > 0).

Definition at line 287 of file dl_vertices.cc.

                                                              {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_indices_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  size_t bytes = vertices_->index_count_ * sizeof(indices[0]);
  memcpy(pod + vertices_->indices_offset_, indices, bytes);
  needs_indices_ = false;
}

References FML_DCHECK, and flutter::DlVertices::indices().

Referenced by flutter::Vertices::init(), flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

store_texture_coordinates() [1/2]

void flutter::DlVertices::Builder::store_texture_coordinates

(

const DlPoint

points[]

)

Copies the indicated list of points as texture coordinates.

fails if texture coordinates have already been supplied or if they were not promised by the flags.has_texture_coordinates.

Definition at line 248 of file dl_vertices.cc.

                                                                        {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_texture_coords_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  size_t bytes = vertices_->vertex_count_ * sizeof(coords[0]);
  memcpy(pod + vertices_->texture_coordinates_offset_, coords, bytes);
  needs_texture_coords_ = false;
}

References FML_DCHECK.

Referenced by flutter::Vertices::init(), flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

store_texture_coordinates() [2/2]

void flutter::DlVertices::Builder::store_texture_coordinates

(

const float

coordinates[]

)

Copies the indicated list of float pairs as texture coordinates.

fails if texture coordinates have already been supplied or if they were not promised by the flags.has_texture_coordinates.

Definition at line 257 of file dl_vertices.cc.

                                                                      {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_texture_coords_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  store_points(pod, vertices_->texture_coordinates_offset_, coords,
               vertices_->vertex_count_);
  needs_texture_coords_ = false;
}

References FML_DCHECK, and flutter::store_points().

store_vertices() [1/2]

void flutter::DlVertices::Builder::store_vertices

(

const DlPoint

vertices[]

)

Copies the indicated list of points as vertices.

fails if vertices have already been supplied.

Definition at line 230 of file dl_vertices.cc.

                                                               {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_vertices_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  size_t bytes = vertices_->vertex_count_ * sizeof(vertices[0]);
  memcpy(pod + vertices_->vertices_offset_, vertices, bytes);
  needs_vertices_ = false;
}

References FML_DCHECK.

Referenced by flutter::Vertices::init(), flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

store_vertices() [2/2]

void flutter::DlVertices::Builder::store_vertices

(

const float

coordinates[]

)

Copies the indicated list of float pairs as vertices.

fails if vertices have already been supplied.

Definition at line 239 of file dl_vertices.cc.

                                                             {
  FML_DCHECK(is_valid());
  FML_DCHECK(needs_vertices_);
  char* pod = reinterpret_cast<char*>(vertices_.get());
  store_points(pod, vertices_->vertices_offset_, vertices,
               vertices_->vertex_count_);
  needs_vertices_ = false;
}

References FML_DCHECK, and flutter::store_points().

Member Data Documentation

kHasColors

constexpr Flags flutter::DlVertices::Builder::kHasColors = {{false, true}}

staticconstexpr

Definition at line 96 of file dl_vertices.h.

{{false, true}};

Referenced by flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::testing::TEST().

kHasTextureCoordinates

constexpr Flags flutter::DlVertices::Builder::kHasTextureCoordinates = {{true, false}}

staticconstexpr

Definition at line 95 of file dl_vertices.h.

{{true, false}};

Referenced by flutter::DlVertices::Make(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

kNone

constexpr Flags flutter::DlVertices::Builder::kNone = {{false, false}}

staticconstexpr

Definition at line 94 of file dl_vertices.h.

{{false, false}};

Referenced by flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), and flutter::testing::TEST().

---

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

• display_list/dl_vertices.h
• display_list/dl_vertices.cc