Library Structure¶
Within the ochre
folder, the library is organized as follows:
backend/
: functionality which users of ochre should not need to access. These generally are layers of abstraction between underlying libraries (such as OpenGL and SDL) and the ochre API.game/
: theGame
class definition and any user-defined functionality, as well as testing functionality in the sampleGame.h
andGame.cpp
files. In general, actual ochre library functionality should not go here.include/
: header files for functionality which is part of the ochre API, and which the user can and should interact with. All underlying library functions and types should be abstracted away from API-interactable functionality here (return and input types of public members).lib/
: cpp files defining the declarations given ininclude/
. No new functionality should be defined here.src/
: files which include amain()
function. Most importantly, containsmain.cpp
, which runs all the code the user defined ingame/
. It should not be necessary to modifymain.cpp
.