Struct polystrip::renderer::Frame

pub struct Frame<'a> { /* fields omitted */ }

A frame to be drawn to. The frame gets presented on drop.

Since a Frame borrows the Renderer it was created for, any functions which would normally be called on a &Renderer must be called on the Frame, which implements Deref<Target = Renderer>.

More methods are implemented in the FrameGeometryExt trait.

Implementations

impl<'a> Frame<'a>

pub fn draw_colored(&mut self, shape: ColoredShape<'_>)

Draws a ColoredShape. The shape will be drawn in front of any shapes drawn before it.

pub fn draw_textured(&mut self, shape: TexturedShape<'_>, texture: &'a Texture)

Draws a TexturedShape. The shape will be drawn in front of any shapes drawn before it.

Arguments

• shape: The TexturedShape to be rendered.
• texture: The Texture to be drawn to the geometry of the shape.

pub fn draw_shape_set(&mut self, set: ShapeSet<'a>)

Draws a ShapeSet. All shapes in the set will be drawn in front of shapes drawn before the set. The render order of shapes in the set is unspecified.

pub fn clear(&mut self, color: Color)

Clears the entire frame with the specified color, setting every pixel to its value.

Methods from Deref<Target = Renderer>

pub fn pixel(&self, x: i32, y: i32) -> GpuPos

Converts pixel coordinates to Gpu coordinates

Trait Implementations

impl<'a> Deref for Frame<'a>

type Target = Renderer

The resulting type after dereferencing.

fn deref(&self) -> &Renderer

Dereferences the value.

impl<'a> FrameGeometryExt<'a> for Frame<'a>

fn draw_rect(&mut self, bounds: Rect, color: Color)

Draw and fill a Rect with the specified Color.

fn draw_texture(&mut self, x: i32, y: i32, texture: &'a Texture)

Draw a rectangular texture at a 1:1 scale at the specified coordinates.

fn draw_texture_scaled(&mut self, destination: Rect, texture: &'a Texture)

Draw a rectangular texture to fit the specified Rect

fn draw_texture_cropped(
    &mut self,
    source: Rect,
    x: i32,
    y: i32,
    texture: &'a Texture
)

Draw a rectangular section of a texture at a 1:1 scale at the specified coordinates.

fn draw_texture_cropped_scaled(
    &mut self,
    source: Rect,
    destination: Rect,
    texture: &'a Texture
)

Draw a rectangular section of a texture to fit the specified destination Rect.