pyglet 2.1.13__tar.gz → 3.0.dev1__tar.gz

pyglet-3.0.dev1/.github/workflows/unittests.yml

@@ -0,0 +1,108 @@
+name: PyTest
+
+on: [push, pull_request]
+
+jobs:
+  linux:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13', '3.14', 'pypy-3.10' ]
+        backend-override: [ 'opengl', 'gl2', 'gles2', 'gles3']
+
+    name: Python ${{ matrix.python-version }} Ubuntu ${{ matrix.backend-override }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+          sudo apt-get install xvfb
+      - name: Run tests
+        env:
+          PYGLET_BACKEND: ${{ matrix.backend-override }}
+        run: |
+          xvfb-run --auto-servernum  python3 -m pyglet.info
+          xvfb-run --auto-servernum  pytest tests --ignore=tests/interactive
+
+  osx:
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        python-version: [ '3.10', '3.11', '3.12', '3.13', '3.14']
+    name: Python ${{ matrix.python-version }} macOS
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install pytest
+      - name: Run tests
+        run: |
+          python3 -m pyglet.info
+          pytest tests --ignore=tests/interactive --ignore=tests/integration
+
+  windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
+        backend-override: [ 'opengl', 'gl2', 'gles2' ]
+    name: Python ${{ matrix.python-version }} Windows ${{ matrix.backend-override }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: msys2/setup-msys2@v2
+        with:
+          msystem: MINGW64
+          release: false
+          install: mingw-w64-x86_64-mesa
+      - uses: ssciwr/setup-mesa-dist-win@v2
+      - name: Install dependencies
+        run: |
+          pip install pytest
+      - name: Run tests
+        shell: pwsh
+        env:
+          PYGLET_BACKEND: ${{ matrix.backend-override }}
+        run: |
+          python3 -m pyglet.info
+          pytest tests --ignore=tests/interactive
+
+  headless:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.12', '3.13', '3.14', 'pypy-3.10' ]
+        backend-override: [ 'opengl', 'gles2', 'gles3']
+
+    name: Python ${{ matrix.python-version }} Ubuntu HEADLESS ${{ matrix.backend-override }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+          sudo apt-get update
+          sudo apt-get install --fix-missing libgl1-mesa-dev xvfb
+      - name: Run tests
+        env:
+          PYGLET_BACKEND: ${{ matrix.backend-override }}
+          PYGLET_HEADLESS: true
+        run: |
+          python3 -m pyglet.info
+          pytest tests --ignore=tests/interactive

pyglet-3.0.dev1/API_CHANGES.rst

@@ -0,0 +1,102 @@
+Pyglet 3.0
+==========
+Large overhaul of the graphics systems, as it will now support different graphics backends or no backend.
+
+
+pyglet.config
+-------------
+*Added*: This module replaces ``pyglet.gl.Config``. To be used for specific backends such as ``pyglet.config.OpenGL``.
+
+pyglet.enums
+------------
+*Added*: This module creates enums for various systems including graphical backends and fonts. (Fill in specifics later)
+
+pyglet.options
+--------------
+*Added*: ``pyglet.options.backend``: Can now specify a specific graphics backend to target, or no backend if you wish to use
+Pyglet for windowing.
+
+*Removed*: ``pyglet.options.shadow_window``: The shadow window containing a graphical context has been removed.
+
+*Removed*: `'real'`, `'scaled'` options from ``pyglet.options.dpi_scaling``. Defaults to `'platform'`.
+
+*Added*: ``pyglet.options.optimize_states``: For debugging purposes if states are not behaving as they should. Report any issues that arise where disabling this fixes an issue.
+
+pyglet.graphics
+---------------
+*Changed*: Created backend agnostic API setups to support multiple backends. See pyglet.enums.
+
+*Changed*: Now has a global graphics core object that manages the multiple contexts.
+
+*Added*: Batches can now accept a specific context and/or initial size argument.
+
+*Added*: Ability kwargs to target specific contexts for Pyglet objects if using multiple contexts.
+
+
+pyglet.font
+-----------
+*Added*: ``pyglet.font.manager``. Allows a callback to determine the font name and properties of a custom loaded font. Refer to documentation.
+
+*Added*: ``pyglet.font.get_custom_font_names``. Allows retrieval of loaded custom font family names.
+
+*Added*: ``pyglet.font.FontGroup``, allows setting up multiple fonts to act as one. See ``examples/text/font_groups.py``
+
+pyglet.text
+-----------
+*Changed*: ``Label.font_name`` will return the actual name of the font object, not the style name passed.
+
+pyglet.image
+------------
+Module was stripped down to CPU related image operations. All GPU related operations moved to pyglet.graphics.texture.
+
+*Moved*: Texture, TextureRegion, Texture3D, TextureArray, TextureArrayRegion, TextureGrid, CompressedTexture to pyglet.graphics.texture to
+create a separation of CPU ImageData from GPU Texture.
+
+*Removed*: ImageData.blit, use a Sprite or vertex list.
+
+*Removed*: TileableTexture as it has no use without a blit.
+
+*Removed*: S3TC software decoder. No longer relevant or used as all hardware supports the decoding now.
+
+*Added*: KTX2 format support for compressed images. Supports zlib supercompression and no-compression decoding. (Note: that zstandard supercompression requires the `zstandard` library.)
+
+*Deprecated*: `pyglet.image.ImageGrid.get_texture_sequence`. Use `pyglet.graphics.TextureGrid.from_image_grid(image_grid)` instead.
+
+pyglet.graphics.texture
+-----------------------
+*Changed*: ``Texture.blit_into`` renamed to ``Texture.upload`` to better specify that it's uploading and replacing data, not drawing an image.
+
+*Changed*: ``Texture.get_image_data` renamed to ``Texture.fetch`` to better specify that it's pulling pixel data from the GPU texture, and not an ``ImageData`` instance it may have been created with.
+
+*Added*: Support for instanced drawing. See example ``examples/graphics/instancing.py`` for usage.
+
+*Added*: Support for BC1-7 modern compression formats.
+
+*Added*: Support for legacy L and LA image formats to swizzle to the proper colors.
+
+pyglet.media
+------------
+*Changed*: `Player` has now been split into `AudioPlayer` and `VideoPlayer`.
+
+*Changed*: `VideoPlayer` now explicitly requires FFmpeg to be used.
+
+pyglet.graphics.group
+---------------------
+*Changed*: Groups now set their state by set of connector ``pyglet.graphics.state`` objects. This allows for better
+consolidation optimization, and for compatibility between multiple backends.
+
+pyglet.window
+-------------
+*Changed*: Window.set_mouse_visible has been renamed to Window.set_mouse_cursor_visible, and Window.set_mouse_platform_visible has been renamed to Window.set_mouse_cursor_platform_visible.
+
+*Added*: pyglet.window.dialog.FileOpenDialog and pyglet.window.dialog.FileSaveDialog to open OS file dialog windows.
+
+pyglet.input
+------------
+*Changed* Controllers now dispatch separate events for left/right sticks, and left/right triggers.
+
+other
+-----
+*Added*: Functionality for Pyglet browser implementations via WebGL and Pyodide. (Note that this is still experimental, and reliant on the Pyodide project. See the docs.)
+
+*Added*: Functionality for Windows 11 to change the window frame to Dark Mode based on the new Dark/Light theme settings.

pyglet-3.0.dev1/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.3
+Name: pyglet
+Version: 3.0.dev1
+Summary: pyglet is a cross-platform games and multimedia package.
+Author-email: Alex Holkner & contributors <Alex.Holkner@gmail.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Project-URL: Home, https://pyglet.org
+
+[![pypi](https://badge.fury.io/py/pyglet.svg)](https://pypi.python.org/pypi/pyglet) [![rtd](https://readthedocs.org/projects/pyglet/badge/?version=latest)](https://pyglet.readthedocs.io) [![PyTest](https://github.com/pyglet/pyglet/actions/workflows/unittests.yml/badge.svg)](https://github.com/pyglet/pyglet/actions/workflows/unittests.yml)
+
+![logo_large.png](https://github.com/pyglet/pyglet/blob/54a8c8b7e701b1692c6a10dd80f94ec837c27bd3/examples/opengl/pyglet.png?raw=true)
+
+# pyglet
+
+*pyglet* is a cross-platform windowing and multimedia library for Python, intended for developing games
+and other visually rich applications. It supports Windowing, input event handling, Controllers & Joysticks,
+OpenGL graphics, loading images and videos, and playing sounds and music. *pyglet* works on Windows, OS X and Linux.
+
+> :exclamation: :exclamation: A major pyglet update has just been released (v2.1). This brings many 
+> new exciting features, but also some necessary breaking changes. If your game/application has suddenly 
+> stopped working, please read the [migration section in the documentation](https://pyglet.readthedocs.io/en/latest/programming_guide/migration.html)
+> The previous version of pyglet is tracked in the `pyglet-2.0-maintenance` branch.
+> **If you want to do a pull request for the previous release, please target the appropriate branch**. 
+
+* pyglet [documentation]
+* pyglet on [PyPI]
+* pyglet [discord] server
+* pyglet [mailing list]
+* pyglet [issue tracker]
+* pyglet [website]
+
+pyglet has an active developer and user community.  If you find a bug or a problem with the documentation,
+please [open an issue](https://github.com/pyglet/pyglet/issues).
+Anyone is welcome to join our [discord] server where a lot of the development discussion is going on.
+It's also a great place to ask for help.
+
+Some features of pyglet are:
+
+* **No external dependencies or installation requirements.** For most application and game requirements, *pyglet*
+  needs nothing else besides Python, simplifying distribution and installation. It's easy to package and distribute
+  your project with [Nuitka](https://nuitka.net) or [PyInstaller](https://pyinstaller.org). 
+* **Take advantage of multiple windows and multi-monitor desktops.** *pyglet* allows you to use multiple
+  platform-native windows, and is fully aware of multi-monitor setups for use with fullscreen games.
+* **Load images, sound, music and video in almost any format.** *pyglet* can optionally use FFmpeg to play back
+  audio formats such as MP3, OGG/Vorbis and WMA, and video formats such as MPEG2, H.264, H.265, WMV and Xvid.
+  Without FFmpeg, *pyglet* contains built-in support for standard formats such as wav, png, bmp, and others.
+* **pyglet is written entirely in pure Python**, and makes use of the *ctypes* module to interface with system
+  libraries. You can modify the codebase or make a contribution without any second language compilation steps or
+  compiler setup. Despite being pure Python, *pyglet* has excellent performance thanks to advanced batching for
+  drawing thousands of objects.
+* **pyglet is provided under the BSD open-source license**, allowing you to use it for both commercial and other
+  open-source projects with very little restriction.
+
+## Requirements
+
+pyglet runs under Python 3.8+. Being written in pure Python, it also works on other Python interpreters such as PyPy. Supported platforms are:
+
+* Windows 7 or later
+* Mac OS X 10.3 or later
+* Linux, with the following libraries (most recent distributions will have
+  these in a default installation):
+  * OpenGL and GLX
+  * GDK 2.0+ or Pillow (required for loading images other than PNG and BMP)
+  * OpenAL or Pulseaudio (required for playing audio)
+
+**As of pyglet 2.0, OpenGL 3.3+ is required**. 
+
+To play a large variety of compressed audio and video files,
+pyglet can optionally take advantage of [FFmpeg](https://ffmpeg.org/).
+
+## Installation
+
+pyglet is installable from PyPI:
+
+    pip install --upgrade --user pyglet
+
+## Installation from source
+
+If you're reading this `README` from a source distribution, you can install pyglet with:
+
+    pip install --upgrade --user .
+    # or
+    python setup.py install --user
+
+You can also install the latest development version directly from Github:
+
+    pip install --upgrade --user https://github.com/pyglet/pyglet/archive/master.zip
+
+For local development install pyglet in editable mode:
+
+```bash
+# with pip
+pip install -e .
+# with setup.py
+python setup.py develop
+```
+
+There are no compilation steps during the installation; if you prefer,
+you can simply add this directory to your `PYTHONPATH` and use pyglet without
+installing it. You can also copy pyglet directly into your project folder.
+
+## Contributing
+
+**A good way to start contributing to a component of pyglet is by its documentation**. When studying the code you
+are going to work with, also read the associated docs. If you don't understand the code with the help of the docs,
+it is a sign that the docs should be improved. If you wish to make large changes to any part of pyglet, it's always
+a good idea to reach out for feedback first. This can avoid wasted effort in cases where someone is already working
+on something similar, or if your idea can't be accepted for any reason. 
+
+A basic outline of how to a contribution is as follows:
+
+* Fork the [official repository](https://github.com/pyglet/pyglet/fork).
+* In your fork, checkout the branch you wish to contribute to (such as *pyglet-1.5-maintenance*).
+* Apply your changes to your fork.
+* Submit a [pull request](https://github.com/pyglet/pyglet/pulls) describing the changes you have made.
+* Alternatively you can create a patch and submit it to the issue tracker.
+
+When making a pull request, check that you have addressed its respective documentation, both within the code docstrings
+and the programming guide (if applicable). It is very important to all of us that the documentation matches the latest
+code and vice versa.
+
+Consequently, an error in the documentation, either because it is hard to understand or because it doesn't match the
+code, is a bug that deserves to be reported on a ticket.
+
+## Building Docs
+
+[Documentation and Type Hints]: https://pyglet.readthedocs.io/en/latest/internal/doc.html
+
+To get started quickly:
+
+    pip install -r doc/requirements.txt
+    python make.py docs
+
+Please check [Documentation and Type Hints][] guide to learn more.
+
+## Testing
+
+pyglet makes use of pytest for its test suite.
+
+```bash
+pip install -r tests/requirements.txt --user
+# Only run unittests
+pytest tests/unit
+```
+
+Please check the [testing section in the development guide](https://pyglet.readthedocs.io/en/latest/internal/testing.html)
+for more information about running and writing tests.
+
+## Contact
+
+pyglet is developed by many individual volunteers, and there is no central point of contact. If you have a question
+about developing with pyglet, or you wish to contribute, please join the [discord] server, or [subreddit].
+
+For legal issues, please contact [Alex Holkner](mailto:Alex.Holkner@gmail.com).
+
+[discord]: https://discord.gg/QXyegWe
+[subreddit]: https://www.reddit.com/r/pyglet/
+[documentation]: https://pyglet.readthedocs.io
+[wiki]:  https://github.com/pyglet/pyglet/wiki
+[pypi]:  https://pypi.org/project/pyglet/
+[website]: http://pyglet.org/
+[issue tracker]: https://github.com/pyglet/pyglet/issues
+