-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
display_doc.h
153 lines (120 loc) 路 6.27 KB
/
display_doc.h
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/* Auto generated file: with makeref.py . Docs go in docs/reST/ref/ . */
#define DOC_PYGAMEDISPLAY "pygame module to control the display window and screen"
#define DOC_PYGAMEDISPLAYINIT "init() -> None\nInitialize the display module"
#define DOC_PYGAMEDISPLAYQUIT "quit() -> None\nUninitialize the display module"
#define DOC_PYGAMEDISPLAYGETINIT "get_init() -> bool\nReturns True if the display module has been initialized"
#define DOC_PYGAMEDISPLAYSETMODE "set_mode(size=(0, 0), flags=0, depth=0, display=0, vsync=0) -> Surface\nInitialize a window or screen for display"
#define DOC_PYGAMEDISPLAYGETSURFACE "get_surface() -> Surface\nGet a reference to the currently set display surface"
#define DOC_PYGAMEDISPLAYFLIP "flip() -> None\nUpdate the full display Surface to the screen"
#define DOC_PYGAMEDISPLAYUPDATE "update(rectangle=None) -> None\nupdate(rectangle_list) -> None\nUpdate portions of the screen for software displays"
#define DOC_PYGAMEDISPLAYGETDRIVER "get_driver() -> name\nGet the name of the pygame display backend"
#define DOC_PYGAMEDISPLAYINFO "Info() -> VideoInfo\nCreate a video display information object"
#define DOC_PYGAMEDISPLAYGETWMINFO "get_wm_info() -> dict\nGet information about the current windowing system"
#define DOC_PYGAMEDISPLAYGETDESKTOPSIZES "get_desktop_sizes() -> list\nGet sizes of active desktops"
#define DOC_PYGAMEDISPLAYLISTMODES "list_modes(depth=0, flags=pygame.FULLSCREEN, display=0) -> list\nGet list of available fullscreen modes"
#define DOC_PYGAMEDISPLAYMODEOK "mode_ok(size, flags=0, depth=0, display=0) -> depth\nPick the best color depth for a display mode"
#define DOC_PYGAMEDISPLAYGLGETATTRIBUTE "gl_get_attribute(flag) -> value\nGet the value for an OpenGL flag for the current display"
#define DOC_PYGAMEDISPLAYGLSETATTRIBUTE "gl_set_attribute(flag, value) -> None\nRequest an OpenGL display attribute for the display mode"
#define DOC_PYGAMEDISPLAYGETACTIVE "get_active() -> bool\nReturns True when the display is active on the screen"
#define DOC_PYGAMEDISPLAYICONIFY "iconify() -> bool\nIconify the display surface"
#define DOC_PYGAMEDISPLAYTOGGLEFULLSCREEN "toggle_fullscreen() -> int\nSwitch between fullscreen and windowed displays"
#define DOC_PYGAMEDISPLAYSETGAMMA "set_gamma(red, green=None, blue=None) -> bool\nChange the hardware gamma ramps"
#define DOC_PYGAMEDISPLAYSETGAMMARAMP "set_gamma_ramp(red, green, blue) -> bool\nChange the hardware gamma ramps with a custom lookup"
#define DOC_PYGAMEDISPLAYSETICON "set_icon(Surface) -> None\nChange the system image for the display window"
#define DOC_PYGAMEDISPLAYSETCAPTION "set_caption(title, icontitle=None) -> None\nSet the current window caption"
#define DOC_PYGAMEDISPLAYGETCAPTION "get_caption() -> (title, icontitle)\nGet the current window caption"
#define DOC_PYGAMEDISPLAYSETPALETTE "set_palette(palette=None) -> None\nSet the display color palette for indexed displays"
#define DOC_PYGAMEDISPLAYGETNUMDISPLAYS "get_num_displays() -> int\nReturn the number of displays"
#define DOC_PYGAMEDISPLAYGETWINDOWSIZE "get_window_size() -> tuple\nReturn the size of the window or screen"
#define DOC_PYGAMEDISPLAYGETALLOWSCREENSAVER "get_allow_screensaver() -> bool\nReturn whether the screensaver is allowed to run."
#define DOC_PYGAMEDISPLAYSETALLOWSCREENSAVER "set_allow_screensaver(bool) -> None\nSet whether the screensaver may run"
/* Docs in a comment... slightly easier to read. */
/*
pygame.display
pygame module to control the display window and screen
pygame.display.init
init() -> None
Initialize the display module
pygame.display.quit
quit() -> None
Uninitialize the display module
pygame.display.get_init
get_init() -> bool
Returns True if the display module has been initialized
pygame.display.set_mode
set_mode(size=(0, 0), flags=0, depth=0, display=0, vsync=0) -> Surface
Initialize a window or screen for display
pygame.display.get_surface
get_surface() -> Surface
Get a reference to the currently set display surface
pygame.display.flip
flip() -> None
Update the full display Surface to the screen
pygame.display.update
update(rectangle=None) -> None
update(rectangle_list) -> None
Update portions of the screen for software displays
pygame.display.get_driver
get_driver() -> name
Get the name of the pygame display backend
pygame.display.Info
Info() -> VideoInfo
Create a video display information object
pygame.display.get_wm_info
get_wm_info() -> dict
Get information about the current windowing system
pygame.display.get_desktop_sizes
get_desktop_sizes() -> list
Get sizes of active desktops
pygame.display.list_modes
list_modes(depth=0, flags=pygame.FULLSCREEN, display=0) -> list
Get list of available fullscreen modes
pygame.display.mode_ok
mode_ok(size, flags=0, depth=0, display=0) -> depth
Pick the best color depth for a display mode
pygame.display.gl_get_attribute
gl_get_attribute(flag) -> value
Get the value for an OpenGL flag for the current display
pygame.display.gl_set_attribute
gl_set_attribute(flag, value) -> None
Request an OpenGL display attribute for the display mode
pygame.display.get_active
get_active() -> bool
Returns True when the display is active on the screen
pygame.display.iconify
iconify() -> bool
Iconify the display surface
pygame.display.toggle_fullscreen
toggle_fullscreen() -> int
Switch between fullscreen and windowed displays
pygame.display.set_gamma
set_gamma(red, green=None, blue=None) -> bool
Change the hardware gamma ramps
pygame.display.set_gamma_ramp
set_gamma_ramp(red, green, blue) -> bool
Change the hardware gamma ramps with a custom lookup
pygame.display.set_icon
set_icon(Surface) -> None
Change the system image for the display window
pygame.display.set_caption
set_caption(title, icontitle=None) -> None
Set the current window caption
pygame.display.get_caption
get_caption() -> (title, icontitle)
Get the current window caption
pygame.display.set_palette
set_palette(palette=None) -> None
Set the display color palette for indexed displays
pygame.display.get_num_displays
get_num_displays() -> int
Return the number of displays
pygame.display.get_window_size
get_window_size() -> tuple
Return the size of the window or screen
pygame.display.get_allow_screensaver
get_allow_screensaver() -> bool
Return whether the screensaver is allowed to run.
pygame.display.set_allow_screensaver
set_allow_screensaver(bool) -> None
Set whether the screensaver may run
*/