Struct lyon_tessellation::BuffersBuilder

pub struct BuffersBuilder<'l, OutputVertex: 'l, OutputIndex: 'l, Ctor> { /* private fields */ }

A temporary view on a VertexBuffers object which facilitate the population of vertex and index data.

BuffersBuilders record the vertex offset from when they are created so that algorithms using them don’t need to worry about offsetting indices if some geometry was added beforehand. This means that from the point of view of a BuffersBuilder user, the first added vertex is at always offset at the offset 0 and VertexBuilder takes care of translating indices adequately.

Often, algorithms are built to generate vertex positions without knowledge of eventual other vertex vertex. The VertexConstructor does the translation from generic Input to OutputVertex. If your logic generates the actual vertex type directly, you can use the SimpleBuffersBuilder convenience typedef.

Implementations

impl<'l, OutputVertex: 'l, OutputIndex: 'l, Ctor> BuffersBuilder<'l, OutputVertex, OutputIndex, Ctor>

pub fn new(
    buffers: &'l mut VertexBuffers<OutputVertex, OutputIndex>,
    ctor: Ctor
) -> Self

pub fn with_vertex_offset(self, offset: u32) -> Self

pub fn with_inverted_winding(self) -> InvertWinding<Self>

Consumes self and returns a builder with opposite triangle face winding.

pub fn buffers<'a, 'b: 'a>(
    &'b self
) -> &'a VertexBuffers<OutputVertex, OutputIndex>

Trait Implementations

impl<'l, OutputVertex, OutputIndex, Ctor> FillGeometryBuilder for BuffersBuilder<'l, OutputVertex, OutputIndex, Ctor>where
    OutputVertex: 'l,
    OutputIndex: Add + From<VertexId> + MaxIndex,
    Ctor: FillVertexConstructor<OutputVertex>,

fn add_fill_vertex(
    &mut self,
    vertex: FillVertex<'_>
) -> Result<VertexId, GeometryBuilderError>

Inserts a vertex, providing its position, and optionally a normal. Returns a vertex id that is only valid between begin_geometry and end_geometry.

impl<'l, OutputVertex, OutputIndex, Ctor> GeometryBuilder for BuffersBuilder<'l, OutputVertex, OutputIndex, Ctor>where
    OutputVertex: 'l,
    OutputIndex: Add + From<VertexId> + MaxIndex,

fn begin_geometry(&mut self)

Called at the beginning of a generation.

fn abort_geometry(&mut self)

abort_geometry is called instead of end_geometry if an error occurred while producing the geometry and we won’t be able to finish.

fn add_triangle(&mut self, a: VertexId, b: VertexId, c: VertexId)

Insert a triangle made of vertices that were added after the last call to begin_geometry.

fn end_geometry(&mut self)

Called at the end of a generation. Returns the number of vertices and indices added since the last time begin_geometry was called.

impl<'l, OutputVertex, OutputIndex, Ctor> StrokeGeometryBuilder for BuffersBuilder<'l, OutputVertex, OutputIndex, Ctor>where
    OutputVertex: 'l,
    OutputIndex: Add + From<VertexId> + MaxIndex,
    Ctor: StrokeVertexConstructor<OutputVertex>,

fn add_stroke_vertex(
    &mut self,
    v: StrokeVertex<'_, '_>
) -> Result<VertexId, GeometryBuilderError>

Inserts a vertex, providing its position, and optionally a normal. Returns a vertex id that is only valid between begin_geometry and end_geometry.