SkMesh Class Reference

#include <SkMesh.h>

Classes
class	IndexBuffer
struct	Result
class	VertexBuffer

Public Types
enum class	Mode { kTriangles , kTriangleStrip }
using	ChildPtr = SkRuntimeEffect::ChildPtr

Public Member Functions
	SkMesh ()
	~SkMesh ()
	SkMesh (const SkMesh &)
	SkMesh (SkMesh &&)
SkMesh &	operator= (const SkMesh &)
SkMesh &	operator= (SkMesh &&)
sk_sp< SkMeshSpecification >	refSpec () const
SkMeshSpecification *	spec () const
Mode	mode () const
sk_sp< VertexBuffer >	refVertexBuffer () const
VertexBuffer *	vertexBuffer () const
size_t	vertexOffset () const
size_t	vertexCount () const
sk_sp< IndexBuffer >	refIndexBuffer () const
IndexBuffer *	indexBuffer () const
size_t	indexOffset () const
size_t	indexCount () const
sk_sp< const SkData >	refUniforms () const
const SkData *	uniforms () const
SkSpan< const ChildPtr >	children () const
SkRect	bounds () const
bool	isValid () const

Static Public Member Functions
static Result	Make (sk_sp< SkMeshSpecification >, Mode, sk_sp< VertexBuffer >, size_t vertexCount, size_t vertexOffset, sk_sp< const SkData > uniforms, SkSpan< ChildPtr > children, const SkRect &bounds)
static Result	MakeIndexed (sk_sp< SkMeshSpecification >, Mode, sk_sp< VertexBuffer >, size_t vertexCount, size_t vertexOffset, sk_sp< IndexBuffer >, size_t indexCount, size_t indexOffset, sk_sp< const SkData > uniforms, SkSpan< ChildPtr > children, const SkRect &bounds)

Detailed Description

A vertex buffer, a topology, optionally an index buffer, and a compatible SkMeshSpecification.

The data in the vertex buffer is expected to contain the attributes described by the spec for vertexCount vertices, beginning at vertexOffset. vertexOffset must be aligned to the SkMeshSpecification's vertex stride. The size of the buffer must be at least vertexOffset + spec->stride()*vertexCount (even if vertex attributes contains pad at the end of the stride). If the specified bounds do not contain all the points output by the spec's vertex program when applied to the vertices in the custom mesh, then the result is undefined.

MakeIndexed may be used to create an indexed mesh. indexCount indices are read from the index buffer at the specified offset, which must be aligned to 2. The indices are always unsigned 16-bit integers. The index count must be at least 3.

If Make() is used, the implicit index sequence is 0, 1, 2, 3, ... and vertexCount must be at least 3.

Both Make() and MakeIndexed() take a SkData with the uniform values. See SkMeshSpecification::uniformSize() and SkMeshSpecification::uniforms() for sizing and packing uniforms into the SkData.

Definition at line 263 of file SkMesh.h.

Member Typedef Documentation

ChildPtr

using SkMesh::ChildPtr = SkRuntimeEffect::ChildPtr

Definition at line 312 of file SkMesh.h.

Member Enumeration Documentation

Mode

enum class SkMesh::Mode

strong

Enumerator
kTriangles
kTriangleStrip

Definition at line 308 of file SkMesh.h.

{ kTriangles, kTriangleStrip };

Constructor & Destructor Documentation

SkMesh() [1/3]

SkMesh::SkMesh ( )

default

~SkMesh()

SkMesh::~SkMesh ( )

default

SkMesh() [2/3]

SkMesh::SkMesh ( const SkMesh &  )

default

SkMesh() [3/3]

SkMesh::SkMesh ( SkMesh &&  )

default

Member Function Documentation

bounds()

SkRect SkMesh::bounds ( ) const

inline

Definition at line 369 of file SkMesh.h.

{ return fBounds; }

children()

SkSpan< const ChildPtr > SkMesh::children ( ) const

inline

Definition at line 367 of file SkMesh.h.

{ return SkSpan(fChildren); }

indexBuffer()

IndexBuffer * SkMesh::indexBuffer ( ) const

inline

Definition at line 359 of file SkMesh.h.

{ return fIB.get(); }

indexCount()

size_t SkMesh::indexCount ( ) const

inline

Definition at line 362 of file SkMesh.h.

{ return fICount;  }

indexOffset()

size_t SkMesh::indexOffset ( ) const

inline

Definition at line 361 of file SkMesh.h.

{ return fIOffset; }

isValid()

bool SkMesh::isValid

(

)

const

Definition at line 753 of file SkMesh.cpp.

                           {
    bool valid = SkToBool(fSpec);
    SkASSERT(valid == std::get<0>(this->validate()));
    return valid;
}

Make()

SkMesh::Result SkMesh::Make ( sk_sp< SkMeshSpecification >  spec, Mode  mode, sk_sp< VertexBuffer >  vb, size_t  vertexCount, size_t  vertexOffset, sk_sp< const SkData >  uniforms, SkSpan< ChildPtr >  children, const SkRect &  bounds  )

static

Creates a non-indexed SkMesh. The returned SkMesh can be tested for validity using SkMesh::isValid(). An invalid mesh simply fails to draws if passed to SkCanvas::drawMesh(). If the mesh is invalid the returned string give contain the reason for the failure (e.g. the vertex buffer was null or uniform data too small).

Definition at line 694 of file SkMesh.cpp.

                                                  {
    SkMesh mesh;
    mesh.fSpec     = std::move(spec);
    mesh.fMode     = mode;
    mesh.fVB       = std::move(vb);
    mesh.fUniforms = std::move(uniforms);
    mesh.fChildren.push_back_n(children.size(), children.data());
    mesh.fVCount   = vertexCount;
    mesh.fVOffset  = vertexOffset;
    mesh.fBounds   = bounds;
    auto [valid, msg] = mesh.validate();
    if (!valid) {
        mesh = {};
    }
    return {std::move(mesh), std::move(msg)};
}

MakeIndexed()

SkMesh::Result SkMesh::MakeIndexed ( sk_sp< SkMeshSpecification >  spec, Mode  mode, sk_sp< VertexBuffer >  vb, size_t  vertexCount, size_t  vertexOffset, sk_sp< IndexBuffer >  ib, size_t  indexCount, size_t  indexOffset, sk_sp< const SkData >  uniforms, SkSpan< ChildPtr >  children, const SkRect &  bounds  )

static

Creates an indexed SkMesh. The returned SkMesh can be tested for validity using SkMesh::isValid(). A invalid mesh simply fails to draw if passed to SkCanvas::drawMesh(). If the mesh is invalid the returned string give contain the reason for the failure (e.g. the index buffer was null or uniform data too small).

Definition at line 718 of file SkMesh.cpp.

                                                         {
    if (!ib) {
        // We check this before calling validate to disambiguate from a non-indexed mesh where
        // IB is expected to be null.
        return {{}, SkString{"An index buffer is required."}};
    }
    SkMesh mesh;
    mesh.fSpec     = std::move(spec);
    mesh.fMode     = mode;
    mesh.fVB       = std::move(vb);
    mesh.fVCount   = vertexCount;
    mesh.fVOffset  = vertexOffset;
    mesh.fIB       = std::move(ib);
    mesh.fUniforms = std::move(uniforms);
    mesh.fChildren.push_back_n(children.size(), children.data());
    mesh.fICount   = indexCount;
    mesh.fIOffset  = indexOffset;
    mesh.fBounds   = bounds;
    auto [valid, msg] = mesh.validate();
    if (!valid) {
        mesh = {};
    }
    return {std::move(mesh), std::move(msg)};
}

mode()

Mode SkMesh::mode ( ) const

inline

Definition at line 350 of file SkMesh.h.

{ return fMode; }

operator=() [1/2]

SkMesh & SkMesh::operator= ( const SkMesh &  )

default

operator=() [2/2]

SkMesh & SkMesh::operator= ( SkMesh &&  )

default

refIndexBuffer()

sk_sp< IndexBuffer > SkMesh::refIndexBuffer ( ) const

inline

Definition at line 358 of file SkMesh.h.

{ return fIB; }

refSpec()

sk_sp< SkMeshSpecification > SkMesh::refSpec ( ) const

inline

Definition at line 347 of file SkMesh.h.

{ return fSpec; }

refUniforms()

sk_sp< const SkData > SkMesh::refUniforms ( ) const

inline

Definition at line 364 of file SkMesh.h.

{ return fUniforms; }

refVertexBuffer()

sk_sp< VertexBuffer > SkMesh::refVertexBuffer ( ) const

inline

Definition at line 352 of file SkMesh.h.

{ return fVB; }

spec()

SkMeshSpecification * SkMesh::spec ( ) const

inline

Definition at line 348 of file SkMesh.h.

{ return fSpec.get(); }

uniforms()

const SkData * SkMesh::uniforms ( ) const

inline

Definition at line 365 of file SkMesh.h.

{ return fUniforms.get(); }

vertexBuffer()

VertexBuffer * SkMesh::vertexBuffer ( ) const

inline

Definition at line 353 of file SkMesh.h.

{ return fVB.get(); }

vertexCount()

size_t SkMesh::vertexCount ( ) const

inline

Definition at line 356 of file SkMesh.h.

{ return fVCount;  }

vertexOffset()

size_t SkMesh::vertexOffset ( ) const

inline

Definition at line 355 of file SkMesh.h.

{ return fVOffset; }

---

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

• third_party/skia/include/core/SkMesh.h
• third_party/skia/src/core/SkMesh.cpp