@@ -56,25 +56,27 @@ class SpriteList(Generic[SpriteType]):
5656 SpriteList supports batch operations on sprites, especially drawing
5757
5858 :py:meth:`.SpriteList.draw` is the best way to draw sprites. See
59- :ref:`pg_spritelists_why` for more information on why.
59+ :ref:`pg_spritelists_why` for an explanation of why.
6060
6161 Experienced developers may also want to see :ref:`pg_spritelists_advanced`.
6262
6363 :param bool use_spatial_hash: Set this to ``True`` for
6464 :ref:`faster collision checking & slower changes <pg_spritelists_spatial_hashing>`
65- :param int spatial_hash_cell_size: The cell size of the spatial hash
66- in pixels, if enabled (default: 128).
67- :param TextureAtlas atlas: :ref:`Override the default/global atlas <pg_spritelist_lazy_spritelists>`
65+ :param int spatial_hash_cell_size: The cell size of the internal
66+ :ref:`spatial hash <pg_spritelists_spatial_hashing>` in
67+ pixels, if enabled (default: 128).
68+ :param TextureAtlas atlas: :ref:`Override the default/global atlas <pg_spritelist_texture_atlases>`
6869 for this SpriteList.
6970 :param int capacity: The initial capacity of the internal
7071 buffer. The default of 100 is usually ok, but you can change
7172 it when you know a list will be much larger or smaller.
72- :param bool lazy: Set this to True to delay creating OpenGL
73- resources until the 1st draw or :py:meth:`~.SpriteList.initialize`
74- is called. See the :ref:`Programming Guide <pg_spritelist_lazy_spritelists>`
75- for more information on when & how to use this.
76- :param bool visible: When this is False, calling draw on this list
77- will do nothing.
73+ :param bool lazy: Set this to ``True`` to delay creating OpenGL
74+ resources until forced to. Use :py:meth:`~.SpriteList.initialize`
75+ to manually create them. See the :ref:`pg_spritelist_lazy_spritelists`
76+ for more information.
77+ :param bool visible: When ``False``, calling :py:meth:`.SpriteList.draw`
78+ on this list will do nothing until :py:attr:`SpriteList.visible`
79+ is set to ``True``.
7880 """
7981
8082 def __init__ (
@@ -1056,12 +1058,12 @@ def draw(self, *, filter: Optional[int] = None, pixelated: bool = False, blend_f
10561058 """
10571059 Draw this SpriteList into the current OpenGL context.
10581060
1059- By default, SpriteLists draw starting from their lowest index
1060- toward their highest.
1061+ If :py:attr:`.SpriteList.visible` is ``False``, this method
1062+ has no effect. Otherwise, contained :py:class:`~arcade.Sprite` instances
1063+ will be drawn from the lowest index to the highest.
10611064
1062- For the best results when using pixel art, use
1063- ``pixelated=True`` and follow the advice of the
1064- :ref:`Programming Guide's article on edge artifacts <edge_artifacts>`.
1065+ When using pixel art, use ``pixelated=True`` and follow the advice of the
1066+ :ref:`guide on eliminating edge artifacts <edge_artifacts>`.
10651067
10661068 :param filter: Set a custom OpenGL filter, such as ``gl.GL_NEAREST``
10671069 to avoid smoothing.
0 commit comments