Source

pygame / src / doc / overlay_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEOVERLAY "Overlay(format, (width, height)) -> Overlay\npygame object for video overlay graphics"

#define DOC_OVERLAYDISPLAY "display((y, u, v)) -> None\ndisplay() -> None\nset the overlay pixel data"

#define DOC_OVERLAYSETLOCATION "set_location(rect) -> None\ncontrol where the overlay is displayed"

#define DOC_OVERLAYGETHARDWARE "get_hardware(rect) -> int\ntest if the Overlay is hardware accelerated"



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

/*

pygame.Overlay
 Overlay(format, (width, height)) -> Overlay
pygame object for video overlay graphics

pygame.Overlay.display
 display((y, u, v)) -> None
 display() -> None
set the overlay pixel data

pygame.Overlay.set_location
 set_location(rect) -> None
control where the overlay is displayed

pygame.Overlay.get_hardware
 get_hardware(rect) -> int
test if the Overlay is hardware accelerated

*/