pyglet 2.1.dev5__tar.gz → 2.1.dev7__tar.gz

{pyglet-2.1.dev5 → pyglet-2.1.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyglet
-Version: 2.1.dev5
+Version: 2.1.dev7
 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.dev5 → pyglet-2.1.dev7}/RELEASE_NOTES

@@ -1,3 +1,60 @@
+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
+------------------------
+- image: Use dedicated shader for blitting to fix blending issues. (#1170)
+- shapes: Add a way to set blend mode on initialization and after.
+- shapes: Add a get_shape_group function.
+- shapes: Add a way to change shape shader program.
+- pyglet.experimental: Add multi-texture sprite support. (#1166)
+- graphics.vertexbuffer: (internal) Rename buffer object `sub_data` to `commit` to better reflect it's usage. (#1186)
+- gui: Add on_mouse_enter/leave event handler to WidgetBase and use it in Buttons (#1190)
+- graphics.vertexdomain: Update program migration to its own function: update_shader.
+- graphics.vertexdomain: Changing programs no longer requires batch, as that doesn't change with a program change.
+- graphics.vertexdomain: Allow migration of shaders through deleting vertex lists.
+- graphics.vertexdomain: Remove `isinstance` check for VertexList and go off the class variable that is set.
+
+Bugfixes
+--------
+- image: Fix Texture3D.create_for_images method.
+- typing: Fix pyglet.options type checking.
+- shader: Fix UBO arrays. (#1168)
+- sprite: Fix paused animation frame index. (#1180)
+- window: win32: Fix Window.set_icon.best_icon. (#1183)
+- options: Fix audio and vsync env vars. (#1185)
+- audio: Remove `PreciseStreamingSource`; Move audio buffering back into Players. (#1175)
+
+
 pyglet 2.0.16
 
 Changes and Improvements

{pyglet-2.1.dev5 → pyglet-2.1.dev7}/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 ----------------------------------------
 
 
@@ -119,7 +121,7 @@ skip_modules = {"pyglet": {
                      "pyglet.lib": None,
                      "pyglet.libs": None,
                      "pyglet.app": implementations,
-                     "pyglet.canvas": implementations + ["xlib_vidmoderestore"],
+                     "pyglet.display": implementations + ["xlib_vidmoderestore"],
                      "pyglet.extlibs": None,
                      "pyglet.font": ["quartz",
                                      "win32",
@@ -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.dev5/doc/modules/canvas.rst → pyglet-2.1.dev7/doc/modules/display.rst

@@ -1,7 +1,7 @@
-pyglet.canvas
-=============
+pyglet.display
+==============
 
-.. automodule:: pyglet.canvas
+.. automodule:: pyglet.display
   :members:
   :undoc-members:
 

{pyglet-2.1.dev5 → pyglet-2.1.dev7}/doc/programming_guide/context.rst

@@ -11,7 +11,7 @@ Displays, screens, configs and contexts
 
 .. figure:: img/context_flow.png
 
-    Flow of construction, from the abstract Canvas to a newly
+    Flow of construction, from the abstract Display to a newly
     created Window with its Context.
 
 Contexts and configs
@@ -65,32 +65,32 @@ X11 remotely: the display device will support different configurations than the
 local driver.  Even a single video card on the local computer may support
 different configs for two monitors plugged in.
 
-In pyglet, a :class:`~pyglet.canvas.Display` is a collection of "screens"
+In pyglet, a :class:`~pyglet.display.Display` is a collection of "screens"
 attached to a single display device.  On Linux, the display device corresponds
 to the X11 display being used.  On Windows and Mac OS X, there is only one
 display (as these operating systems present multiple video cards as a single
 virtual device).
 
-The :mod:`pyglet.canvas` module provides access to the display(s). Use the
-:func:`~pyglet.canvas.get_display` function to get the default display::
+The :mod:`pyglet.display` module provides access to the display(s). Use the
+:func:`~pyglet.display.get_display` function to get the default display::
 
-    >>> display = pyglet.canvas.get_display()
+    >>> display = pyglet.display.get_display()
 
 .. note::
 
-    On X11, you can use the :class:`~pyglet.canvas.Display` class directly to
+    On X11, you can use the :class:`~pyglet.display.Display` class directly to
     specify the display string to use, for example to use a remotely connected
     display.  The name string is in the same format as used by the ``DISPLAY``
     environment variable::
 
-        >>> display = pyglet.canvas.Display(name=':1')
+        >>> display = pyglet.display.Display(name=':1')
 
     If you have multiple physical screens and you're using Xinerama, see
     :ref:`guide_screens` to select the desired screen as you would for Windows
     and Mac OS X. Otherwise, you can specify the screen number via the
     ``x_screen`` argument::
 
-        >>> display = pyglet.canvas.Display(name=':1', x_screen=1)
+        >>> display = pyglet.display.Display(name=':1', x_screen=1)
 
 .. _guide_screens:
 
@@ -112,11 +112,11 @@ In the following example the screens of a dual-head workstation are listed::
     XlibScreen(screen=0, x=0, y=0, width=1280, height=1024, xinerama=1)
 
 Because this workstation is running Linux, the returned screens are
-``XlibScreen``, a subclass of :class:`~pyglet.canvas.Screen`. The
+``XlibScreen``, a subclass of :class:`~pyglet.display.Screen`. The
 ``screen`` and ``xinerama`` attributes are specific to Linux, but the
-:attr:`~pyglet.canvas.Screen.x`, :attr:`~pyglet.canvas.Screen.y`,
-:attr:`~pyglet.canvas.Screen.width` and
-:attr:`~pyglet.canvas.Screen.height` attributes are present on all screens,
+:attr:`~pyglet.display.Screen.x`, :attr:`~pyglet.display.Screen.y`,
+:attr:`~pyglet.display.Screen.width` and
+:attr:`~pyglet.display.Screen.height` attributes are present on all screens,
 and describe the screen's geometry, as shown below.
 
 .. figure:: img/screens.png
@@ -126,11 +126,11 @@ and describe the screen's geometry, as shown below.
     particular user's preference.
 
 There is always a "default" screen, which is the first screen returned by
-:meth:`~pyglet.canvas.Display.get_screens`.  Depending on the operating system,
+:meth:`~pyglet.display.Display.get_screens`.  Depending on the operating system,
 the default screen is usually the one that contains the taskbar (on Windows) or
 menu bar (on OS X).
 You can access this screen directly using
-:meth:`~pyglet.canvas.Display.get_default_screen`.
+:meth:`~pyglet.display.Display.get_default_screen`.
 
 
 .. _guide_glconfig:
@@ -291,10 +291,10 @@ For example, to create a window with an alpha channel::
 
 It is sometimes necessary to create the context yourself, rather than letting
 the :class:`~pyglet.window.Window` constructor do this for you.  In this case
-use :meth:`~pyglet.canvas.Screen.get_best_config` to obtain a "complete"
+use :meth:`~pyglet.display.Screen.get_best_config` to obtain a "complete"
 config, which you can then use to create the context::
 
-    display = pyglet.canvas.get_display()
+    display = pyglet.display.get_display()
     screen = display.get_default_screen()
 
     template = pyglet.gl.Config(alpha_size=8)
@@ -308,7 +308,7 @@ Note that you cannot create a context directly from a template (any
 above to create the context if a template config is given.
 
 Not all configs will be possible on all machines.  The call to
-:meth:`~pyglet.canvas.Screen.get_best_config` will raise
+:meth:`~pyglet.display.Screen.get_best_config` will raise
 :class:`~pyglet.window.NoSuchConfigException` if the hardware does not
 support the requested attributes.  It will never return a config that does not
 meet or exceed the attributes you specify in the template.
@@ -333,7 +333,7 @@ sufficient for most applications, however some complex programs may want to
 specify their own algorithm for selecting a set of OpenGL attributes.
 
 You can enumerate a screen's configs using the
-:meth:`~pyglet.canvas.Screen.get_matching_configs` method. You must supply a
+:meth:`~pyglet.display.Screen.get_matching_configs` method. You must supply a
 template as a minimum specification, but you can supply an "empty" template
 (one with no attributes set) to get a list of all configurations supported by
 the screen.
@@ -341,7 +341,7 @@ the screen.
 In the following example, all configurations with either an auxiliary buffer
 or an accumulation buffer are printed::
 
-    display = pyglet.canvas.get_display()
+    display = pyglet.display.get_display()
     screen = display.get_default_screen()
 
     for config in screen.get_matching_configs(gl.Config()):

{pyglet-2.1.dev5 → pyglet-2.1.dev7}/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.dev5 → pyglet-2.1.dev7}/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.dev5 → pyglet-2.1.dev7}/doc/programming_guide/migration.rst

@@ -43,14 +43,14 @@ Shapes
 For consistency with the rest of the library, it was decided to represent
 all angles in degrees instead of radians. Previously we had a mix of both,
 which lead to some confusion. Using degrees also makes the API consistent
-with Sprites and other rotatable objects.
+with Sprites and other rotatable objects, which have long used degrees.
 
 The arguments for :py:class:`~pyglet.shapes.Line` have changed slightly.
 Instead of "width", we now use "thickness". This matches with other shapes
 that are made up of line segments. For example the :py:class:`~pyglet.shapes.Box`
 shape, which already uses "width" (and height) to mean it's overall size.
 Going forward, any shape that is made up of lines should use `thickness`
-for the width of those lines.
+for the thickness/width of those lines.
 
 Controllers
 -----------
@@ -77,12 +77,18 @@ You now get a Vec2 instead of booleans that can be used directly::
         # Easily normalize for diagonal values:
         player_position += vector.normalize() * PLAYER_SPEED
 
+This should be more efficient in most cases. If you want to access the values
+as booleans for a quick workaround when migrating, you can do something like this::
+
+    dpleft, dpright, dpup, dpdown = vector.x < 0, vector.x > 0, vector.y > 0 vector.y < 0
+
+
 Vectors can also be useful for analog sticks, because it gives an easy way to
-calculate dead-zones using `abs`. For example::
+calculate dead-zones using `.length()`. For example::
 
     @controller.event
     def on_stick_motion(controller, name, vector):
-        if abs(vector) <= DEADZONE:
+        if vector.length() <= DEADZONE:
             return
         elif name == "leftstick":
             # Do something with the 2D vector
@@ -101,7 +107,6 @@ attributes. See :py:class:`~pyglet.math.Vec2` for more details on vector types.
 
 Gui
 ---
-
 All widget events now dispatch the widget instance itself as the first argument.
 This is similar to how Controller/Joystick events are implemented. In cases where
 the same handler function is set to multiple widgets, this gives a way to determine
@@ -115,19 +120,33 @@ Math module
 -----------
 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 are now hashable. This has performance benefits, and matches how the Matrix
-types are implemented. For all intents and purposes, the Vec types can be treated
-as tuples.
+immutable; all operations will return a new object. In addition, all vector objects
+are now hashable. This has performance and usability benefits. For most purposes,
+the Vec types can be treated as (named) tuples.
+
+The :py:class:`~pyglet.math.Mat3` & :py:class:`~pyglet.math.Mat4` class have been
+changed to be ``NamedTuple`` subclasses instead of ``tuple`` subclasses. This is
+consistent with the vector types, and makes for a cleaner code base. There is one
+small change due to this. Previously, creating a matrix from values required
+passing in a list or tuple of values. Now, you simply provide the values (the same
+way as vectors). For example:
+
+    # old way:
+    my_mat4 = pyglet.math.Mat4([1, 2, 3, 4, 5, ...])
+    # new way:
+    my_mat4 = pyglet.math.Mat4(1, 2, 3, 4, 5, ...)
+
+Matrix objects are generally created via their helper methods, so this change should
+hopefully not require any code updates for most users.
 
 Canvas module
 -------------
-The `pyglet.canvas` module has been renamed to `pyglet.display`, as the canvas
-concept was never fully fleshed out. The canvas concept appears to have been
-meant to allow arbitrary renderable areas. This 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, minus the
-name change::
+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`
+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::
 
     my_display = pyglet.canvas.get_display()     # old pyglet 2.0
     my_display = pyglet.display.get_display()    # new pyglet 2.1

{pyglet-2.1.dev5 → pyglet-2.1.dev7}/doc/programming_guide/windowing.rst

@@ -44,10 +44,12 @@ ways to control the context that is created:
       window = pyglet.window.Window(context=context)
 
 * Supply a complete :py:class:`~pyglet.gl.Config` obtained from a
-  :py:class:`~pyglet.canvas.Screen` using the ``config``
+  :py:class:`~pyglet.display.Screen` using the ``config``
   argument.  The context will be created from this config and will share object
   space with the most recently created existing context::
 
+      display = pyglet.display.get_display()
+      screen = display.get_default_screen()
       config = screen.get_best_config(template)
       window = pyglet.window.Window(config=config)
 
@@ -58,14 +60,15 @@ ways to control the context that is created:
       config = gl.Config(double_buffer=True)
       window = pyglet.window.Window(config=config)
 
-* Specify a :py:class:`~pyglet.canvas.Screen` using the ``screen`` argument.
+* Specify a :py:class:`~pyglet.display.Screen` using the ``screen`` argument.
   The context will use a config created from default template configuration
   and this screen::
 
+      display = pyglet.display.get_display()
       screen = display.get_screens()[screen_number]
       window = pyglet.window.Window(screen=screen)
 
-* Specify a :py:class:`~pyglet.canvas.Display` using the ``display`` argument.
+* Specify a :py:class:`~pyglet.display.Display` using the ``display`` argument.
   The default screen on this display will be used to obtain a context using
   the default template configuration::
 
@@ -73,7 +76,7 @@ ways to control the context that is created:
       window = pyglet.window.Window(display=display)
 
 If a template :py:class:`~pyglet.gl.Config` is given, a
-:py:class:`~pyglet.canvas.Screen` or :py:class:`~pyglet.canvas.Display`
+:py:class:`~pyglet.display.Screen` or :py:class:`~pyglet.display.Display`
 may also be specified; however any other combination of parameters
 overconstrains the configuration and some parameters will be ignored.