Skip to content

Commit 7405ce6

Browse files
authored
Add/alter docs for flip
1 parent 4da1c78 commit 7405ce6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/reST/ref/window.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -275,12 +275,12 @@
275275
| :sl:`Update the display surface to the window.`
276276
| :sg:`flip() -> None`
277277
278-
Update content from the display surface to the window. This is the Window
278+
Update pixel data from memory to be displayed in the window. This is the Window
279279
class equivalent of :func:`pygame.display.flip`.
280280

281-
This method allows software rendering (classic pygame rendering) on top
282-
of the Window API. This method should not be called when using hardware
283-
rendering (coming soon).
281+
With ``get_surface()`` this method allows software rendering (classic pygame rendering) flipping pixel data
282+
from an associated surface in memory to be displayed in the window. Alternatively, when this window has an
283+
associated OpenGL context, this method will instead perform a GL buffer swap to the window.
284284

285285
Here is a runnable example of using ``get_surface`` and ``flip``:
286286

0 commit comments

Comments
 (0)