File: camera_doc.h

package info (click to toggle)
pygame 2.6.1-4
  • links: PTS, VCS
  • area: main
  • in suites: 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 (77 lines) | stat: -rw-r--r-- 2,922 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
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
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMECAMERA "pygame module for camera use"
#define DOC_PYGAMECAMERAINIT "init(backend = None) -> None\nModule init"
#define DOC_PYGAMECAMERAGETBACKENDS "get_backends() -> [str]\nGet the backends supported on this system"
#define DOC_PYGAMECAMERACOLORSPACE "colorspace(Surface, format, DestSurface = None) -> Surface\nSurface colorspace conversion"
#define DOC_PYGAMECAMERALISTCAMERAS "list_cameras() -> [cameras]\nreturns a list of available cameras"
#define DOC_PYGAMECAMERACAMERA "Camera(device, (width, height), format) -> Camera\nload a camera"
#define DOC_CAMERASTART "start() -> None\nopens, initializes, and starts capturing"
#define DOC_CAMERASTOP "stop() -> None\nstops, uninitializes, and closes the camera"
#define DOC_CAMERAGETCONTROLS "get_controls() -> (hflip = bool, vflip = bool, brightness)\ngets current values of user controls"
#define DOC_CAMERASETCONTROLS "set_controls(hflip = bool, vflip = bool, brightness) -> (hflip = bool, vflip = bool, brightness)\nchanges camera settings if supported by the camera"
#define DOC_CAMERAGETSIZE "get_size() -> (width, height)\nreturns the dimensions of the images being recorded"
#define DOC_CAMERAQUERYIMAGE "query_image() -> bool\nchecks if a frame is ready"
#define DOC_CAMERAGETIMAGE "get_image(Surface = None) -> Surface\ncaptures an image as a Surface"
#define DOC_CAMERAGETRAW "get_raw() -> bytes\nreturns an unmodified image as bytes"


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

/*

pygame.camera
pygame module for camera use

pygame.camera.init
 init(backend = None) -> None
Module init

pygame.camera.get_backends
 get_backends() -> [str]
Get the backends supported on this system

pygame.camera.colorspace
 colorspace(Surface, format, DestSurface = None) -> Surface
Surface colorspace conversion

pygame.camera.list_cameras
 list_cameras() -> [cameras]
returns a list of available cameras

pygame.camera.Camera
 Camera(device, (width, height), format) -> Camera
load a camera

pygame.camera.Camera.start
 start() -> None
opens, initializes, and starts capturing

pygame.camera.Camera.stop
 stop() -> None
stops, uninitializes, and closes the camera

pygame.camera.Camera.get_controls
 get_controls() -> (hflip = bool, vflip = bool, brightness)
gets current values of user controls

pygame.camera.Camera.set_controls
 set_controls(hflip = bool, vflip = bool, brightness) -> (hflip = bool, vflip = bool, brightness)
changes camera settings if supported by the camera

pygame.camera.Camera.get_size
 get_size() -> (width, height)
returns the dimensions of the images being recorded

pygame.camera.Camera.query_image
 query_image() -> bool
checks if a frame is ready

pygame.camera.Camera.get_image
 get_image(Surface = None) -> Surface
captures an image as a Surface

pygame.camera.Camera.get_raw
 get_raw() -> bytes
returns an unmodified image as bytes

*/