Skip to main content

SpriteRenderSystem

Struct SpriteRenderSystem 

Source
pub struct SpriteRenderSystem<B: RenderBackend> { /* private fields */ }
Expand description

System for rendering 2D sprites using batched rendering.

This system:

  • Queries all entities with Sprite + Transform2D components
  • Batches sprites by texture to minimize draw calls
  • Sorts by Z-layer for correct rendering order
  • Submits draw calls to the GPU backend

§Performance

Target: <100 draw calls for 10,000 sprites (100:1 batch ratio)

Implementations§

Source§

impl<B: RenderBackend> SpriteRenderSystem<B>

Source

pub fn new(backend: B) -> GoudResult<Self>

Creates a new sprite render system with the given backend.

Source

pub fn with_config(backend: B, config: SpriteBatchConfig) -> GoudResult<Self>

Creates a new sprite render system with custom configuration.

Source

pub fn run( &mut self, world: &World, asset_server: &AssetServer, ) -> GoudResult<()>

Runs the sprite rendering system.

This should be called once per frame, after all game logic has been updated.

§Arguments
  • world - The ECS world containing sprite entities
  • asset_server - Asset server for loading textures
§Errors

Returns an error if:

  • Shader compilation fails
  • Buffer allocation fails
  • GPU operations fail
Source

pub fn stats(&self) -> (usize, usize, f32)

Gets rendering statistics from the last frame.

Returns (sprite_count, batch_count, batch_ratio) tuple.

Source

pub fn sprite_batch(&self) -> &SpriteBatch<B>

Gets a reference to the underlying sprite batch.

Source

pub fn sprite_batch_mut(&mut self) -> &mut SpriteBatch<B>

Gets a mutable reference to the underlying sprite batch.

Trait Implementations§

Source§

impl<B: RenderBackend> Debug for SpriteRenderSystem<B>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<B> Freeze for SpriteRenderSystem<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for SpriteRenderSystem<B>
where B: RefUnwindSafe,

§

impl<B> Send for SpriteRenderSystem<B>

§

impl<B> Sync for SpriteRenderSystem<B>

§

impl<B> Unpin for SpriteRenderSystem<B>
where B: Unpin,

§

impl<B> UnsafeUnpin for SpriteRenderSystem<B>
where B: UnsafeUnpin,

§

impl<B> UnwindSafe for SpriteRenderSystem<B>
where B: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,