Struct riddle_renderer_wgpu::SpriteRenderCommand

pub struct SpriteRenderCommand { /* fields omitted */ }

Builder for a Sprite render call

Defaults:

• Pivot: (0,0)
• Scale: (1,1)
• Angle: 0
• Diffuse Color: Color::WHITE

The location refers to the location of the pivot of the sprite. The pivot of the sprite is relative to the top left of the sprite.

Example

let sprite = SpriteBuilder::new(img).build(&renderer)?;

let mut render_ctx = renderer.begin_render()?;
render_ctx.clear(Color::WHITE)?;

// Render the sprite
SpriteRenderCommand::new(vec2(0.0, 0.0))
    .with_scale(vec2(1.0, 2.0))
    .with_color(Color::RED)
    .render(&mut render_ctx, &sprite)?;

render_ctx.present()?;

Implementations

impl SpriteRenderCommand

pub fn new<T: Into<Vector2<f32>>>(location: T) -> Self

New render command with default args, at the specified location

pub fn at<T: Into<Vector2<f32>>>(&mut self, location: T) -> &mut Self

Set the location of the sprite, specifying where the pivot should be placed.

pub fn with_pivot<T: Into<Vector2<f32>>>(&mut self, pivot: T) -> &mut Self

Set the pivot of the sprite, relative to the top left of the sprite

pub fn with_scale<T: Into<Vector2<f32>>>(&mut self, scale: T) -> &mut Self

Set the scale at which the sprite will be rendered

pub fn with_angle(&mut self, angle: f32) -> &mut Self

Set the angle at which the sprite will be rendered, in radians.

pub fn with_color(&mut self, color: Color<f32>) -> &mut Self

Set the diffuse color of the sprite, which will be multiplied by the sprite colors.

pub fn render<Device>(
    &self,
    render_ctx: &mut impl RenderContext,
    sprite: &WGPUSprite<Device>
) -> Result<(), RendererError> where
    Device: WGPUDevice, 

Invoke the render command, for the given sprite, in the specified context

Trait Implementations

impl Clone for SpriteRenderCommand

fn clone(&self) -> SpriteRenderCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpriteRenderCommand

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

Formats the value using the given formatter.

impl Default for SpriteRenderCommand

fn default() -> Self

Returns the “default value” for a type.