flutter::DlVertices Class Reference

Holds all of the data (both required and optional) for a DisplayList drawVertices call. More...

#include <dl_vertices.h>

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

Public Member Functions
size_t	size () const
	Returns the size of the object including all of the inlined data.
DlRect	GetBounds () const
	Returns the bounds of the vertices.
DlVertexMode	mode () const
int	vertex_count () const
const DlPoint *	vertex_data () const
	Returns a pointer to the vertex information. Should be non-null.
const DlPoint *	texture_coordinate_data () const
const DlColor *	colors () const
int	index_count () const
const uint16_t *	indices () const
bool	operator== (DlVertices const &other) const

Static Public Member Functions
static std::shared_ptr< DlVertices >	Make (DlVertexMode mode, int vertex_count, const DlPoint vertices[], const DlPoint texture_coordinates[], const DlColor colors[], int index_count=0, const uint16_t indices[]=nullptr, const DlRect *bounds=nullptr)
	Constructs a DlVector with compact inline storage for all of its required and optional lists of data.

Friends
class	DisplayListBuilder

Detailed Description

Holds all of the data (both required and optional) for a DisplayList drawVertices call.

There are 4 main pices of data:

• vertices(): the points on the rendering surface that define the pixels being rendered to in a series of triangles. These points can map to triangles in various ways depending on the supplied |DlVertexMode|.
• texture_coordinates(): the points in the DlColorSource to map to the coordinates of the triangles in the vertices(). If missing, the vertex coordinates themselves will be used to map the source colors to the vertices.
• colors(): colors to map to each triangle vertex. Note that each vertex is mapped to exactly 1 color even if the DlVertex
• indices(): An indirection based on indices into the array of vertices (and by extension, their associated texture_coordinates and colors). Note that the DLVertexMode will still apply to the indices in the same way (and instead of the way) that it would normally be applied to the vertices themselves. The indices are useful, for example, to fill the vertices with a grid of points and then use the indices to define a triangular mesh that covers that grid without having to repeat the vertex (and texture coordinate and color) information for the times when a given grid coordinate gets reused in up to 4 mesh triangles.

Note that each vertex is mapped to exactly 1 texture_coordinate and color even if the DlVertexMode or indices specify that it contributes to more than one output triangle.

Definition at line 69 of file dl_vertices.h.

Member Function Documentation

colors()

const DlColor * flutter::DlVertices::colors ( ) const

inline

Returns a pointer to the vertex colors or null if none were provided.

Definition at line 218 of file dl_vertices.h.

                                {
    return static_cast<const DlColor*>(pod(colors_offset_));
  }

Referenced by Make(), operator==(), flutter::DlVertices::Builder::store_colors(), and flutter::DlVertices::Builder::store_colors().

GetBounds()

DlRect flutter::DlVertices::GetBounds ( ) const

inline

Returns the bounds of the vertices.

Definition at line 195 of file dl_vertices.h.

{ return bounds_; }

index_count()

int flutter::DlVertices::index_count ( ) const

inline

Returns a pointer to the count of vertex indices or 0 if none were provided.

Definition at line 224 of file dl_vertices.h.

{ return index_count_; }

Referenced by flutter::DlVertices::Builder::Builder(), and Make().

indices()

const uint16_t * flutter::DlVertices::indices ( ) const

inline

Returns a pointer to the vertex indices or null if none were provided.

Definition at line 228 of file dl_vertices.h.

                                  {
    return static_cast<const uint16_t*>(pod(indices_offset_));
  }

Referenced by Make(), operator==(), and flutter::DlVertices::Builder::store_indices().

Make()

std::shared_ptr< DlVertices > flutter::DlVertices::Make ( DlVertexMode  mode, int  vertex_count, const DlPoint  vertices[], const DlPoint  texture_coordinates[], const DlColor  colors[], int  index_count = 0, const uint16_t  indices[] = nullptr, const DlRect *  bounds = nullptr  )

static

Constructs a DlVector with compact inline storage for all of its required and optional lists of data.

Vertices are always required. Optional texture coordinates and optional colors are stored if the arguments are non-null. Optional indices will be stored iff the array argument is non-null and the index_count is positive (>0).

Definition at line 39 of file dl_vertices.cc.

                          {
  if (!vertices || vertex_count <= 0) {
    vertex_count = 0;
    texture_coordinates = nullptr;
    colors = nullptr;
  }
  if (!indices || index_count <= 0) {
    index_count = 0;
    indices = nullptr;
  }
 
  Flags flags;
  FML_DCHECK(!flags.has_texture_coordinates);
  FML_DCHECK(!flags.has_colors);
  if (texture_coordinates) {
    flags |= Builder::kHasTextureCoordinates;
  }
  if (colors) {
    flags |= Builder::kHasColors;
  }
  Builder builder(mode, vertex_count, flags, index_count);
 
  builder.store_vertices(vertices);
  if (texture_coordinates) {
    builder.store_texture_coordinates(texture_coordinates);
  }
  if (colors) {
    builder.store_colors(colors);
  }
  if (indices) {
    builder.store_indices(indices);
  }
  if (bounds != nullptr) {
    builder.store_bounds(*bounds);
  }
 
  return builder.build();
}

References flutter::DlVertices::Builder::build(), colors(), FML_DCHECK, index_count(), indices(), flutter::DlVertices::Builder::kHasColors, flutter::DlVertices::Builder::kHasTextureCoordinates, mode(), flutter::DlVertices::Builder::store_bounds(), flutter::DlVertices::Builder::store_colors(), flutter::DlVertices::Builder::store_indices(), flutter::DlVertices::Builder::store_texture_coordinates(), flutter::DlVertices::Builder::store_vertices(), and vertex_count().

Referenced by flutter::testing::GetTestVertices(), flutter::DlVertexPainter::IntoVertices(), 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(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), impeller::testing::TEST_P(), and impeller::testing::TEST_P().

mode()

DlVertexMode flutter::DlVertices::mode ( ) const

inline

Returns the vertex mode that defines how the vertices (or the indices) are turned into triangles.

Definition at line 199 of file dl_vertices.h.

{ return mode_; }

Referenced by flutter::DlVertices::Builder::Builder(), and Make().

operator==()

bool flutter::DlVertices::operator==

(

DlVertices const &

other

)

const

Definition at line 183 of file dl_vertices.cc.

                                                         {
  auto lists_equal = [](auto* a, auto* b, int count) {
    if (a == nullptr || b == nullptr) {
      return a == b;
    }
    for (int i = 0; i < count; i++) {
      if (a[i] != b[i]) {
        return false;
      }
    }
    return true;
  };
  return                                                                 //
      mode_ == other.mode_ &&                                            //
      vertex_count_ == other.vertex_count_ &&                            //
      lists_equal(vertex_data(), other.vertex_data(), vertex_count_) &&  //
      lists_equal(texture_coordinate_data(),                             //
                  other.texture_coordinate_data(),                       //
                  vertex_count_) &&                                      //
      lists_equal(colors(), other.colors(), vertex_count_) &&            //
      index_count_ == other.index_count_ &&                              //
      lists_equal(indices(), other.indices(), index_count_);
}

References colors(), i, indices(), texture_coordinate_data(), and vertex_data().

size()

size_t flutter::DlVertices::size

(

)

const

Returns the size of the object including all of the inlined data.

Definition at line 86 of file dl_vertices.cc.

                              {
  return bytes_needed(vertex_count_,
                      {{texture_coordinates_offset_ > 0, colors_offset_ > 0}},
                      index_count_);
}

References flutter::bytes_needed().

texture_coordinate_data()

const DlPoint * flutter::DlVertices::texture_coordinate_data ( ) const

inline

Returns a pointer to the vertex texture coordinate or null if none were provided.

Definition at line 212 of file dl_vertices.h.

                                                 {
    return static_cast<const DlPoint*>(pod(texture_coordinates_offset_));
  }

Referenced by operator==().

vertex_count()

int flutter::DlVertices::vertex_count ( ) const

inline

Returns the number of vertices, which also applies to the number of texture coordinate and colors if they are provided.

Definition at line 203 of file dl_vertices.h.

{ return vertex_count_; }

Referenced by flutter::DlVertices::Builder::Builder(), and Make().

vertex_data()

const DlPoint * flutter::DlVertices::vertex_data ( ) const

inline

Returns a pointer to the vertex information. Should be non-null.

Definition at line 206 of file dl_vertices.h.

                                     {
    return static_cast<const DlPoint*>(pod(vertices_offset_));
  }

Referenced by operator==().

Friends And Related Symbol Documentation

DisplayListBuilder

friend class DisplayListBuilder

friend

Definition at line 281 of file dl_vertices.h.

---

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

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