Skip to content

Commit

Permalink
docs: Clarify update behaviour in display docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ankith authored and illume committed Dec 26, 2021
1 parent bc0eb39 commit 11ade32
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/reST/ref/display.rst
Expand Up @@ -242,6 +242,9 @@ required).
instead of the entire area. If no argument is passed it updates the entire
Surface area like ``pygame.display.flip()``.

Note that calling ``display.update(None)`` means no part of the window is
updated. Whereas ``display.update()`` means the whole window is updated.

You can pass the function a single rectangle, or a sequence of rectangles.
It is more efficient to pass many rectangles at once than to call update
multiple times with single or a partial list of rectangles. If passing a
Expand Down

0 comments on commit 11ade32

Please sign in to comment.