pyglet 2.1.dev6__tar.gz → 2.1rc1__tar.gz

{pyglet-2.1.dev6 → pyglet-2.1rc1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyglet
-Version: 2.1.dev6
+Version: 2.1rc1
 Summary: pyglet is a cross-platform games and multimedia package.
 Author-email: Alex Holkner & contributors <Alex.Holkner@gmail.com>
 Requires-Python: >=3.8

{pyglet-2.1.dev6 → pyglet-2.1rc1}/RELEASE_NOTES

@@ -1,3 +1,33 @@
+pyglet 2.0.18
+
+Changes and Improvements
+------------------------
+- shader: add support for OpenGL structures in UBO's (#1212)
+- win32.com: get libs/win32/com.py ready for incoming 3.13 changes #1199
+- docs: fix various typos, and example code to align with docs #1200, #1201
+- text.document: add new AbstractDocument.append_text method for more efficient end-of-text additions #1182
+- tests: fix issues with broken tests on macOS.
+- input.macos: add missing axis alias for modern controllers (Stadia, newer XBOX One)
+- gui.NinePatch: Add a new NinePatch.create_around_layout class method
+- typing: add py.typed file #1205
+
+Bugfixes
+--------
+- shader: fix matrix uniform assignment #1194
+- text: fix missing caret top level import
+- text.layout: fix updating anchor on the X axis #1213
+- text.layout: move get_line_count function into the base TextLayout class
+- window.macos: fix blinking cursor in bottom left of window #1204
+- examples: fix rectangle not appearing in text_input example
+- macos: fix missing dealloc for text view.
+- macos: fix some deallocation issues when creating multiple windows.
+- macos: fix event loop termination exiting the entire app.
+- macos: fix focus being stolen by other apps during launch. (#1211)
+- macos: fix error about pygletUpdate when closing a window. (#1219)
+- macos: fix function keys not registering. (#1220)
+- docs: move check for `sys.modules['sphinx']` into doc/conf.py to prevent conflicts with jupyter #1215
+
+
 pyglet 2.0.17
 
 Changes and Improvements

{pyglet-2.1.dev6 → pyglet-2.1rc1}/doc/conf.py

@@ -2,11 +2,12 @@
 # pyglet documentation build configuration file.
 #
 # This file is execfile()d with the current directory set to its containing dir.
-import datetime
 import os
 import sys
 import time
 import typing
+import datetime
+
 from typing import TypeVar
 
 import sphinx_autodoc_typehints
@@ -31,7 +32,7 @@ def parse_attributes_section(self, section):
             _type = self._lookup_annotation(_name)
             if _name in self._annotations:
                 _type = sphinx_autodoc_typehints.add_type_css_class(
-                   sphinx_autodoc_typehints.format_annotation(self._annotations[_name], self._app.config))
+                    sphinx_autodoc_typehints.format_annotation(self._annotations[_name], self._app.config))
 
         field = self._format_field(_name, _type, _desc)
         if multi:
@@ -48,12 +49,15 @@ def parse_attributes_section(self, section):
 
 GoogleDocstring._parse_attributes_section = parse_attributes_section
 
+
 # Unpatch... the patch.
 def _revert_patch():
     pass
 
+
 sphinx_autodoc_typehints.patches._patch_google_docstring_lookup_annotation = _revert_patch
 
+
 # Patch to fix our RST insertion issues.
 class _RstSnippetParser(RSTParser):
     @staticmethod
@@ -63,13 +67,14 @@ class _RstSnippetParser(RSTParser):
 
 sphinx_autodoc_typehints.parser.RSTParser = _RstSnippetParser
 
+
 def write_build(data, filename):
     with open(os.path.join("internal", filename), "w") as f:
         f.write(".. list-table::\n")
         f.write("   :widths: 50 50\n")
         f.write("\n")
         for var, val in data:
-            f.write("   * - "+var+"\n     - "+val+"\n")
+            f.write("   * - " + var + "\n     - " + val + "\n")
 
 
 sys.is_pyglet_doc_run = True
@@ -82,17 +87,14 @@ sys.path.insert(0, os.path.abspath("."))
 # import the pyglet package.
 sys.path.insert(0, os.path.abspath(".."))
 
-
 try:
     import pyglet
+
     print(f"Generating pyglet {pyglet.version} Documentation")
 except ImportError:
     print("ERROR: pyglet not found")
     sys.exit(1)
 
-
-
-
 # -- PYGLET DOCUMENTATION CONFIGURATION ----------------------------------------
 
 
@@ -150,7 +152,6 @@ skip_modules = {"pyglet": {
                         },
                 }
 
-
 now = datetime.datetime.fromtimestamp(time.time())
 build_data = (("Date", now.strftime("%Y/%m/%d %H:%M:%S")),
               ("pyglet version", pyglet.version))
@@ -227,19 +228,19 @@ release = pyglet.version
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ["_build", "_templates", "api"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
@@ -247,7 +248,7 @@ add_module_names = False
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
@@ -255,7 +256,6 @@ pygments_style = "sphinx"
 # A list of ignored prefixes for module index sorting.
 modindex_common_prefix = ["pyglet."]
 
-
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -265,7 +265,7 @@ html_theme = "sphinx_rtd_theme"
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Force custom css to allow multiline inits.
 html_css_files = [
@@ -299,18 +299,18 @@ html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
 html_domain_indices = True
@@ -325,62 +325,61 @@ html_split_index = True
 html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = "pygletdoc"
 
-
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ("index", "pyglet.tex", "pyglet Documentation",
-   "Alex Holkner", "manual"),
+    ("index", "pyglet.tex", "pyglet Documentation",
+     "Alex Holkner", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
@@ -393,7 +392,7 @@ man_pages = [
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -402,24 +401,25 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ("index", "pyglet", "pyglet Documentation",
-   "Alex Holkner", "pyglet", "One line description of project.",
-   "Miscellaneous"),
+    ("index", "pyglet", "pyglet Documentation",
+     "Alex Holkner", "pyglet", "One line description of project.",
+     "Miscellaneous"),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
 
 python_maximum_signature_line_length = 85
 
 nitpicky = True
 
+
 def custom_formatter(annotation, config):
     # Fixes TypeVar bounds, where the bound reference is forward referenced and class cannot be determined.
     # Defaults to a class style. Seems good enough for now since most bound things are classes.
@@ -447,4 +447,5 @@ def custom_formatter(annotation, config):
         return f":py:class:`TypeVar` {formatted_args}"
     return None
 
+
 typehints_formatter = custom_formatter

{pyglet-2.1.dev6 → pyglet-2.1rc1}/doc/index.rst

@@ -50,10 +50,11 @@ If you are migrating from an older version of pyglet, please read through
    programming_guide/keyboard
    programming_guide/mouse
    programming_guide/input
-   programming_guide/shapes
    programming_guide/image
-   programming_guide/media
    programming_guide/text
+   programming_guide/media
+   programming_guide/shapes
+   programming_guide/models
    programming_guide/resources
    programming_guide/rendering
    programming_guide/events

pyglet-2.1rc1/doc/modules/models.rst

@@ -0,0 +1,6 @@
+pyglet.model
+============
+
+.. automodule:: pyglet.model
+  :members:
+  :undoc-members:

{pyglet-2.1.dev6 → pyglet-2.1rc1}/doc/programming_guide/events.rst

@@ -14,7 +14,7 @@ base class. Many of pyglet's built-in modules, such as :py:mod:`pyglet.window`,
 :py:mod:`pyglet.gui` and others make use of this pattern. You can also reuse this in
 your own classes easily.
 
-Even handlers are simply functions or methods that are written to accept the same
+Event handlers are simply functions or methods that are written to accept the same
 arguments as the dispatched event. Event handlers can be registered or unregistered
 during runtime. More than one handler can be registered to receive the same events,
 which is described in the following sections. Event dispatchers can *optionally* have
@@ -27,7 +27,7 @@ Setting event handlers
 
 For an example, lets look at the :py:class:`~pyglet.window.Window` class.
 :py:class:`~pyglet.window.Window` subclasses :py:class:`~pyglet.event.EventDispatcher`
-and, being an Window, has a variety of different events which it dispatches.
+and, being a Window, has a variety of different events which it dispatches.
 For instance, the :py:meth:`pyglet.window.Window.on_resize` event. Every time a
 resizeable Window is resized (and once when first created), this event is dispatched
 with two parameters: ``(width, height)``. Therefore, an event handler for this event

{pyglet-2.1.dev6 → pyglet-2.1rc1}/doc/programming_guide/examplegame.rst

@@ -119,9 +119,9 @@ Making the labels
 
 To make a text label in pyglet, just initialize a :class:`pyglet.text.Label` object::
 
-    score_label = pyglet.text.Label(text="Score: 0", x=10, y=460)
+    score_label = pyglet.text.Label(text="Score: 0", x=10, y=575)
     level_label = pyglet.text.Label(text="My Amazing Game",
-                                x=game_window.width//2, y=game_window.height//2, anchor_x='center')
+                                x=game_window.width//2, y=575, anchor_x='center')
 
 Notice that the second label is centered using the anchor_x attribute.
 

{pyglet-2.1.dev6 → pyglet-2.1rc1}/doc/programming_guide/migration.rst

@@ -12,7 +12,10 @@ are having an issue that is not covered here, please open up an issue ticket on
 
 Window "HiDPI" support
 ----------------------
-TBD
+The v2.1 release now provides a lot more control over how modern 'HiDPI' displays
+are treated. This includes "retina" displays, or any display that has a non-0% zoom
+or scale (such as 4K displays). This is exposed as new pyglet options. See
+``pyglet.options.dpi_scaling`` for more information.
 
 Labels & Text Layouts
 ---------------------
@@ -84,7 +87,7 @@ as booleans for a quick workaround when migrating, you can do something like thi
 
 
 Vectors can also be useful for analog sticks, because it gives an easy way to
-calculate dead-zones using `.length()`. For example::
+calculate dead-zones using ``.length()``. For example::
 
     @controller.event
     def on_stick_motion(controller, name, vector):
@@ -102,8 +105,8 @@ that the maximum value stays within range. For example::
 
             vector = min(vector, vector.normalize())
 
-You can also of course directly access the individual `Vec2.x` & `Vec2.y`
-attributes. See :py:class:`~pyglet.math.Vec2` for more details on vector types.
+You can also of course directly access the individual ``Vec2.x`` & ``Vec2.y`` attributes,
+if you want to . See :py:class:`~pyglet.math.Vec2` for more details on vector types.
 
 Gui
 ---
@@ -116,8 +119,8 @@ The :py:class:`~pyglet.gui.widget.ToggleButton` and :py:class:`~pyglet.gui.widge
 widgets have a small change. Instead of the image arguments being named "pressed"
 and "depressed", they has been renamed to the correct "pressed" and "unpressed".
 
-Math module
------------
+Math
+----
 In the :py:mod:`~pyglet.math` module, vector types (:py:class:`~pyglet.math.Vec2`,
 :py:class:`~pyglet.math.Vec3`, :py:class:`~pyglet.math.Vec4`) are now
 immutable; all operations will return a new object. In addition, all vector objects
@@ -139,12 +142,23 @@ way as vectors). For example:
 Matrix objects are generally created via their helper methods, so this change should
 hopefully not require any code updates for most users.
 
+Models
+------
+The :py:mod:`~pyglet.model` module has seen some changes. This is an undocumented
+WIP module for pyglet 2.0, and it remains so pyglet 2.1. That said, it's in a more
+usable state now. The first change is that :py:meth:`~pyglet.model.load` now returns
+a ``Scene`` object instead of a ``Model`` object. The Scene is a new, "pure data"
+intermediate representation of a 3D scene, that closely mimics the layout of the glTF
+format. The :py:meth:`~pyglet.model.Scene.create_models` method can be used to create
+``Model`` instances from the Scene, but the Scene data can also be manually iterated
+over for more advanced use cases.
+
 Canvas module
 -------------
-The `pyglet.canvas` module has been renamed to `pyglet.display`. The "canvas"
+The ``pyglet.canvas`` module has been renamed to ``pyglet.display``. The "canvas"
 concept was a work-in-progress in legacy pyglet, and was never fully fleshed out.
 It appears to have been meant to allow arbitrary renderable areas, but this type
-of functionality can now be easily accomplished with Framebuffers. The name `display`
+of functionality can now be easily accomplished with Framebuffers. The name ``display``
 is a more accurate representation of what the code in the module actually relates to.
 The usage is the same, with just the name change::
 

pyglet-2.1rc1/doc/programming_guide/models.rst

@@ -0,0 +1,10 @@
+.. _guide_models:
+
+3D Models and Scenes
+====================
+
+The :py:mod:`~pyglet.model` module is still a work in progress, and is
+not yet documented.
+
+TBD
+---

{pyglet-2.1.dev6 → pyglet-2.1rc1}/examples/dpi_scaled_window.py

@@ -71,10 +71,25 @@ def on_resize(width, height):
     hello_label.position = (window.width // 2, window.height // 2, 0)
 
 
+screens = pyglet.display.get_display().get_screens()
+selected_screen = screens[0]
+
 @window.event
 def on_key_press(symbol, modifiers):
+    global selected_screen
+    if len(screens) > 1:
+        if symbol == pyglet.window.key._1:
+            selected_screen = screens[1]
+        elif symbol == pyglet.window.key._0:
+            selected_screen = screens[0]
+    
     if symbol == pyglet.window.key.SPACE:
         window.set_size(500, 300)
+    elif symbol == pyglet.window.key.F:
+        window.set_fullscreen(False, screen=selected_screen)
+    elif symbol == pyglet.window.key.G:
+        window.set_fullscreen(True, screen=selected_screen)
+        
 
 
 @window.event

{pyglet-2.1.dev6 → pyglet-2.1rc1}/examples/model/fpscamera.py

@@ -10,17 +10,16 @@ to your needs for first person games.
 """
 
 from __future__ import annotations
+
 import weakref
-from pathlib import Path
+
 from math import radians, degrees
 
 import pyglet
-from pyglet.window import key as _key
 
 from pyglet.gl import glEnable, GL_DEPTH_TEST, GL_CULL_FACE
 from pyglet.math import Vec2, Vec3, Mat4, clamp
-
-MODULE_PATH = Path(__file__).parent
+from pyglet.window import key as _key
 
 
 class FPSCamera:
@@ -346,8 +345,8 @@ if __name__ == "__main__":
     glEnable(GL_DEPTH_TEST)
     glEnable(GL_CULL_FACE)
 
-    model_logo = pyglet.model.load(MODULE_PATH / "logo3d.obj", batch=batch)
-    model_box = pyglet.model.load(MODULE_PATH / "box.obj", batch=batch)
+    model_logo = pyglet.resource.model("logo3d.obj", batch=batch)
+    model_box = pyglet.resource.model("box.obj", batch=batch)
 
     # Camera controls the global projection & view matrixes:
     camera = FPSCamera(window, position=Vec3(0.0, 0.0, 5.0))

{pyglet-2.1.dev6 → pyglet-2.1rc1}/examples/model/model.py

@@ -44,8 +44,10 @@ if __name__ == "__main__":
     glEnable(GL_DEPTH_TEST)
     glEnable(GL_CULL_FACE)
 
-    model_logo = pyglet.resource.model("logo3d.obj", batch=batch)
-    model_box = pyglet.resource.model("box.obj", batch=batch)
+    logo_scene = pyglet.resource.scene('logo3d.obj')
+    box_scene = pyglet.resource.scene('box.obj')
+    model_logo = logo_scene.create_models(batch=batch)[0]   # only one model in this scene
+    model_box = box_scene.create_models(batch=batch)[0]     # only one model in this scene
 
     # Set the application wide view matrix (camera):
     window.view = Mat4.look_at(position=Vec3(0, 0, 5), target=Vec3(0, 0, 0), up=Vec3(0, 1, 0))

{pyglet-2.1.dev6 → pyglet-2.1rc1}/pyglet/__init__.py

@@ -15,7 +15,7 @@ if TYPE_CHECKING:
     from typing import Any, Callable, ItemsView, Sized
 
 #: The release version
-version = '2.1.dev6'
+version = '2.1.rc1'
 __version__ = version
 
 MIN_PYTHON_VERSION = 3, 8
@@ -25,9 +25,6 @@ if sys.version_info < MIN_PYTHON_VERSION:
     msg = f"pyglet {version} requires Python {MIN_PYTHON_VERSION_STR} or newer."
     raise Exception(msg)
 
-if "sphinx" in sys.modules:
-    sys.is_pyglet_doc_run = True
-
 # pyglet platform treats *BSD systems as Linux
 compat_platform = sys.platform
 if "bsd" in compat_platform:
@@ -250,7 +247,7 @@ class Options:
 
     .. versionadded:: 2.0.5"""
 
-    dpi_scaling: Literal["real", "scaled", "stretch"] = "real"
+    dpi_scaling: Literal["real", "scaled", "stretch", "platform"] = "real"
     """For 'HiDPI' displays, Window behavior can differ between operating systems. Defaults to `'real'`.
 
     The current options are an attempt to create consistent behavior across all of the operating systems.
@@ -273,6 +270,13 @@ class Options:
     rescaling and repositioning of content will be necessary, but at the cost of blurry content depending on the extent
     of the stretch. For example, 800x600 at 150% DPI will be 800x600 for `window.get_size()` and 1200x900 for
     `window.get_framebuffer_size()`.
+    
+    `'platform'`: A DPI aware window is created, however window sizing and framebuffer sizing is not interfered with
+    by Pyglet. Final sizes are dictated by the platform the window was created on. It is up to the user to make any
+    platform adjustments themselves such as sizing on a platform, mouse coordinate adjustments, or framebuffer size
+    handling. On Windows and X11, the framebuffer and the requested window size will always match in pixels 1:1. On
+    MacOS, depending on a Hi-DPI display, you may get a different sized framebuffer than the window size. This option
+    does allow `window.dpi` and `window.scale` to return their respective values.
     """
 
     shader_bind_management: bool = True

{pyglet-2.1.dev6 → pyglet-2.1rc1}/pyglet/__init__.pyi

@@ -63,7 +63,6 @@ class Options:
     com_mta: bool
     osx_alt_loop: bool
     dpi_scaling: Literal["real", "scaled", "stretch"]
-    scale_with_dpi: bool
     shader_bind_management: bool
 
     def get(self, item: str, default: Any = None) -> Any:

{pyglet-2.1.dev6 → pyglet-2.1rc1}/pyglet/app/__init__.py

@@ -68,7 +68,7 @@ the set when they are no longer referenced or are closed explicitly.
 """
 
 
-def run(interval: float | None = 1/60) -> None:
+def run(interval: float | None = 1 / 60) -> None:
     """Begin processing events, scheduled functions and window updates.
 
     This is a convenience function, equivalent to::