Skip to content

Commit bb54ae5

Browse files
committed
Clarify mouse behaviour for Window.relative_mouse
1 parent b0b88d8 commit bb54ae5

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

docs/reST/ref/sdl2_video.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,8 @@
123123

124124
*This function will flush any pending mouse motion."*
125125

126-
If :func:`pygame.mouse.set_visible` was called with ``True`` the input
127-
will be grabbed, and the mouse will enter endless relative motion mode.
128-
126+
Calling :func:`pygame.mouse.set_visible` with argument
127+
``True`` will exit relative mouse mode.
129128

130129
.. attribute:: title
131130

src_c/cython/pygame/_sdl2/video.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -295,8 +295,8 @@ cdef class Window:
295295
296296
*This function will flush any pending mouse motion."*
297297
298-
If :func:`pygame.mouse.set_visible` was called with ``True`` the input
299-
will be grabbed, and the mouse will enter endless relative motion mode.
298+
Calling :func:`pygame.mouse.set_visible` with argument
299+
``True`` will exit relative mouse mode.
300300
"""
301301
return SDL_GetRelativeMouseMode()
302302

0 commit comments

Comments
 (0)