PygameShader 1.0.0

Pygame shader effects for 2D video game and arcade game

Pygame Shaders Library

Pygame shader project is a 2D game library written in Python and Cython that contains special effects for development of multimedia applications like video games, arcade game or for image processing It contains shaders offering a large variety of tools or algorithms to modify your game display and mechanics in real time @60 fps for games running display in medium resolution such as 1024 x 768. Some algorithms are more demanding than others in terms of processing power (ex median filtering, predator vision, due to the fact that they are built with more than one shader to provide a composite effect). Consequently, not all shader will run at the same speed at medium resolutions, feel free to experiment with higher display resolution while the shader provides 60 fps or above.

If you are using the shader library for sprites texturing and special effect for your sprites, then the overall processing time will be extremely fast due to the code optimization with cython and the size of the textures.

The shaders effects can be sorted within 5 different categories

• Color variation
• Filter
• Transformation
• Ambiance
• Special effect

Some effects can be used for interaction with the player(s) (ex the player is being hit or is receiving damages, and the screen is turning red; check the blood effect).

Screen shacking after an explosion, check the dampening effect.

Game pausing, use the blur effect to blur the background image until you unpause the game

You need to change the brightness of a scene uses the shader brightness.

Sprite texture colors can be changed over time with the HSL algorithm.

Your game needs to look a bit more retro, use the reduction shader to decrease the amount of colors in your texture or display etc

PygameShader provide tools to improve your overall game appearance by changing Sprites texture/surface and or by using great special effects that will affect the entire screen.

This version contains the following shaders:

• Color variations

  • RGB to BGR (Change your game display from RGB to a BGR model)
  • RGB to BRG (Change your game display from RGB to a BRG model)
  • grayscale mode
  • sepia; Sepia mode
  • color reduction, decrease the amount of color
  • hsl Rotate the colors
  • invert (Invert the game display negative color)
  • plasma (Add a plasma effect to your display)
  • heatmap conversion

• Filters

  • median*
  • sobel effect (edge display)
  • gaussian blur 5x5 (add a blur effect to your game)
  • sharpen filter (increase the image sharpness)
  • bright pass filter (bpf)

• Transformations

  • wave effect, create a wave effect to your game display
  • swirl, swirl the entire screen or texture
  • horizontal glitch, create a glitch effect affecting your display
  • mirroring
  • lateral dampening (lateral dampening effect that can be used for explosions)
  • dampening effect (zoom in and out dampening effect)
  • fisheye your game display is turned into a fisheye model
  • heatwave

• Ambiances

  • brightness, increase / decrease the brightness of your texture or game display in real time
  • saturation, increase / decrease the level of saturation

• Special effects

  • bloom effect, real time bloom effect for your display
  • water ripple effect, create water ripple effect in real time on your game display
  • tunnel effect, show a tunnel effect
  • tv scanline, TV scanline effect
  • blood effect, use a red vignette to color your screen each time your player is taking damage
  • predator vision, create a predator vision mode
  • fire effect, Display an amazing fire effect onto your game display or texture in real time
  • smoke/cloud effect, create a smoke effect or moving cloud
  • RGB split, split all the RGB channels separately and display the R, G and B channel with an offset
  • rain (bubble effect), You can generate a hundred bubbles or water droplets on your game display, the droplets/bubbles will reflect the game display in real time

The project is under the GNU GENERAL PUBLIC LICENSE Version 3

Demo

C:\>python demo.py

Installation

check the link for newest version https://pypi.org/project/PygameShader/

pip install PygameShader 
# or version 1.0.2  
pip install PygameShader==1.0.2

• version installed
• Imported module is case sensitive

>>>from PygameShader.shader import __VERSION__
>>>__VERSION__

Building cython code

When do you need to compile the cython code ?

Each time you are modifying any of the following files 
shader.pyx, shader.pxd, __init__.pxd or any external C code if applicable

1) open a terminal window
2) Go in the main project directory where (shader.pyx & 
   shader.pxd files are located)
3) run : python setup_shader.py build_ext --inplace --force

If you have to compile the code with a specific python 
version, make sure to reference the right python version 
in (python38 setup_shader.py build_ext --inplace)

If the compilation fail, refers to the requirement section and 
make sure cython and a C-compiler are correctly install on your
 system.
- A compiler such visual studio, MSVC, CGYWIN setup correctly on 
  your system.
  - a C compiler for windows (Visual Studio, MinGW etc) install 
  on your system and linked to your windows environment.
  Note that some adjustment might be needed once a compiler is 
  install on your system, refer to external documentation or 
  tutorial in order to setup this process.e.g https://devblogs.
  microsoft.com/python/unable-to-find-vcvarsall-bat/

OPENMP

In the main project directory, locate the file setup_shader.py. The compilation flag /openmp is used by default. To override the OPENMP feature and disable the multi-processing remove the flag /openmp

setup_shader.py

ext_modules=cythonize(Extension(
        "*", ['*.pyx'],
        extra_compile_args=["/Qpar", "/fp:fast", "/O2", "/Oy", "/Ot"], language="c"

Save the change and build the cython code with the following instruction:

python setup_shader.py build_ext --inplace --force

If the project build successfully, the compilation will end up with the following lines

Generating code
Finished generating code

If you have any compilation error refer to the section Building cython code, make sure your system has the following program & libraries installed. Check also that the code is not running in a different thread.

• Pygame version >3
• numpy >= 1.18
• cython >=0.29.21 (C extension for python)
• A C compiler for windows (Visual Studio, MinGW etc)

Credit

Yoann Berenguer

Dependencies :

numpy >= 1.18
pygame >=2.0.0
cython >=0.29.21

License :

GNU GENERAL PUBLIC LICENSE Version 3

Copyright (c) 2019 Yoann Berenguer

Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Testing:

>>> import PygameShader
>>> from PygameShader.tests.test_shader import run_testsuite
>>> run_testsuite()