SGCT master (487fac4)
Simple Graphics Cluster Toolkit
Loading...
Searching...
No Matches
SGCT C++ API reference

This is the generated reference for the public C++ API of SGCT, the Simple Graphics Cluster Toolkit. It covers every type declared in the include/sgct headers and is regenerated from the sources on each deployment of sgct.dev.

A single umbrella header pulls in everything an application normally needs:

#include <sgct/sgct.h>

Good places to start are sgct::Engine, which owns the render loop and the callbacks an application fills in, sgct::Window for per-window state, and the sgct::config namespace, which mirrors the JSON cluster configuration file.

The narrative documentation lives on the main site: see Getting started for embedding SGCT in an application, the C++ API reference page for an orientation to the namespaces below, and the Configuration reference for the JSON side of the same objects.