File: overlay_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 (29 lines) | stat: -rw-r--r-- 952 bytes parent folder | download | duplicates (4)
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
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#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

*/