olc::PixelGameEngine Documentation

Primary Documentation

These classes provide all of the user functionality, and form the basis of PGE applications.

• _olc::PixelGameEngine - The core engine class, drawing routines, user input and window manipulation
• _olc::Pixel - Class representing a single pixel
• _olc::Vector2D - A geometric 2D vector class
• _olc::Sprite - Class representing imagery stored in system RAM
• _olc::Decal - Class representing imagery stored in graphics RAM
• _olc::Renderable - Class providing convenient managing of sprites and decals
• _olc::ResourcePack - Class representing packed asset data

Secondary Documentation

• Setup & Compiling
  • Compiling on Windows
  • Compiling on Linux
  • Compiling on Mac
• Conceptual Descriptions
  • Typical olc::PixelGameEngine workflow
  • Creating a window
  • Loading and drawing images
  • Sprites or Decals
  • World <-> Screen Transformations

Customization Documentation

These classes provide portability and extension options. Creating these classes is considered advanced use of the PGE.

• olc::PGEX
• olc::Platform
• olc::Renderer
• olc::ImageLoader

Internals Documentation

These classes are used internally by the PGE, and are not accessible to the user.

• olc::LayerDesc
• olc::DecalInstance
• olc::ResourceBuffer