Struct tetra::graphics::GeometryBuilder

pub struct GeometryBuilder { /* fields omitted */ }

A builder for creating primitive shape geometry, and associated buffers/meshes.

Implementations

impl GeometryBuilder

pub fn new() -> GeometryBuilder

Creates a new empty geometry builder.

pub fn rectangle(
    &mut self,
    style: ShapeStyle,
    rectangle: Rectangle
) -> Result<&mut GeometryBuilder>

Adds a rectangle.

Errors

• TetraError::TessellationError will be returned if the shape could not be turned into vertex data.

pub fn rounded_rectangle(
    &mut self,
    style: ShapeStyle,
    rectangle: Rectangle,
    radii: BorderRadii
) -> Result<&mut GeometryBuilder>

Adds a rounded rectangle.

Errors

• TetraError::TessellationError will be returned if the shape could not be turned into vertex data.

pub fn circle(
    &mut self,
    style: ShapeStyle,
    center: Vec2<f32>,
    radius: f32
) -> Result<&mut GeometryBuilder>

Adds a circle.

Errors

• TetraError::TessellationError will be returned if the shape could not be turned into vertex data.

pub fn ellipse(
    &mut self,
    style: ShapeStyle,
    center: Vec2<f32>,
    radii: Vec2<f32>
) -> Result<&mut GeometryBuilder>

Adds an ellipse.

Errors

• TetraError::TessellationError will be returned if the shape could not be turned into vertex data.

pub fn polygon(
    &mut self,
    style: ShapeStyle,
    points: &[Vec2<f32>]
) -> Result<&mut GeometryBuilder>

Adds a polygon.

Errors

• TetraError::TessellationError will be returned if the shape could not be turned into vertex data.

pub fn polyline(
    &mut self,
    stroke_width: f32,
    points: &[Vec2<f32>]
) -> Result<&mut GeometryBuilder>

Adds a polyline.

Errors

• TetraError::TessellationError will be returned if the shape could not be turned into vertex data.

pub fn set_color(&mut self, color: Color) -> &mut GeometryBuilder

Sets the color that will be used for subsequent shapes.

You can also use DrawParams::color to tint an entire mesh - this method only needs to be used if you want to display multiple colors in a single piece of geometry.

pub fn clear(&mut self) -> &mut GeometryBuilder

Clears the geometry builder's data.

pub fn vertices(&self) -> &[Vertex]

Returns a view of the generated vertex data.

pub fn indices(&self) -> &[u32]

Returns a view of the generated index data.

pub fn into_data(self) -> (Vec<Vertex>, Vec<u32>)

Consumes the builder, returning the generated geometry.

pub fn build_buffers(
    &self,
    ctx: &mut Context
) -> Result<(VertexBuffer, IndexBuffer)>

Builds a vertex and index buffer from the generated geometry.

Errors

• TetraError::PlatformError will be returned if the underlying graphics API encounters an error.

pub fn build_mesh(&self, ctx: &mut Context) -> Result<Mesh>

Builds a mesh from the generated geometry.

Errors

• TetraError::PlatformError will be returned if the underlying graphics API encounters an error.

Trait Implementations

impl Clone for GeometryBuilder

fn clone(&self) -> GeometryBuilder

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeometryBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GeometryBuilder

fn default() -> Self

Returns the "default value" for a type.