Source

pygame / doc / building.rst

Full commit
marcus 92265bf 



marcus 13d1988 



marcus 92265bf 





marcus 05cf033 
marcus 92265bf 

marcus 13d1988 
















marcus 96dd4ba 
marcus 13d1988 


































marcus 86ce793 
marcus 13d1988 
marcus 86ce793 


marcus 240dc49 
marcus 9a6a112 



marcus 19da6dc 

marcus 240dc49 



marcus 9e033a3 

marcus 96dd4ba 
marcus 852695e 











marcus 9e033a3 



#################################
Building Pygame2 on your platform
#################################

These section provide an overview and guidance for building and
installing pygame2 on various target platforms. Currently building
instructions for Unix compatible operating system and Microsoft Windows
exist.

Contents:

.. toctree::
   :maxdepth: 2

   builddarwin.rst
   buildmingw.rst
   buildvc.rst
   buildunix.rst

Besides those build instructions, pygame2's build process can be tweaked
for all target platforms as described below.

Environment Settings
====================
You can use certain environment settings to influence the build. Those
are evaluated in the "cfg.py" file in the top source directory and can
be tweaked directly within that file, too.

By default, the build system will test for certain environment variables
being set to control the build of various features. If they are *not*
available, the build system assumes that you want to have as many
features as possible and thus will enable them.

Currently the following environment variables are controlling, which
components of pygame2 should be build: ::

  WITH_SDL=[yes|no|1|True]                Example: make -DWITH_SDL=yes

Build and install the :mod:`pygame2.sdl` module. This wraps the SDL
library and is required for any other SDL related module in
pygame2. ::

  WITH_SDL_MIXER=[yes|no|1|True]          Example: make -DWITH_SDL_MIXER=no

Build and install the :mod:`pygame2.sdlmixer` module. This wraps the
SDL_mixer library. ::

  WITH_SDL_IMAGE=[yes|no|1|True]          Example: make -DWITH_SDL_IMAGE=True

Build and install the :mod:`pygame2.sdlimage` module. This wraps the
SDL_image library. ::

  WITH_SDL_TTF=[yes|no|1|True]            Example: make -DWITH_SDL_TTF=True

Build and install the :mod:`pygame2.sdlttf` module. This wraps the
SDL_ttf library. ::

  WITH_SDL_GFX=[yes|no|1|True]            Example: make -DWITH_SDL_GFX=1

Build and install the :mod:`pygame2.sdlgfx` module. This wraps the
SDL_gfx library. ::

  WITH_PNG=[yes|no|1|True]                Example: make -DWITH_PNG=True

Build with PNG format saving support for
:meth:`pygame2.sdl.video.Surface.save`. ::

  WITH_JPEG=[yes|no|1|True]               Example: make -DWITH_JPEG=False

Build with JPEG format saving support for
:meth:`pygame2.sdl.video.Surface.save`. ::

  WITH_FREETYPE=[yes|no|1|True]           Example: make -DWITH_FREETYPE=False

Build and install the :mod:`pygame2.freetype` module. This wraps the
FreeType2 library. ::

  WITH_PORTMIDI=[yes|no|1|True]           Example: make -DWITH_PORTMIDI=False

Build and install the :mod:`pygame2.pypm` and :mod:`pygame2.midi` modules. This
wraps the portmidi library and gives access to the :mod:`pygame2.midi`
module. ::

  WITH_OPENAL=[yes|no|1|True]             Example: make -DWITH_OPENAL=False
    
Build and install the :mod:`pygame2.openal` module. This wraps the OpenAL
library and gives access to the :mod:`pygame2.openal` module. ::

  WITH_OPENMP=[yes|no|1|True]             Example: make -DWITH_OPENAL=1
    
Add support for the Open Multi-Processing library. This will utilize the
OpenMP API to speed up certain routines, such as e.g blit and fill
operations.

.. note::

  This option is only available for certain compilers (GCC, Intel, MS
  VC++) and disabled by default.

::

  WITH_EXPERIMENTAL=[yes|no|1|True]       Example: make -DWITH_EXPERIMENTAL=True

Build pygame2 modules, which are marked as experimental. Note that those
modules are likely to change a lot between updates, may cause instabilities
and can contain lots of bugs.