aboutsummaryrefslogtreecommitdiff
path: root/subprojects/d2tk/pugl/doc/c/overview.rst
blob: 4bd024df3062ee615a8a00f7216c131c9741f8d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
.. default-domain:: c
.. highlight:: c

########
Overview
########

The Pugl API revolves around two main objects: the `world` and the `view`.
An application creates a world to manage top-level state,
then creates one or more views to display.

The core API (excluding backend-specific components) is declared in ``pugl.h``:

.. code-block:: c

   #include <pugl/pugl.h>

.. toctree::

   world
   view
   events
   event-loop
   shutting-down

.. _pkg-config: https://www.freedesktop.org/wiki/Software/pkg-config/