Struct riddle_renderer_wgpu::Sprite

pub struct Sprite<Device: WGPUDevice> { /* fields omitted */ }

A renderable region of a texture.

Multiple sprites can share a single texture. Sprites can either be built using Sprite, or SpriteAtlasBuilder.

Use SpriteRenderArgs for access to all supported paramters when rendering sprites, or use Sprite::render_at to specify only a location and use default arguments for everything else.

Sprites store a reference to the Renderer which built it, which will keep the renderer alive as long as the sprite is alive.

Example

let renderer = Renderer::new_from_window(&window)?;

// Load an image and create a sprite from it
let png_bytes = include_bytes!("../../example_assets/image.png");
let img = Image::load(&png_bytes[..], ImageFormat::Png)?;
let sprite = Sprite::new_from_image(&renderer, &img, &SpriteInitArgs::new())?;

// Render the sprite at the top left corner of the screen
let mut render_ctx = renderer.render(|render_ctx| {
    render_ctx.clear(Color::WHITE);
    sprite.render_at(render_ctx, vec2(0.0, 0.0))
})?;

Trait Implementations

impl<Device: WGPUDevice> CommonSprite<Renderer<Device>> for Sprite<Device>

fn new_from_image(
    renderer: &Renderer<Device>,
    img: &Image,
    init_args: &SpriteInitArgs
) -> Result<Self, RendererError>

Construct a new sprite from an image. The image contents are copied to a texture in RGBA8 format. The entire image will be used

fn subsprite(&self, source_rect: &Rect<f32>) -> Self

Build a sprite that shares the same underlying texture but represents a different portion of the texture.

fn dimensions(&self) -> Vector2<f32>

Get the dimensions of the sprite

fn render_regions<Ctx: RenderContext<Renderer<Device>> + ?Sized>(
    &self,
    render_ctx: &mut Ctx,
    args: &SpriteRenderArgs,
    parts: &[(Rect<f32>, Vector2<f32>)]
) -> Result<(), RendererError>

Render multiple sub regions of the sprite at once.

pub fn render<Ctx>(
    &self,
    render_ctx: &mut Ctx,
    args: &SpriteRenderArgs
) -> Result<(), RendererError> where
    Ctx: RenderContext<R>, 

Render the entire sprite.

pub fn render_at<Ctx>(
    &self,
    render_ctx: &mut Ctx,
    location: Vector2<f32>
) -> Result<(), RendererError> where
    Ctx: RenderContext<R>, 

Utility function to simply render the sprite at a given location