Source

pygame / src / doc / key_doc.h

Full commit
/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEKEY "pygame module to work with the keyboard"

#define DOC_PYGAMEKEYGETFOCUSED "pygame.key.get_focused(): return bool\ntrue if the display is receiving keyboard input from the system"

#define DOC_PYGAMEKEYGETPRESSED "pygame.key.get_pressed(): return bools\nget the state of all keyboard buttons"

#define DOC_PYGAMEKEYGETMODS "pygame.key.get_mods(): return int\ndetermine which modifier keys are being held"

#define DOC_PYGAMEKEYSETMODS "pygame.key.set_mods(int): return None\ntemporarily set which modifier keys are pressed"

#define DOC_PYGAMEKEYSETREPEAT "pygame.key.set_repeat(): return None\npygame.key.set_repeat(delay, interval): return None\ncontrol how held keys are repeated"

#define DOC_PYGAMEKEYGETREPEAT "pygame.key.get_repeat(): return (delay, interval)\nsee how held keys are repeated"

#define DOC_PYGAMEKEYNAME "pygame.key.name(key): return string\nget the name of a key identifier"



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


/*

pygame.key
 pygame module to work with the keyboard



pygame.key.get_focused
 pygame.key.get_focused(): return bool
true if the display is receiving keyboard input from the system



pygame.key.get_pressed
 pygame.key.get_pressed(): return bools
get the state of all keyboard buttons



pygame.key.get_mods
 pygame.key.get_mods(): return int
determine which modifier keys are being held



pygame.key.set_mods
 pygame.key.set_mods(int): return None
temporarily set which modifier keys are pressed



pygame.key.set_repeat
 pygame.key.set_repeat(): return None
pygame.key.set_repeat(delay, interval): return None
control how held keys are repeated



pygame.key.get_repeat
 pygame.key.get_repeat(): return (delay, interval)
see how held keys are repeated



pygame.key.name
 pygame.key.name(key): return string
get the name of a key identifier



*/