File: api.txt

package info (click to toggle)
php-imlib 0.3-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 572 kB
  • ctags: 430
  • sloc: ansic: 1,287; php: 626; sh: 94; makefile: 66
file content (254 lines) | stat: -rw-r--r-- 7,990 bytes parent folder | download | duplicates (5)
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
Documentation
=============

Below is a brief blurb about each of the functions in the php_imlib
extension. For examples of how these are used, see the examples page.
There are also some PHP classes included with php_imlib (Which also
have examples posted on the examples page). These classfiles have been
documented using the PHPDoc documentation system. That documentation
can be found here.

Predefined Constants
--------------------

imlib_add_color_to_color_range
imlib_blend_image_onto_image
imlib_clone_image
imlib_create_color_range
imlib_create_cropped_image
imlib_create_cropped_scaled_image
imlib_create_image
imlib_create_rotated_image
imlib_create_scaled_image
imlib_dump_image
imlib_free_color_range
imlib_free_font
imlib_free_image
imlib_get_text_size
imlib_image_blur
imlib_image_draw_ellipse
imlib_image_draw_line
imlib_image_draw_polygon
imlib_image_draw_rectangle
imlib_image_fill_color_range_rectangle
imlib_image_fill_ellipse
imlib_image_fill_polygon
imlib_image_fill_rectangle
imlib_image_flip_horizontal
imlib_image_flip_vertical
imlib_image_flip_diagonal
imlib_image_format
imlib_image_get_filename
imlib_image_get_height
imlib_image_get_width
imlib_image_has_alpha
imlib_image_modify_alpha
imlib_image_set_format
imlib_image_sharpen
imlib_image_tile_horizontal
imlib_image_tile_vertical
imlib_image_tile
imlib_list_fonts
imlib_load_font
imlib_load_image
imlib_polygon_add_point
imlib_polygon_contains_point
imlib_polygon_free
imlib_polygon_get_bounds
imlib_polygon_new
imlib_save_image
imlib_text_draw

Getting and Setting Image Parameters
------------------------------------

string imlib_image_format(int img)
       Returns the image format of an image
       
string imlib_image_get_filename(int img)
       Returns the filename of an image
       
int imlib_image_get_height(int img)
       Returns the height of an image
       
int imlib_image_get_width(int img)
       Returns the width of an image
       
bool imlib_image_has_alpha(int img)
       Return a boolean for whether or not an image has an alpha
       channel
       
void imlib_image_modify_alpha(int img, int alpha)
       Set the alpha channel of an image, or modify it if one was
       already present
       
void imlib_image_set_format(int img, string format)
       Sets the image format of an image.

Loading/Saving Functions
------------------------

void imlib_free_image(int img)
       Free an image
       
int imlib_load_image(string img[, int &err])
       Load a file into an image, optionally fetch an error parameter
       
bool imlib_save_image(int img, string name[, int &err[, int quality]])
       Save an image to a file, at an optional quality level (1-100)
       for jpegs. For pngs, the value will be converted to a
       compression level (0-9)

Creation Functions
------------------

int imlib_clone_image(int img)
       Duplicate an image
       
int imlib_create_color_range()
       Create a new color range
       
int imlib_create_cropped_image(int img, int srcx, int srcy, int srcw,
       int srch)
       Create an image from a cropped region of another image
       
int imlib_create_cropped_scaled_image(int img, int srcx, int srcy, int
       srcw, int srch, int dstw, int dsth)
       Create a scaled image from a cropped region of another image
       
int imlib_create_image(int w, int h)
       Create a new image with the specified dimensions
       
int imlib_create_rotated_image(int srcimg, int degrees[, int radians])
       Create a rotated copy of an image. If radians is specified,
       degrees will be ignored.
       
int imlib_create_scaled_image(int img, int dstw, int dsth)
       Create a scaled copy of an image. If dstw or dsth is left
       blank, the aspect ratio of the source image will be preserved.
       
bool imlib_dump_image(int img[, int &err[, int quality]])
       Output an image at an optional quality setting

Rendering Functions
-------------------

void imlib_blend_image_onto_image(int dstimg, int srcimg, int malpha,
       int srcx, int srcy, int srcw, int srch, int dstx, int dsty, int
       dstw, int dsth, char dither, char blend, char alias)
       Blend a rectangular area from an image onto an area of another
       image, scaling as necessary

Image Modification Functions
----------------------------

void imlib_image_blur(int img, int radius)
       Blur an image with a given blur radius

void imlib_image_flip_horizontal(int img)
       Flip an image horizontally
       
void imlib_image_flip_vertical(int img)
       Flip an Imlib_Image vertically
       
void imlib_image_flip_diagonal(int img)
       Flip an image diagonally
       
void imlib_image_tile_horizontal(int img)
       Tile an image horizontally
       
void imlib_image_tile_vertical(int img)
       Tile an image vertically
       
void imlib_image_tile(int img)
       Tile an image horizontally and diagonally

void imlib_image_sharpen(int img, int radius)
       Sharpen an image with a given sharpen radius

Drawing on Images
-----------------

bool imlib_image_draw_ellipse(int img, int xc, int yc, int w, int h,
       int r, int g, int b, int a[, array cliprect])
       Draw an ellipse of the specified size and color on an image
       
bool imlib_image_draw_line(int img, int x1, int y1, int x2, int y2,
       int r, int g, int b, int a[, array cliprect])
       Draw a line of the specified size and color on an image
       
bool imlib_image_draw_polygon(int img, int polygon, bool closed, int
       r, int g, int b, int a[, array cliprect])
       Draw the defined polygon on an image
       
bool imlib_image_draw_rectangle(int img, int x, int y, int w, int h,
       int r, int g, int b, int a[, array cliprect])
       Draw a rectangle of the specified size and color on an image
       
bool imlib_image_fill_color_range_rectangle(int im, int cr, int x, int
       y, int width, int height, int angle)
       Fill a rectangle with a color range at a given angle on an
       image
       
void imlib_image_fill_ellipse(int img, int xc, int yc, int w, int h,
       int r, int g, int b, int a[, array cliprect])
       Fill an ellipse of the specified size and color on an image
       
bool imlib_image_fill_polygon(int img, int polygon, int r, int g, int
       b, int a[, array cliprect])
       Draw and fill the defined polygon on an image
       
void imlib_image_fill_rectange(int img, int x, int y, int w, int h,
       int r, int g, int b, int a[, array cliprect])
       Fill a rectangle of the specified size and color on an image

Fonts and Text Functions
------------------------

void imlib_free_font(int font)
       Free a font
       
void imlib_get_text_size(int font, string str, int &w, int &h, int
       direction)
       Determines the width and height of a string if drawn with a
       given font in the specified direction
       
array imlib_list_fonts()
       Return an array of all the fonts available in the font path
       
int imlib_load_font(string fontname)
       Load a font
       
void imlib_text_draw(int img, int font, int x, int y, string str, int
       direction, int r, int g, int b, int a)
       Draw a text string using a font onto an image

Color Ranges
------------

void imlib_add_color_to_color_range(int cr, int x, int r, int g, int
       b, int a)
       Add a color to a color range at a specified distance from the
       previous color in the range. A distance of 0 centers it
       
void imlib_free_color_range(int cr)
       Free a color range

Polygons
--------

void imlib_polygon_add_point(int polygon, int x, int y)
       Add a point to a given polygon
       
bool imlib_polygon_contains_point(int polygon, int x, int y)
       Check if a give point is inside a polygon
       
void imlib_polygon_free(int polygon)
       Free a polygon
       
void imlib_polygon_get_bounds(int polygon, int &x1, int &y1, int &x2,
       int &y2)
       Get the bounding coords of a polygon
       
int imlib_polygon_new()
       Create a new polygon