C API
=============

The goal of the C API is make usage as similar to the original C as CFFI will allow.
So the `example programs <https://github.com/electronstudio/raylib-python-cffi/tree/master/examples>`_
are very, very similar to the C originals.

Example program:

.. code-block::

    from raylib import *

    InitWindow(800, 450, b"Hello Raylib")
    SetTargetFPS(60)

    camera = ffi.new("struct Camera3D *", [[18.0, 16.0, 18.0], [0.0, 0.0, 0.0], [0.0, 1.0, 0.0], 45.0, 0])

    while not WindowShouldClose():
        UpdateCamera(camera, CAMERA_ORBITAL)
        BeginDrawing()
        ClearBackground(RAYWHITE)
        BeginMode3D(camera[0])
        DrawGrid(20, 1.0)
        EndMode3D()
        DrawText(b"Hellow World", 190, 200, 20, VIOLET)
        EndDrawing()
    CloseWindow()

If you want to be more portable (i.e. same code will work with dynamic bindings) you can prefix the functions like this:

.. code-block::

    from raylib import ffi, rl, colors

    rl.InitWindow(800, 450, b"Hello Raylib")
    rl.SetTargetFPS(60)

    ...



.. note:: Whenever you need to convert stuff between C and Python see https://cffi.readthedocs.io

.. important:: Your **primary reference** should always be

   * `the C Raylib docs <https://www.raylib.com/cheatsheet/cheatsheet.html>`_

   * `the C Raylib examples <https://github.com/electronstudio/raylib-python-cffi/tree/master/examples>`_

   * `the C Raylib header file <https://github.com/raysan5/raylib/blob/master/src/raylib.h>`_

However, here is a list of available functions:

Functions API reference
-----------------------

.. autoapimodule:: raylib
    :members:
    :undoc-members: