1 /* Auto generated file: with makeref.py . Docs go in docs/reST/ref/ . */ 2 #define DOC_PYGAMEDISPLAY "pygame module to control the display window and screen" 3 #define DOC_PYGAMEDISPLAYINIT "init() -> None\nInitialize the display module" 4 #define DOC_PYGAMEDISPLAYQUIT "quit() -> None\nUninitialize the display module" 5 #define DOC_PYGAMEDISPLAYGETINIT "get_init() -> bool\nReturns True if the display module has been initialized" 6 #define DOC_PYGAMEDISPLAYSETMODE "set_mode(size=(0, 0), flags=0, depth=0, display=0, vsync=0) -> Surface\nInitialize a window or screen for display" 7 #define DOC_PYGAMEDISPLAYGETSURFACE "get_surface() -> Surface\nGet a reference to the currently set display surface" 8 #define DOC_PYGAMEDISPLAYFLIP "flip() -> None\nUpdate the full display Surface to the screen" 9 #define DOC_PYGAMEDISPLAYUPDATE "update(rectangle=None) -> None\nupdate(rectangle_list) -> None\nUpdate portions of the screen for software displays" 10 #define DOC_PYGAMEDISPLAYGETDRIVER "get_driver() -> name\nGet the name of the pygame display backend" 11 #define DOC_PYGAMEDISPLAYINFO "Info() -> VideoInfo\nCreate a video display information object" 12 #define DOC_PYGAMEDISPLAYGETWMINFO "get_wm_info() -> dict\nGet information about the current windowing system" 13 #define DOC_PYGAMEDISPLAYGETDESKTOPSIZES "get_desktop_sizes() -> list\nGet sizes of active desktops" 14 #define DOC_PYGAMEDISPLAYLISTMODES "list_modes(depth=0, flags=pygame.FULLSCREEN, display=0) -> list\nGet list of available fullscreen modes" 15 #define DOC_PYGAMEDISPLAYMODEOK "mode_ok(size, flags=0, depth=0, display=0) -> depth\nPick the best color depth for a display mode" 16 #define DOC_PYGAMEDISPLAYGLGETATTRIBUTE "gl_get_attribute(flag) -> value\nGet the value for an OpenGL flag for the current display" 17 #define DOC_PYGAMEDISPLAYGLSETATTRIBUTE "gl_set_attribute(flag, value) -> None\nRequest an OpenGL display attribute for the display mode" 18 #define DOC_PYGAMEDISPLAYGETACTIVE "get_active() -> bool\nReturns True when the display is active on the screen" 19 #define DOC_PYGAMEDISPLAYICONIFY "iconify() -> bool\nIconify the display surface" 20 #define DOC_PYGAMEDISPLAYTOGGLEFULLSCREEN "toggle_fullscreen() -> int\nSwitch between fullscreen and windowed displays" 21 #define DOC_PYGAMEDISPLAYSETGAMMA "set_gamma(red, green=None, blue=None) -> bool\nChange the hardware gamma ramps" 22 #define DOC_PYGAMEDISPLAYSETGAMMARAMP "set_gamma_ramp(red, green, blue) -> bool\nChange the hardware gamma ramps with a custom lookup" 23 #define DOC_PYGAMEDISPLAYSETICON "set_icon(Surface) -> None\nChange the system image for the display window" 24 #define DOC_PYGAMEDISPLAYSETCAPTION "set_caption(title, icontitle=None) -> None\nSet the current window caption" 25 #define DOC_PYGAMEDISPLAYGETCAPTION "get_caption() -> (title, icontitle)\nGet the current window caption" 26 #define DOC_PYGAMEDISPLAYSETPALETTE "set_palette(palette=None) -> None\nSet the display color palette for indexed displays" 27 #define DOC_PYGAMEDISPLAYGETNUMDISPLAYS "get_num_displays() -> int\nReturn the number of displays" 28 #define DOC_PYGAMEDISPLAYGETWINDOWSIZE "get_window_size() -> tuple\nReturn the size of the window or screen" 29 #define DOC_PYGAMEDISPLAYGETALLOWSCREENSAVER "get_allow_screensaver() -> bool\nReturn whether the screensaver is allowed to run." 30 #define DOC_PYGAMEDISPLAYSETALLOWSCREENSAVER "set_allow_screensaver(bool) -> None\nSet whether the screensaver may run" 31 32 33 /* Docs in a comment... slightly easier to read. */ 34 35 /* 36 37 pygame.display 38 pygame module to control the display window and screen 39 40 pygame.display.init 41 init() -> None 42 Initialize the display module 43 44 pygame.display.quit 45 quit() -> None 46 Uninitialize the display module 47 48 pygame.display.get_init 49 get_init() -> bool 50 Returns True if the display module has been initialized 51 52 pygame.display.set_mode 53 set_mode(size=(0, 0), flags=0, depth=0, display=0, vsync=0) -> Surface 54 Initialize a window or screen for display 55 56 pygame.display.get_surface 57 get_surface() -> Surface 58 Get a reference to the currently set display surface 59 60 pygame.display.flip 61 flip() -> None 62 Update the full display Surface to the screen 63 64 pygame.display.update 65 update(rectangle=None) -> None 66 update(rectangle_list) -> None 67 Update portions of the screen for software displays 68 69 pygame.display.get_driver 70 get_driver() -> name 71 Get the name of the pygame display backend 72 73 pygame.display.Info 74 Info() -> VideoInfo 75 Create a video display information object 76 77 pygame.display.get_wm_info 78 get_wm_info() -> dict 79 Get information about the current windowing system 80 81 pygame.display.get_desktop_sizes 82 get_desktop_sizes() -> list 83 Get sizes of active desktops 84 85 pygame.display.list_modes 86 list_modes(depth=0, flags=pygame.FULLSCREEN, display=0) -> list 87 Get list of available fullscreen modes 88 89 pygame.display.mode_ok 90 mode_ok(size, flags=0, depth=0, display=0) -> depth 91 Pick the best color depth for a display mode 92 93 pygame.display.gl_get_attribute 94 gl_get_attribute(flag) -> value 95 Get the value for an OpenGL flag for the current display 96 97 pygame.display.gl_set_attribute 98 gl_set_attribute(flag, value) -> None 99 Request an OpenGL display attribute for the display mode 100 101 pygame.display.get_active 102 get_active() -> bool 103 Returns True when the display is active on the screen 104 105 pygame.display.iconify 106 iconify() -> bool 107 Iconify the display surface 108 109 pygame.display.toggle_fullscreen 110 toggle_fullscreen() -> int 111 Switch between fullscreen and windowed displays 112 113 pygame.display.set_gamma 114 set_gamma(red, green=None, blue=None) -> bool 115 Change the hardware gamma ramps 116 117 pygame.display.set_gamma_ramp 118 set_gamma_ramp(red, green, blue) -> bool 119 Change the hardware gamma ramps with a custom lookup 120 121 pygame.display.set_icon 122 set_icon(Surface) -> None 123 Change the system image for the display window 124 125 pygame.display.set_caption 126 set_caption(title, icontitle=None) -> None 127 Set the current window caption 128 129 pygame.display.get_caption 130 get_caption() -> (title, icontitle) 131 Get the current window caption 132 133 pygame.display.set_palette 134 set_palette(palette=None) -> None 135 Set the display color palette for indexed displays 136 137 pygame.display.get_num_displays 138 get_num_displays() -> int 139 Return the number of displays 140 141 pygame.display.get_window_size 142 get_window_size() -> tuple 143 Return the size of the window or screen 144 145 pygame.display.get_allow_screensaver 146 get_allow_screensaver() -> bool 147 Return whether the screensaver is allowed to run. 148 149 pygame.display.set_allow_screensaver 150 set_allow_screensaver(bool) -> None 151 Set whether the screensaver may run 152 153 */