File: pygame_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 (91 lines) | stat: -rw-r--r-- 3,107 bytes parent folder | download | duplicates (2)
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
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAME "the top level pygame package"
#define DOC_PYGAMEINIT "init() -> (numpass, numfail)\ninitialize all imported pygame modules"
#define DOC_PYGAMEQUIT "quit() -> None\nuninitialize all pygame modules"
#define DOC_PYGAMEGETINIT "get_init() -> bool\nreturns True if pygame is currently initialized"
#define DOC_PYGAMEERROR "raise pygame.error(message)\nstandard pygame exception"
#define DOC_PYGAMEGETERROR "get_error() -> errorstr\nget the current error message"
#define DOC_PYGAMESETERROR "set_error(error_msg) -> None\nset the current error message"
#define DOC_PYGAMEGETSDLVERSION "get_sdl_version(linked=True) -> major, minor, patch\nget the version number of SDL"
#define DOC_PYGAMEGETSDLBYTEORDER "get_sdl_byteorder() -> int\nget the byte order of SDL"
#define DOC_PYGAMEREGISTERQUIT "register_quit(callable) -> None\nregister a function to be called when pygame quits"
#define DOC_PYGAMEENCODESTRING "encode_string([obj [, encoding [, errors [, etype]]]]) -> bytes or None\nEncode a Unicode or bytes object"
#define DOC_PYGAMEENCODEFILEPATH "encode_file_path([obj [, etype]]) -> bytes or None\nEncode a Unicode or bytes object as a file system path"
#define DOC_PYGAMEVERSION "small module containing version information"
#define DOC_PYGAMEVERSIONVER "ver = '1.2'\nversion number as a string"
#define DOC_PYGAMEVERSIONVERNUM "vernum = (1, 5, 3)\ntupled integers of the version"
#define DOC_PYGAMEVERSIONREV "rev = 'a6f89747b551+'\nrepository revision of the build"
#define DOC_PYGAMEVERSIONSDL "SDL = '(2, 0, 12)'\ntupled integers of the SDL library version"


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

/*

pygame
the top level pygame package

pygame.init
 init() -> (numpass, numfail)
initialize all imported pygame modules

pygame.quit
 quit() -> None
uninitialize all pygame modules

pygame.get_init
 get_init() -> bool
returns True if pygame is currently initialized

pygame.error
 raise pygame.error(message)
standard pygame exception

pygame.get_error
 get_error() -> errorstr
get the current error message

pygame.set_error
 set_error(error_msg) -> None
set the current error message

pygame.get_sdl_version
 get_sdl_version(linked=True) -> major, minor, patch
get the version number of SDL

pygame.get_sdl_byteorder
 get_sdl_byteorder() -> int
get the byte order of SDL

pygame.register_quit
 register_quit(callable) -> None
register a function to be called when pygame quits

pygame.encode_string
 encode_string([obj [, encoding [, errors [, etype]]]]) -> bytes or None
Encode a Unicode or bytes object

pygame.encode_file_path
 encode_file_path([obj [, etype]]) -> bytes or None
Encode a Unicode or bytes object as a file system path

pygame.version
small module containing version information

pygame.version.ver
 ver = '1.2'
version number as a string

pygame.version.vernum
 vernum = (1, 5, 3)
tupled integers of the version

pygame.version.rev
 rev = 'a6f89747b551+'
repository revision of the build

pygame.version.SDL
 SDL = '(2, 0, 12)'
tupled integers of the SDL library version

*/