Repository navigation
Open
Labels
Milestone
Description
TL;DR: Needs clearer wording, cross-refs, and better organization.
What Needs Work?
Wording
Introduction
- Choose a better phrase than "sprite engine" (we don't use the word elsewhere in the doc or code base)
There is another texture type in Arcade in the lower level OpenGL API: arcade.gl.Texture2D. This represents an actual OpenGL texture and should only be used when dealing with the low level rendering API.
Textures can be created/loaded before or after the window is created because they don’t interact with OpenGL directly.
- Clearly define the separate texture layers:
- Software / RAM (Arcade)
- pyglet
- OpenGL / The GPU
When a texture is created a
hash/nameis required. This should be a unique string. If two more more textures have the same name we will run into trouble.When loading textures the absolute path to the file is used as part of the name including vertical/horizontal/diagonal, size and other parameter for a truly unique name.
- Add clear definition of the required data
- Explain what "trouble" means
- Explain what "unique" means
- Cross-reference path handling
- Briefly clarify the algorithm with a cross-reference to the source file
- Explain the flipping options
Activity
MinhBDoan commentedon Feb 21, 2026
Hi! I'd like to work on this as my first contribution. Is it still available?
einarf commentedon Mar 1, 2026
Pretty sure there's always something to fix in docs. It's a never ending project 😆
Fixes pythonarcade#2821: Improve Textures guide wording, layers, uniq…
MinhBDoan commentedon Mar 6, 2026
First-time contribution, feedback welcome!