Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Appendix B: API Glossary

All Bevy, Rust standard library, and third-party APIs referenced across this book, organized by category. Each entry links to official documentation and notes the chapter where it first appears.


Bevy: Core ECS

APIDescriptionFirst Seen
AppApplication builder and entry pointCh 1
CommandsDeferred command queue for spawning/despawning entitiesCh 1
ComponentDerive macro to mark a type as attachable to entitiesCh 1
PluginTrait for modular code organizationCh 1
Query<T>System parameter for reading/writing entity componentsCh 1
Res<T>Immutable access to a global resourceCh 1
ResMut<T>Mutable access to a global resourceCh 1
ResourceDerive macro for global singleton dataCh 1
Single<T>Query that expects exactly one matching entityCh 1
StartupSchedule that runs systems once at launchCh 1
UpdateSchedule that runs systems every frameCh 1
With<T>Query filter requiring a component’s presenceCh 1
Changed<C>Filter for modified componentsCh 4
EntityUnique identifier for an ECS entityCh 5
OnEnterOne-shot schedule on state entryCh 4
OnExitOne-shot schedule on state exitCh 4
StatesDerive for state machine enumsCh 4
Without<T>Query filter excluding entities with a componentCh 4
in_state()Run-condition gating systems to a stateCh 4
.chain()Enforces sequential system executionCh 4
.run_if()Conditional system executionCh 4

Bevy: Rendering

APIDescriptionFirst Seen
Camera2dMarker component for 2D camera entitiesCh 1
ColorColor representation (multiple color spaces)Ch 1
Sprite2D image rendering componentCh 1
Text2d2D text rendering componentCh 1
TextColorText color componentCh 1
TextFontFont configuration for text renderingCh 1
TextureAtlasSprite atlas frame selectionCh 1
TextureAtlasLayoutDefines how a spritesheet is slicedCh 1
GizmosImmediate-mode debug shape drawingCh 4
OrthographicProjectionCamera projection for zoom controlCh 5

Bevy: Transforms & Math

APIDescriptionFirst Seen
TransformPosition, rotation, and scale of an entityCh 1
UVec2Unsigned integer 2D vectorCh 1
Vec22D floating-point vectorCh 1
Vec33D floating-point vectorCh 1
URectUnsigned integer rectangleCh 2
GlobalTransformWorld-space transform (parent hierarchy)Ch 5
IVec2Signed integer 2D vectorCh 4

Bevy: Assets

APIDescriptionFirst Seen
AssetServerLoads and manages game assetsCh 1
Assets<T>Typed storage for loaded assetsCh 1
Handle<T>Reference-counted pointer to a loaded assetCh 1
AssetMarks a type as a loadable Bevy assetCh 3
TypePathRuntime type path info (required for Asset)Ch 3

Bevy: Input

APIDescriptionFirst Seen
ButtonInput<KeyCode>Keyboard state resourceCh 1
KeyCodeIdentifies a physical keyboard keyCh 1

Bevy: Time

APIDescriptionFirst Seen
TimeFrame timing and delta time resourceCh 1
TimerCountdown or repeating timerCh 1
TimerModeOnce or Repeating timer behaviorCh 1

Bevy: Plugins & Configuration

APIDescriptionFirst Seen
AssetPluginConfigures asset loading pathsCh 1
ClearColorGlobal background color resourceCh 1
DefaultPluginsStandard plugin groupCh 1
ImagePluginConfigures image loading defaultsCh 1
WindowWindow configurationCh 1
WindowPluginConfigures window creationCh 1
WindowResolutionWindow size configurationCh 2
MonitorSelectionWhich monitor for fullscreenCh 5
WindowModeFullscreen/windowed/borderless modeCh 5

Rust Standard Library

APIDescriptionFirst Seen
CloneDeep-copy capabilityCh 1
CopyCheap bitwise duplicationCh 1
DebugDebug formatting ({:?})Ch 1
DefaultDefault value generationCh 1
DerefTransparent wrapper delegationCh 1
DerefMutMutable wrapper delegationCh 1
EqTotal equalityCh 1
Option<T>Optional value (Some or None)Ch 1
PartialEqEquality comparison (==)Ch 1
Result<T, E>Success or failure return typeCh 1
Vec<T>Growable heap-allocated arrayCh 1
StringOwned heap-allocated UTF-8 stringCh 2
HashMap<K, V>Key-value container with O(1) lookupCh 3
HashEnables use as HashMap keyCh 3
fmt::DisplayUser-facing {} string formattingCh 5

serde

APIDescriptionFirst Seen
SerializeSerialization to RON, JSON, etc.Ch 3
DeserializeDeserialization from RON, JSON, etc.Ch 3