File: rect_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 (168 lines) | stat: -rw-r--r-- 6,912 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMERECT "Rect(left, top, width, height) -> Rect\nRect((left, top), (width, height)) -> Rect\nRect(object) -> Rect\npygame object for storing rectangular coordinates"
#define DOC_RECTCOPY "copy() -> Rect\ncopy the rectangle"
#define DOC_RECTMOVE "move(x, y) -> Rect\nmoves the rectangle"
#define DOC_RECTMOVEIP "move_ip(x, y) -> None\nmoves the rectangle, in place"
#define DOC_RECTINFLATE "inflate(x, y) -> Rect\ngrow or shrink the rectangle size"
#define DOC_RECTINFLATEIP "inflate_ip(x, y) -> None\ngrow or shrink the rectangle size, in place"
#define DOC_RECTSCALEBY "scale_by(scalar) -> Rect\nscale_by(scalex, scaley) -> Rect\nscale the rectangle by given a multiplier"
#define DOC_RECTSCALEBYIP "scale_by_ip(scalar) -> None\nscale_by_ip(scalex, scaley) -> None\ngrow or shrink the rectangle size, in place"
#define DOC_RECTUPDATE "update(left, top, width, height) -> None\nupdate((left, top), (width, height)) -> None\nupdate(object) -> None\nsets the position and size of the rectangle"
#define DOC_RECTCLAMP "clamp(Rect) -> Rect\nmoves the rectangle inside another"
#define DOC_RECTCLAMPIP "clamp_ip(Rect) -> None\nmoves the rectangle inside another, in place"
#define DOC_RECTCLIP "clip(Rect) -> Rect\ncrops a rectangle inside another"
#define DOC_RECTCLIPLINE "clipline(x1, y1, x2, y2) -> ((cx1, cy1), (cx2, cy2))\nclipline(x1, y1, x2, y2) -> ()\nclipline((x1, y1), (x2, y2)) -> ((cx1, cy1), (cx2, cy2))\nclipline((x1, y1), (x2, y2)) -> ()\nclipline((x1, y1, x2, y2)) -> ((cx1, cy1), (cx2, cy2))\nclipline((x1, y1, x2, y2)) -> ()\nclipline(((x1, y1), (x2, y2))) -> ((cx1, cy1), (cx2, cy2))\nclipline(((x1, y1), (x2, y2))) -> ()\ncrops a line inside a rectangle"
#define DOC_RECTUNION "union(Rect) -> Rect\njoins two rectangles into one"
#define DOC_RECTUNIONIP "union_ip(Rect) -> None\njoins two rectangles into one, in place"
#define DOC_RECTUNIONALL "unionall(Rect_sequence) -> Rect\nthe union of many rectangles"
#define DOC_RECTUNIONALLIP "unionall_ip(Rect_sequence) -> None\nthe union of many rectangles, in place"
#define DOC_RECTFIT "fit(Rect) -> Rect\nresize and move a rectangle with aspect ratio"
#define DOC_RECTNORMALIZE "normalize() -> None\ncorrect negative sizes"
#define DOC_RECTCONTAINS "contains(Rect) -> bool\ntest if one rectangle is inside another"
#define DOC_RECTCOLLIDEPOINT "collidepoint(x, y) -> bool\ncollidepoint((x,y)) -> bool\ntest if a point is inside a rectangle"
#define DOC_RECTCOLLIDERECT "colliderect(Rect) -> bool\ntest if two rectangles overlap"
#define DOC_RECTCOLLIDELIST "collidelist(list) -> index\ntest if one rectangle in a list intersects"
#define DOC_RECTCOLLIDELISTALL "collidelistall(list) -> indices\ntest if all rectangles in a list intersect"
#define DOC_RECTCOLLIDEOBJECTS "collideobjects(rect_list) -> object\ncollideobjects(obj_list, key=func) -> object\ntest if any object in a list intersects"
#define DOC_RECTCOLLIDEOBJECTSALL "collideobjectsall(rect_list) -> objects\ncollideobjectsall(obj_list, key=func) -> objects\ntest if all objects in a list intersect"
#define DOC_RECTCOLLIDEDICT "collidedict(dict) -> (key, value)\ncollidedict(dict) -> None\ncollidedict(dict, use_values=0) -> (key, value)\ncollidedict(dict, use_values=0) -> None\ntest if one rectangle in a dictionary intersects"
#define DOC_RECTCOLLIDEDICTALL "collidedictall(dict) -> [(key, value), ...]\ncollidedictall(dict, use_values=0) -> [(key, value), ...]\ntest if all rectangles in a dictionary intersect"


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

/*

pygame.Rect
 Rect(left, top, width, height) -> Rect
 Rect((left, top), (width, height)) -> Rect
 Rect(object) -> Rect
pygame object for storing rectangular coordinates

pygame.Rect.copy
 copy() -> Rect
copy the rectangle

pygame.Rect.move
 move(x, y) -> Rect
moves the rectangle

pygame.Rect.move_ip
 move_ip(x, y) -> None
moves the rectangle, in place

pygame.Rect.inflate
 inflate(x, y) -> Rect
grow or shrink the rectangle size

pygame.Rect.inflate_ip
 inflate_ip(x, y) -> None
grow or shrink the rectangle size, in place

pygame.Rect.scale_by
 scale_by(scalar) -> Rect
 scale_by(scalex, scaley) -> Rect
scale the rectangle by given a multiplier

pygame.Rect.scale_by_ip
 scale_by_ip(scalar) -> None
 scale_by_ip(scalex, scaley) -> None
grow or shrink the rectangle size, in place

pygame.Rect.update
 update(left, top, width, height) -> None
 update((left, top), (width, height)) -> None
 update(object) -> None
sets the position and size of the rectangle

pygame.Rect.clamp
 clamp(Rect) -> Rect
moves the rectangle inside another

pygame.Rect.clamp_ip
 clamp_ip(Rect) -> None
moves the rectangle inside another, in place

pygame.Rect.clip
 clip(Rect) -> Rect
crops a rectangle inside another

pygame.Rect.clipline
 clipline(x1, y1, x2, y2) -> ((cx1, cy1), (cx2, cy2))
 clipline(x1, y1, x2, y2) -> ()
 clipline((x1, y1), (x2, y2)) -> ((cx1, cy1), (cx2, cy2))
 clipline((x1, y1), (x2, y2)) -> ()
 clipline((x1, y1, x2, y2)) -> ((cx1, cy1), (cx2, cy2))
 clipline((x1, y1, x2, y2)) -> ()
 clipline(((x1, y1), (x2, y2))) -> ((cx1, cy1), (cx2, cy2))
 clipline(((x1, y1), (x2, y2))) -> ()
crops a line inside a rectangle

pygame.Rect.union
 union(Rect) -> Rect
joins two rectangles into one

pygame.Rect.union_ip
 union_ip(Rect) -> None
joins two rectangles into one, in place

pygame.Rect.unionall
 unionall(Rect_sequence) -> Rect
the union of many rectangles

pygame.Rect.unionall_ip
 unionall_ip(Rect_sequence) -> None
the union of many rectangles, in place

pygame.Rect.fit
 fit(Rect) -> Rect
resize and move a rectangle with aspect ratio

pygame.Rect.normalize
 normalize() -> None
correct negative sizes

pygame.Rect.contains
 contains(Rect) -> bool
test if one rectangle is inside another

pygame.Rect.collidepoint
 collidepoint(x, y) -> bool
 collidepoint((x,y)) -> bool
test if a point is inside a rectangle

pygame.Rect.colliderect
 colliderect(Rect) -> bool
test if two rectangles overlap

pygame.Rect.collidelist
 collidelist(list) -> index
test if one rectangle in a list intersects

pygame.Rect.collidelistall
 collidelistall(list) -> indices
test if all rectangles in a list intersect

pygame.Rect.collideobjects
 collideobjects(rect_list) -> object
 collideobjects(obj_list, key=func) -> object
test if any object in a list intersects

pygame.Rect.collideobjectsall
 collideobjectsall(rect_list) -> objects
 collideobjectsall(obj_list, key=func) -> objects
test if all objects in a list intersect

pygame.Rect.collidedict
 collidedict(dict) -> (key, value)
 collidedict(dict) -> None
 collidedict(dict, use_values=0) -> (key, value)
 collidedict(dict, use_values=0) -> None
test if one rectangle in a dictionary intersects

pygame.Rect.collidedictall
 collidedictall(dict) -> [(key, value), ...]
 collidedictall(dict, use_values=0) -> [(key, value), ...]
test if all rectangles in a dictionary intersect

*/