TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-09-28 15:53:55 -04:00
Code Issues Packages Projects Releases Wiki Activity

display: Update docstring for WindowProperties::set_mouse_mode()

Browse Source 
[skip ci]

Fixes #1307
This commit is contained in:
rdb 2022-05-19 10:00:37 +02:00
parent 671b16eb41
commit 36e34294cf
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
panda/src/display/windowProperties.I
View File

@ -679,19 +679,18 @@ clear_z_order() {
* mouse can move outside the window and the mouse coordinates are relative to
* its position in the window.
*
* M_relative (OSX or Unix/X11 only): a mode where only relative movements are
* reported; particularly useful for FPS-style mouse movements where you have
* hidden the mouse pointer and are are more interested in how fast the mouse
* is moving, rather than precisely where the pointer is hovering.
*
* This has no effect on Windows. On Unix/X11, this requires the Xxf86dga
* extension to be available.
*
* M_confined: this mode reports absolute mouse positions, but confines the
* mouse pointer to the window boundary. It can portably replace M_relative
* for an FPS, but you need to periodically move the pointer to the center of
* the window and track movement deltas.
* mouse pointer to the window boundary. The reported mouse positions will
* never be outside of the window boundary.
*
* M_relative: a mode where only relative movements are reported; particularly
* useful for FPS-style mouse movements where you have hidden the mouse
* pointer and are are more interested in how fast the mouse is moving, rather
* than precisely where the pointer is hovering. The reported positions still
* appear to be absolute, but they can go toward negative or positive infinity
* without being constrained by the window (or screen) dimensions. Since the
* position of the mouse cursor becomes meaningless in this mode, it is
* recommended to combine this with the cursor_hidden flag.
*/
INLINE void WindowProperties::
set_mouse_mode(MouseMode mode) {