File: draw_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 (66 lines) | stat: -rw-r--r-- 3,474 bytes parent folder | download | duplicates (3)
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
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMEDRAW "pygame module for drawing shapes"
#define DOC_PYGAMEDRAWRECT "rect(surface, color, rect) -> Rect\nrect(surface, color, rect, width=0, border_radius=0, border_top_left_radius=-1, border_top_right_radius=-1, border_bottom_left_radius=-1, border_bottom_right_radius=-1) -> Rect\ndraw a rectangle"
#define DOC_PYGAMEDRAWPOLYGON "polygon(surface, color, points) -> Rect\npolygon(surface, color, points, width=0) -> Rect\ndraw a polygon"
#define DOC_PYGAMEDRAWCIRCLE "circle(surface, color, center, radius) -> Rect\ncircle(surface, color, center, radius, width=0, draw_top_right=None, draw_top_left=None, draw_bottom_left=None, draw_bottom_right=None) -> Rect\ndraw a circle"
#define DOC_PYGAMEDRAWELLIPSE "ellipse(surface, color, rect) -> Rect\nellipse(surface, color, rect, width=0) -> Rect\ndraw an ellipse"
#define DOC_PYGAMEDRAWARC "arc(surface, color, rect, start_angle, stop_angle) -> Rect\narc(surface, color, rect, start_angle, stop_angle, width=1) -> Rect\ndraw an elliptical arc"
#define DOC_PYGAMEDRAWLINE "line(surface, color, start_pos, end_pos) -> Rect\nline(surface, color, start_pos, end_pos, width=1) -> Rect\ndraw a straight line"
#define DOC_PYGAMEDRAWLINES "lines(surface, color, closed, points) -> Rect\nlines(surface, color, closed, points, width=1) -> Rect\ndraw multiple contiguous straight line segments"
#define DOC_PYGAMEDRAWAALINE "aaline(surface, color, start_pos, end_pos) -> Rect\naaline(surface, color, start_pos, end_pos, blend=1) -> Rect\ndraw a straight antialiased line"
#define DOC_PYGAMEDRAWAALINES "aalines(surface, color, closed, points) -> Rect\naalines(surface, color, closed, points, blend=1) -> Rect\ndraw multiple contiguous straight antialiased line segments"


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

/*

pygame.draw
pygame module for drawing shapes

pygame.draw.rect
 rect(surface, color, rect) -> Rect
 rect(surface, color, rect, width=0, border_radius=0, border_top_left_radius=-1, border_top_right_radius=-1, border_bottom_left_radius=-1, border_bottom_right_radius=-1) -> Rect
draw a rectangle

pygame.draw.polygon
 polygon(surface, color, points) -> Rect
 polygon(surface, color, points, width=0) -> Rect
draw a polygon

pygame.draw.circle
 circle(surface, color, center, radius) -> Rect
 circle(surface, color, center, radius, width=0, draw_top_right=None, draw_top_left=None, draw_bottom_left=None, draw_bottom_right=None) -> Rect
draw a circle

pygame.draw.ellipse
 ellipse(surface, color, rect) -> Rect
 ellipse(surface, color, rect, width=0) -> Rect
draw an ellipse

pygame.draw.arc
 arc(surface, color, rect, start_angle, stop_angle) -> Rect
 arc(surface, color, rect, start_angle, stop_angle, width=1) -> Rect
draw an elliptical arc

pygame.draw.line
 line(surface, color, start_pos, end_pos) -> Rect
 line(surface, color, start_pos, end_pos, width=1) -> Rect
draw a straight line

pygame.draw.lines
 lines(surface, color, closed, points) -> Rect
 lines(surface, color, closed, points, width=1) -> Rect
draw multiple contiguous straight line segments

pygame.draw.aaline
 aaline(surface, color, start_pos, end_pos) -> Rect
 aaline(surface, color, start_pos, end_pos, blend=1) -> Rect
draw a straight antialiased line

pygame.draw.aalines
 aalines(surface, color, closed, points) -> Rect
 aalines(surface, color, closed, points, blend=1) -> Rect
draw multiple contiguous straight antialiased line segments

*/