API Reference Overview¶

This document provides a complete technical reference for all PixelRoot32 APIs, organized by module. Each class includes descriptions, constructors, methods, properties, and usage examples.

Organization¶

The API is organized into the following modules:

• Core: Engine, Scene, Entity, Actor, PhysicsActor, SceneManager
• Graphics: Renderer, Camera2D, Color, Font, Sprite, TileMap, DrawSurface
• Audio: AudioEngine, MusicPlayer, AudioTypes, AudioConfig, AudioBackend
• Input: InputManager, InputConfig
• Physics: CollisionSystem, CollisionTypes
• UI: UIElement, UIButton, UILabel, UILayouts
• Particles: ParticleEmitter, ParticleConfig, ParticlePresets

Quick Navigation¶

Core Module¶

• Engine - Main engine class, game loop management
• Scene - Scene/level management
• Entity - Base game object class
• Actor - Entity with collision support
• PhysicsActor - Actor with automatic physics
• InputManager - Input handling
• InputConfig - Input configuration

Graphics Module¶

• Renderer - High-level rendering API
• Camera2D - 2D camera for scrolling
• Color - Color constants and utilities
• Font - Bitmap font system
• Sprite - Sprite structures and formats
• TileMap - Tilemap structure
• DisplayConfig - Display configuration

Audio Module¶

• AudioEngine - Sound effects playback
• MusicPlayer - Background music playback
• AudioTypes - Audio data structures
• AudioConfig - Audio configuration

Physics Module¶

• CollisionSystem - Collision detection
• CollisionTypes - Collision primitives

UI Module¶

• UIElement - Base UI element class
• UIButton - Clickable button
• UILabel - Text label
• UILayouts - Layout containers

API Documentation Format¶

Each API reference page follows this structure:

Class Name¶

Brief description of the class and its purpose.

Namespace¶

namespace pixelroot32::module {
    class ClassName {
        // ...
    };
}

Constructors¶

List of all constructors with parameters.

Public Methods¶

Properties¶

Usage Example¶

// Example code showing typical usage

Performance Notes¶

Any performance considerations or limitations.

See Also¶

Links to related APIs and documentation.

Finding APIs¶

By Functionality¶

• Game Loop: See Engine
• Rendering: See Renderer
• Input: See InputManager
• Audio: See AudioEngine and MusicPlayer
• Physics: See PhysicsActor and CollisionSystem
• UI: See UIElement and layouts

By Module¶

Navigate to the specific module folder: - api_reference/core/ - Core engine classes - api_reference/graphics/ - Rendering and graphics - api_reference/audio/ - Audio system - api_reference/physics/ - Physics and collisions - api_reference/ui/ - User interface

Complete API List¶

Core¶

• Engine
• Scene
• Entity
• Actor
• PhysicsActor
• InputManager
• InputConfig

Graphics¶

• Renderer
• Camera2D
• Color
• Font
• Sprite
• TileMap
• DisplayConfig

Audio¶

• AudioEngine
• MusicPlayer
• AudioTypes
• AudioConfig

Physics¶

• CollisionSystem
• CollisionTypes

UI¶

• UIElement
• UIButton
• UILabel
• UIVerticalLayout
• UIHorizontalLayout
• UIGridLayout
• UIAnchorLayout
• UIPanel
• UIPaddingContainer

Related Documentation¶

• Manual - Game Development - How to use the APIs
• Manual - Advanced Graphics - Advanced techniques
• Code Examples - Reusable code snippets
• Game Examples Guide - Learn from complete games

Note: This is an overview. For detailed API documentation, see the individual reference pages linked above.