Built in Effects

Library maintains a set of most common effects and filters. They are available through gdx-vfx-effects module. All shaders are tested and should be compatible with all the official backends.

Contributing to the library effects

Any contribution to the Effect collection is highly appreciated. Here are the different ways to support the project:

Request for specific effect

If you feel that a common post-processing effect is missing in the library package, then you're welcome to put your request in the form of a new Issue. But please before submitting one, do a quick check and make sure there are no duplicate tickets on that topic.

Please add [EFFECT REQUEST] prefix to the issue's title.

Improving existing effects

Most of the effects were adopted from the other libraries/sources. They may be not in the best shape and still could benefit from stability/performance improvements. You're very welcome to propose an update through PR.

Please add [EFFECT IMPROVEMENT] prefix to the PR's title.

Submit your effect implementation

If you made an effort to construct your own effect and adapt it for the library, creating a PR with your code is a great way to contribute to the community.

There are a couple of requirements for the effect submission, please make sure your code respects them all:

1. The effect should have common usage and have a good justification to be included in the library's built-in effect package.
2. The effect should be tested and compatible with all the official LibGDX backends (including iOS and HTML ones). If you are limited on testing options and cannot validate the code for all the platforms - it's OK, you still can create PR, and the code will be tested/refined by the maintainers prior to being accepted.
3. The code style should match the official LibGDX requirements (Library's own formatter will be introduced later).

Please add [EFFECT SUBMISSION] prefix to the PR's title.