A GUI system for pygame._sdl2.
This Fork is created for personal use only, utilizing the contents of the pygame._sdl2 library for hardware acceleration or GPU rendering purposes base on pygame_gui 0.6.10.
This version employs a custom TextureLayer class (note: NOT pygame._sdl2.video.Texture!) to record texture rendering information and render it. Therefore, when using it, you need to import from pygame.core, with the filename being ui_texture.py.
Due to this modification, all instances using the Surface class are replaced with Texture, and introduced TextureLayer to serve as a management instance for an object's textures, but please note that in most cases, these two terms are used interchangeably in the naming (meaning TextureLayer objects are also named as texture). Users need to pay attention to the types of variables specified here to differentiate what should be used. In most cases, these functions should work, but occasional bugs of unknown origin may occur in the display currently.
In most cases, using Texture objects for resource management is a better choice in the new system.
- If you encounter problems, please resolve them on your own. I do not guarantee being able to resolve most issues.
- There is no guarantee of future feature updates. If needed, refer to the first point.
- There is no guarantee of issue-free operation. If problems arise, refer to the first point.
- Python 3.8+
- Pygame Community Edition 2.4.0+
- python-i18n (does localization to different languages)
- cd to root folder and run this command in a command prompt:
pip install .
The package should be pygame_gui_sdl2.
-
If all goes well you should see a message about pygame_gui_sdl2 being installed successfully and will be able to find pygame_gui_sdl2 in the list of installed packages for your python interpreter (PyCharm displays these as a nice list under File->Settings->Project:project_name->Project Interpreter).
-
Should you need to delete pygame_gui for any reason then PyCharm will also let you do that from the same Project Interpreter settings window using the red minus symbol button.
You may need a Window object and use the Renderer.from_window method to obtain a Renderer object. Currently, the most reliable way to create a Window object is to create one using
pygame.display.set_mode()
and then use
Window.from_display_module()
to create a Window object, after which you will no longer need to use the pygame.display.set_mode method.
Next, you will need to create a UIManager object, which requires passing in a Renderer. When creating other UI objects, the first parameter also defaults to Renderer. During each frame rendering, you need to first call
renderer.clear()
then
manager.update(time_delta)
manager.draw_ui()
and finally
renderer.present()
which should display the content. Note that no parameters should be passed into draw_ui(), and time_delta should in second.
This version is primarily built based on the following approach:
A TextureLayer object is created, with a corresponding parameter called target. If true, it will additionally create four layers: background_texture_layer, text_texture_layer, text_shadow_texture_layer, and top_texture_layer. Each layer can be considered as a separate layer, and the order of layers is background, image, text_shadow, text, top, and effect. Each layer will be rendered to father_texture first and then finally rendered from father_texture to the window.
In order to facilitate texture rendering, many methods for directly manipulating textures are retained in utility and TextureLayer, such as copying, rotating, etc., all of which can be called directly. At the same time, in TextureLayer.render_to_target, similar content to Surface.fill is implemented, which changes the alpha of the corresponding rendered pixels.
However, note that render_to_target is not an in-place method, which means the passed-in texture will not be directly rendered. Instead, a new texture will be created internally and returned, so the returned value needs to be used to render the new texture when calling the method.
Run this command in a command prompt:
pip install pygame_gui -U
Or, you may be able to use your IDE to update the library (PyCharm lets you update modules in it's interpreter settings).
There is documentation available here, you can also try out the examples at the pygame_gui_examples repository.
