Struct ggez::graphics::Mesh

pub struct Mesh { /* fields omitted */ }

2D polygon mesh.

All of its creation methods are just shortcuts for doing the same operation via a MeshBuilder.

Methods

impl Mesh

pub fn new_line<P>(
    ctx: &mut Context,
    points: &[P],
    width: f32,
    color: Color
) -> GameResult<Mesh> where
    P: Into<Point2<f32>> + Clone, 

Create a new mesh for a line of one or more connected segments.

pub fn new_circle<P>(
    ctx: &mut Context,
    mode: DrawMode,
    point: P,
    radius: f32,
    tolerance: f32,
    color: Color
) -> GameResult<Mesh> where
    P: Into<Point2<f32>>, 

Create a new mesh for a circle.

pub fn new_ellipse<P>(
    ctx: &mut Context,
    mode: DrawMode,
    point: P,
    radius1: f32,
    radius2: f32,
    tolerance: f32,
    color: Color
) -> GameResult<Mesh> where
    P: Into<Point2<f32>>, 

Create a new mesh for an ellipse.

pub fn new_polyline<P>(
    ctx: &mut Context,
    mode: DrawMode,
    points: &[P],
    color: Color
) -> GameResult<Mesh> where
    P: Into<Point2<f32>> + Clone, 

Create a new mesh for series of connected lines.

pub fn new_polygon<P>(
    ctx: &mut Context,
    mode: DrawMode,
    points: &[P],
    color: Color
) -> GameResult<Mesh> where
    P: Into<Point2<f32>> + Clone, 

Create a new mesh for closed polygon. The points given must be in clockwise order, otherwise at best the polygon will not draw.

pub fn new_rectangle(
    ctx: &mut Context,
    mode: DrawMode,
    bounds: Rect,
    color: Color
) -> GameResult<Mesh>

Create a new mesh for a rectangle

pub fn from_triangles<P>(
    ctx: &mut Context,
    triangles: &[P],
    color: Color
) -> GameResult<Mesh> where
    P: Into<Point2<f32>> + Clone, 

Create a new Mesh from a raw list of triangle points.

pub fn from_raw<V>(
    ctx: &mut Context,
    verts: &[V],
    indices: &[u32],
    texture: Option<Image>
) -> GameResult<Mesh> where
    V: Into<Vertex> + Clone, 

Creates a Mesh from a raw list of triangles defined from points and indices, with the given UV texture coordinates. You may also supply an Image to use as a texture, if you pass None, it will just use a pure white texture. The indices should draw the points in clockwise order, otherwise at best the mesh will not draw.

This is the most primitive mesh-creation method, but allows you full control over the tesselation and texturing. As such it will return an error, panic, or produce incorrect/invalid output (that may later cause drawing to panic), if:

• indices contains a value out of bounds of verts
• verts is longer than u32::MAX elements.
• indices do not specify triangles in clockwise order.

pub fn set_vertices(
    &mut self,
    ctx: &mut Context,
    verts: &[Vertex],
    indices: &[u32]
)

Replaces the vertices in the Mesh with the given ones. This MAY be faster than re-creating a Mesh with Mesh::from_raw() due to reusing memory instead of allocating and deallocating it, both on the CPU and GPU side. There's too much variation in implementations and drivers to promise it will actually be faster though. At worst, it will be the same speed.

Trait Implementations

impl Drawable for Mesh

fn draw(&self, ctx: &mut Context, param: DrawParam) -> GameResult

Draws the drawable onto the rendering target.

fn dimensions(&self, _ctx: &mut Context) -> Option<Rect>

Returns a bounding box in the form of a Rect.

fn set_blend_mode(&mut self, mode: Option<BlendMode>)

Sets the blend mode to be used when drawing this drawable. This overrides the general graphics::set_blend_mode(). If None is set, defers to the blend mode set by graphics::set_blend_mode().

fn blend_mode(&self) -> Option<BlendMode>

Gets the blend mode to be used when drawing this drawable.

impl PartialEq<Mesh> for Mesh

fn eq(&self, other: &Mesh) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Mesh) -> bool

This method tests for !=.

impl Clone for Mesh

fn clone(&self) -> Mesh

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mesh

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

Formats the value using the given formatter.