Crate bevy_sprite_render 

Provides 2D sprite rendering functionality.

Modules

prelude

The sprite prelude.

Structs

ColorMaterial

A 2d material that renders 2d meshes with a texture tinted by a uniform color

ColorMaterialFlags

ColorMaterialPlugin

ColorMaterialUniform

The GPU representation of the uniform data of a ColorMaterial.

DrawMesh2d

DrawSpriteBatch

EntitiesNeedingSpecialization

Temporarily stores entities that were determined to either need their specialized pipelines updated or to have their specialized pipelines removed.

ExtractedSlice

ExtractedSlices

ExtractedSprite

ExtractedSprites

ExtractedWireframeColor

ImageBindGroups

Material2dBindGroupId

Material2dKey

Material2dPipeline

Render pipeline data for a given Material2d

Material2dPlugin

Adds the necessary ECS resources and render logic to enable rendering entities using the given Material2d asset type (which includes Material2d types).

Material2dProperties

Common Material2d properties, calculated for a specific material instance.

Mesh2dBindGroup

Mesh2dMarker

Mesh2dPipeline

Mesh2dPipelineKey

Mesh2dRenderPlugin

Mesh2dTransforms

Mesh2dUniform

Mesh2dViewBindGroup

Mesh2dWireframe

Mesh2dWireframeTemplate

MeshFlags

MeshMaterial2d

A material used for rendering a Mesh2d.

MeshMaterial2dTemplate

NoWireframe2d

Disables wireframe rendering for any entity it is attached to. It will ignore the Wireframe2dConfig global setting.

PackedTileData

Packed per-tile data for use in the Rgba16Uint tile data texture in TilemapChunkMaterial.

PendingMeshMaterial2dQueues

Holds all entities with 2D mesh materials that couldn’t be specialized and/or queued because their materials hadn’t loaded yet.

PendingWireframe2dQueues

PreparedMaterial2d

Data prepared for a Material2d instance.

RenderMaterial2dBindGroupIds

RenderMaterial2dIds

RenderMaterial2dInstances

RenderMesh2dInstance

RenderMesh2dInstances

RenderWireframeInstances

RenderWireframeMaterial

SetMaterial2dBindGroup

SetMesh2dBindGroup

SetMesh2dViewBindGroup

SetSpriteTextureBindGroup

SetSpriteViewBindGroup

SetWireframe2dImmediates

SpecializedMaterial2dPipelineCache

Stores the SpecializedMaterial2dViewPipelineCache for each view.

SpecializedMaterial2dViewPipelineCache

Stores the cached render pipeline ID for each entity in a single view, as well as the last time it was changed.

SpecializedWireframePipelineCache

Stores the SpecializedWireframeViewPipelineCache for each view.

SpecializedWireframeViewPipelineCache

Stores the cached render pipeline ID for each entity in a single view, as well as the last time it was changed.

SpriteAssetEvents

SpriteBatch

SpriteBatches

SpriteMaterial

SpriteMaterialFlags

SpriteMaterialPlugin

SpriteMaterialUniform

SpriteMeshPlugin

SpriteMeta

SpritePipeline

SpritePipelineKey

SpriteRenderPlugin

Adds support for 2D sprite rendering.

SpriteViewBindGroup

TileData

Data for a single tile in the tilemap chunk.

TilemapChunk

A component representing a chunk of a tilemap. Each chunk is a rectangular section of tiles that is rendered as a single mesh.

TilemapChunkMaterial

Material used for rendering tilemap chunks.

TilemapChunkMaterialPlugin

Plugin that adds support for tilemap chunk materials.

TilemapChunkMeshCache

A resource storing the meshes for each tilemap chunk size.

TilemapChunkPlugin

Plugin that handles the initialization and updating of tilemap chunks. Adds systems for processing newly added tilemap chunks and updating their indices.

TilemapChunkTemplate

TilemapChunkTileData

Component storing the data of tiles within a chunk. Each index corresponds to a specific tile in the tileset. None indicates an empty tile.

ViewKeyCache

Wireframe2d

Enables wireframe rendering for any entity it is attached to. It will ignore the Wireframe2dConfig global setting.

Wireframe2dBatchSetKey

Wireframe2dBinKey

Data that must be identical in order to batch phase items together.

Wireframe2dColor

Sets the color of the Wireframe2d of the entity it is attached to.

Wireframe2dConfig

Wireframe2dMaterial

Wireframe2dPhaseItem

Wireframe2dPipeline

Wireframe2dPlugin

A Plugin that draws wireframes for 2D meshes.

WireframeEntitiesNeedingSpecialization

Temporarily stores entities that were determined to either need their specialized pipelines for wireframes updated or to have their specialized pipelines for wireframes removed.

Enums

AlphaMode2d

Sets how a 2d material’s base color alpha channel is used for transparency. Currently, this only works with Mesh2d. Sprites are always transparent.

ExtractedSpriteKind

SpriteSystems

System set for sprite rendering.

TileOrientation

The set of possible tile orientations. These represent all possible results of mirroring the tile horizontally and/or vertically, and/or rotation by 90 degree increments.

Constants

MATERIAL_2D_BIND_GROUP_INDEX

Traits

Material2d

Materials are used alongside Material2dPlugin, Mesh2d, and MeshMaterial2d to spawn entities that are rendered with a specific Material2d type. They serve as an easy to use high level way to render Mesh2d entities with custom shader logic.

Functions

alpha_mode_pipeline_key

check_entities_needing_specialization

Finds 2D entities that have changed in such a way as to potentially require specialization and adds them to the EntitiesNeedingSpecialization list.

check_views_need_specialization

check_wireframe_entities_needing_specialization

Finds 2D wireframe entities that have changed in such a way as to potentially require specialization and adds them to the WireframeEntitiesNeedingSpecialization list.

extract_entities_needs_specialization

extract_entities_that_need_specializations_removed

A system that adds entities that were judged to need their specializations removed to the appropriate table in DirtySpecializations.

extract_mesh2d

extract_mesh_materials_2d

extract_sprite_events

extract_sprites

extract_text2d_spritebevy_text

This system extracts the sprites from the 2D text components and adds them to the “render world”.

extract_wireframe_2d_entities_needing_specialization

extract_wireframe_2d_entities_that_need_specializations_removed

A system that adds entities that were judged to need their specializations removed to the appropriate table in DirtyWireframeSpecializations.

extract_wireframe_materials

init_batched_instance_buffer

init_material_2d_pipeline

init_mesh_2d_pipeline

init_sprite_pipeline

init_wireframe_2d_pipeline

make_chunk_tile_data_image

prepare_mesh2d_bind_group

prepare_mesh2d_view_bind_groups

prepare_pending_mesh_material2d_queues

Prepares the PendingMeshMaterial2dQueues for a new frame by swapping the current and previous frame queues for each view.

prepare_sprite_image_bind_groups

prepare_sprite_view_bind_groups

queue_material2d_meshes

queue_sprites

specialize_material2d_meshes

specialize_wireframes

tonemapping_pipeline_key

update_tilemap_chunk_indices

Type Aliases

DrawSprite

RenderCommand for sprite rendering.

DrawWireframe2d