Struct ggez::graphics::InstanceArray

pub struct InstanceArray { /* private fields */ }

Array of instances for fast rendering of many meshes.

Traditionally known as a “batch”.

Implementations

impl InstanceArray

pub fn new( gfx: &impl Has<GraphicsContext>, image: impl Into<Option<Image>> ) -> Self

Creates a new InstanceArray capable of storing up to n-capacity instances (this can be changed and is resized automatically when needed).

If image is None, a 1x1 white image will be used which can be used to draw solid rectangles.

This constructor is unordered meaning instances will be drawn by their push/index order. Use InstanceArray::new_ordered to order by z-value.

pub fn new_ordered( gfx: &impl Has<GraphicsContext>, image: impl Into<Option<Image>> ) -> Self

See InstanceArray::new for details.

This constructor is ordered meaning instances will be drawn by their z-value at a slight performance cost. Use InstanceArray::new to order by index.

pub fn set(&mut self, instances: impl IntoIterator<Item = DrawParam>)

Resets all the instance data to a set of DrawParam.

pub fn push(&mut self, instance: DrawParam)

Pushes a new instance onto the end.

pub fn update(&mut self, index: u32, instance: DrawParam)

Updates an existing instance at a given index, if it is valid.

pub fn clear(&mut self)

Clears all instance data.

pub fn is_dirty(&self) -> bool

Returns whether the instance data has been changed without being flushed (i.e., uploaded to the GPU).

pub fn instances(&self) -> &[DrawParam]

Returns an immutable slice of all the instance data in this InstanceArray.

pub fn resize(&mut self, gfx: &impl Has<GraphicsContext>, new_capacity: usize)

Changes the capacity of this InstanceArray while preserving instances.

If new_capacity is less than the len, the instances will be truncated.

Panics

Panics if new_capacity is 0.

pub fn image(&self) -> Image

Returns this InstanceArray’s associated image.

pub fn capacity(&self) -> usize

Returns the number of instances this InstanceArray is capable of holding. This number was specified when creating the InstanceArray, or if the InstanceArray was automatically resized, the greatest length of instances.

pub fn dimensions_meshed( &self, gfx: &impl Has<GraphicsContext>, mesh: &Mesh ) -> Option<Rect>

This is equivalent to <InstanceArray as Drawable>::dimensions() (see Drawable::dimensions()), but with a mesh taken into account.

Essentially, consider <InstanceArray as Drawable>::dimensions() to be the bounds when the InstanceArray is drawn with canvas.draw(), and consider InstanceArray::dimensions_meshed() to be the bounds when the InstanceArray is drawn with canvas.draw_instanced_mesh().

Trait Implementations

impl Debug for InstanceArray

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

Formats the value using the given formatter.

impl Drawable for InstanceArray

fn draw(&self, canvas: &mut Canvas, param: impl Into<DrawParam>)

Draws the drawable onto the canvas.

fn dimensions(&self, gfx: &impl Has<GraphicsContext>) -> Option<Rect>

Returns a bounding box in the form of a Rect.