.. pygame_shaders documentation master file, created by
   sphinx-quickstart on Wed Jun 28 22:29:13 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pygame_shaders's documentation!
==========================================

pygame_shaders is a simple and easy to use way to integrate GLSL shaders into new
or existing pygame projects.

Features
==================
* Support for Frgament, Vertex and Compute GLSL shaders.
* Ability to apply shaders to pygame surfaces, as well as direct rendering onto pygame display. 
* Easy wrapper around moderngl textures, allowing for easy communication between OpenGL textures and pygame surfaces.

Installation
==================

.. code-block:: console

    pip install pygame_shaders

.. toctree::
   :maxdepth: 2
   :caption: Table of contents:

   quick_start
   writing_shaders
   screen_shaders
   surface_shaders
   compute_shaders
   modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`