File: mouse_doc.h

package info (click to toggle)
pygame 2.6.1-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 43,076 kB
  • sloc: ansic: 66,932; python: 48,797; javascript: 1,153; objc: 224; sh: 121; makefile: 59; cpp: 25
file content (61 lines) | stat: -rw-r--r-- 2,387 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMEMOUSE "pygame module to work with the mouse"
#define DOC_PYGAMEMOUSEGETPRESSED "get_pressed(num_buttons=3) -> (button1, button2, button3)\nget_pressed(num_buttons=5) -> (button1, button2, button3, button4, button5)\nget the state of the mouse buttons"
#define DOC_PYGAMEMOUSEGETPOS "get_pos() -> (x, y)\nget the mouse cursor position"
#define DOC_PYGAMEMOUSEGETREL "get_rel() -> (x, y)\nget the amount of mouse movement"
#define DOC_PYGAMEMOUSESETPOS "set_pos([x, y]) -> None\nset the mouse cursor position"
#define DOC_PYGAMEMOUSESETVISIBLE "set_visible(bool) -> bool\nhide or show the mouse cursor"
#define DOC_PYGAMEMOUSEGETVISIBLE "get_visible() -> bool\nget the current visibility state of the mouse cursor"
#define DOC_PYGAMEMOUSEGETFOCUSED "get_focused() -> bool\ncheck if the display is receiving mouse input"
#define DOC_PYGAMEMOUSESETCURSOR "set_cursor(pygame.cursors.Cursor) -> None\nset_cursor(size, hotspot, xormasks, andmasks) -> None\nset_cursor(hotspot, surface) -> None\nset_cursor(constant) -> None\nset the mouse cursor to a new cursor"
#define DOC_PYGAMEMOUSEGETCURSOR "get_cursor() -> pygame.cursors.Cursor\nget the current mouse cursor"


/* Docs in a comment... slightly easier to read. */

/*

pygame.mouse
pygame module to work with the mouse

pygame.mouse.get_pressed
 get_pressed(num_buttons=3) -> (button1, button2, button3)
 get_pressed(num_buttons=5) -> (button1, button2, button3, button4, button5)
get the state of the mouse buttons

pygame.mouse.get_pos
 get_pos() -> (x, y)
get the mouse cursor position

pygame.mouse.get_rel
 get_rel() -> (x, y)
get the amount of mouse movement

pygame.mouse.set_pos
 set_pos([x, y]) -> None
set the mouse cursor position

pygame.mouse.set_visible
 set_visible(bool) -> bool
hide or show the mouse cursor

pygame.mouse.get_visible
 get_visible() -> bool
get the current visibility state of the mouse cursor

pygame.mouse.get_focused
 get_focused() -> bool
check if the display is receiving mouse input

pygame.mouse.set_cursor
 set_cursor(pygame.cursors.Cursor) -> None
 set_cursor(size, hotspot, xormasks, andmasks) -> None
 set_cursor(hotspot, surface) -> None
 set_cursor(constant) -> None
set the mouse cursor to a new cursor

pygame.mouse.get_cursor
 get_cursor() -> pygame.cursors.Cursor
get the current mouse cursor

*/