ratr0-engine Logo

User Guide

  • Getting Started
    • Initialization
      • ratr0_engine_startup()
    • Configuration Options
  • Introduction
    • Motivation
    • Architecture & Design
  • Collision system
    • AABB
    • Spatial hashing
      • Strategy
  • Rendering Architecture
    • Motivation
    • Central Concepts
      • Copper lists
      • Playfields
      • Double buffering
      • Render list
      • Background restoration algorithm (dirty rectangles)
        • Idea
        • BOB changes
      • Graphics effects
        • Palette interpolation
  • Input system
    • Description
    • Design ideas
      • Keyboard input
  • The Memory subsystem
    • Motivation
  • Sprites
    • Hardware sprites
    • Soft sprites (BOBs)
    • Creating a sprite in the RATR0 engine
  • Stages system
    • Description
    • Stages
  • Errors I made during development
  • Conclusions

Utilities (ratr0-utils)

  • Welcome to ratr0-utils
    • Installation
    • Command Line Tools
      • The ratr0-maketiles tool
        • Parameters in detail
      • The ratr0-makesprites tool
        • Parameters in detail
        • Creating more than one sprite
      • The ratr0-converttiled tool
        • Parameters in detail
      • The ratr0-makecoplist tool
        • Parameters in detail
        • Copper list format
        • Example list:
    • Asset Formats
      • The Tiles File Format
        • Introduction
        • Specification
      • The Level File Format
        • Introduction
        • Specification
      • The Sprites File Format
        • Introduction
        • Specification

Technical Reference

  • API Reference
    • Core Lifecycle
      • ratr0_engine_startup()
    • Memory Management
      • Ratr0MemoryConfig
        • general_pool_size
        • general_table_size
        • chip_pool_size
        • chip_table_size
    • Data Structures
      • Ratr0Surface
        • width
        • height
        • depth
        • is_interleaved
        • buffer
    • Graphics & Display
      • ratr0_display_init_buffers()
    • Search Index
ratr0-engine
  • Index
  • Edit on GitHub

Index

R

R

  • ratr0_display_init_buffers (C function)
  • ratr0_engine_startup (C function), [1]
  • Ratr0MemoryConfig (C struct)
  • Ratr0MemoryConfig.chip_pool_size (C var)
  • Ratr0MemoryConfig.chip_table_size (C var)
  • Ratr0MemoryConfig.general_pool_size (C var)
  • Ratr0MemoryConfig.general_table_size (C var)
  • Ratr0Surface (C struct)
  • Ratr0Surface.buffer (C var)
  • Ratr0Surface.depth (C var)
  • Ratr0Surface.height (C var)
  • Ratr0Surface.is_interleaved (C var)
  • Ratr0Surface.width (C var)

© Copyright 2025-2026, Wei-ju Wu.

Built with Sphinx using a theme provided by Read the Docs.