Skip to main content

API Reference

This section documents the public C++ API of the Glitter engine — the classes and functions you interact with when writing game code or extending the engine.

Internal implementation details (Vulkan passes, OpenGL draw executors, shader loaders, model parsers, etc.) are intentionally excluded; they are subject to change and are not part of the stable public surface.

How to read the tables

Each page follows the same structure:

ColumnMeaning
Member / FunctionC++ signature (simplified)
ReturnsReturn type, or void
DescriptionWhat it does

Subsystem index

PageClasses covered
Coreengine, engine_configuration
RendererRenderer, RendererRegistry, ShaderSystem, IPostProcess, Geometry
SceneScene, SceneGraph, Camera, SceneLoader
Loop & InputLoopScheduler, InputMapper, InputEvent
SystemHWLayer, Window, resources, uri<T>, Console, PakReader
Logginglog_manager

Namespaces

glitter::           Engine core and configuration
glitter::render:: Renderer, geometry, shaders, materials
glitter::scene:: Scene graph, cameras, lights
glitter::loop:: Game loop scheduler
glitter::input:: Input mapping
glitter::system:: Hardware layer, windowing, developer console
glitter::logging:: Log manager