Skip to content

Commit 5c37864

Browse files
schodetdlech
schodet
authored and
dlech
committed
pbio/image: Use [in] instead of [in,out] for image parameter.
Refs: pybricks/support#2154
1 parent f5b9a1d commit 5c37864

File tree

1 file changed

+90
-90
lines changed

1 file changed

+90
-90
lines changed

‎lib/pbio/src/image/image.c‎

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ void pbio_image_init_sub(pbio_image_t *image, const pbio_image_t *source,
9292

9393
/**
9494
* Fill an image with a value.
95-
* @param [in,out] image Image to fill.
96-
* @param [in] value Pixel value.
95+
* @param [in] image Image to fill.
96+
* @param [in] value Pixel value.
9797
*/
9898
void pbio_image_fill(pbio_image_t *image, uint8_t value) {
9999
uint8_t *p = image->pixels;
@@ -105,12 +105,12 @@ void pbio_image_fill(pbio_image_t *image, uint8_t value) {
105105

106106
/**
107107
* Draw an image inside another image.
108-
* @param [in,out] image Destination image to draw into.
109-
* @param [in] source Source image.
110-
* @param [in] x X coordinate of the top-left point in destination
111-
* image.
112-
* @param [in] y Y coordinate of the top-left point in destination
113-
* image.
108+
* @param [in] image Destination image to draw into.
109+
* @param [in] source Source image.
110+
* @param [in] x X coordinate of the top-left point in destination
111+
* image.
112+
* @param [in] y Y coordinate of the top-left point in destination
113+
* image.
114114
*
115115
* Source image pixels are copied into destination image.
116116
*
@@ -139,13 +139,13 @@ void pbio_image_draw_image(pbio_image_t *image, const pbio_image_t *source,
139139

140140
/**
141141
* Draw an image inside another image with transparency.
142-
* @param [in,out] image Destination image to draw into.
143-
* @param [in] source Source image.
144-
* @param [in] x X coordinate of the top-left point in destination
145-
* image.
146-
* @param [in] y Y coordinate of the top-left point in destination
147-
* image.
148-
* @param [in] value Pixel value in source image considered transparent.
142+
* @param [in] image Destination image to draw into.
143+
* @param [in] source Source image.
144+
* @param [in] x X coordinate of the top-left point in destination
145+
* image.
146+
* @param [in] y Y coordinate of the top-left point in destination
147+
* image.
148+
* @param [in] value Pixel value in source image considered transparent.
149149
*
150150
* Source image pixels are copied into destination image. When a source pixel
151151
* matches the transparent value, the corresponding destination pixel is left
@@ -183,10 +183,10 @@ void pbio_image_draw_image_transparent(pbio_image_t *image,
183183

184184
/**
185185
* Draw a single pixel.
186-
* @param [in,out] image Image to draw into.
187-
* @param [in] x X coordinate of the pixel.
188-
* @param [in] y Y coordinate of the pixel.
189-
* @param [in] value New pixel value.
186+
* @param [in] image Image to draw into.
187+
* @param [in] x X coordinate of the pixel.
188+
* @param [in] y Y coordinate of the pixel.
189+
* @param [in] value New pixel value.
190190
*
191191
* Clipping: pixel is not drawn if coordinate is outside of the image.
192192
*/
@@ -203,11 +203,11 @@ void pbio_image_draw_pixel(pbio_image_t *image, int x, int y, uint8_t value) {
203203

204204
/**
205205
* Draw a horizontal line.
206-
* @param [in,out] image Image to draw into.
207-
* @param [in] x X coordinate of the leftmost pixel.
208-
* @param [in] y Y coordinate of the line.
209-
* @param [in] l Length of the line.
210-
* @param [in] value Pixel value.
206+
* @param [in] image Image to draw into.
207+
* @param [in] x X coordinate of the leftmost pixel.
208+
* @param [in] y Y coordinate of the line.
209+
* @param [in] l Length of the line.
210+
* @param [in] value Pixel value.
211211
*
212212
* Clipping: drawing is clipped to image dimensions.
213213
*/
@@ -232,11 +232,11 @@ void pbio_image_draw_hline(pbio_image_t *image, int x, int y, int l,
232232

233233
/**
234234
* Draw a vertical line.
235-
* @param [in,out] image Image to draw into.
236-
* @param [in] x X coordinate of the line.
237-
* @param [in] y Y coordinate of the topmost pixel.
238-
* @param [in] l Length of the line.
239-
* @param [in] value Pixel value.
235+
* @param [in] image Image to draw into.
236+
* @param [in] x X coordinate of the line.
237+
* @param [in] y Y coordinate of the topmost pixel.
238+
* @param [in] l Length of the line.
239+
* @param [in] value Pixel value.
240240
*
241241
* Clipping: drawing is clipped to image dimensions.
242242
*/
@@ -264,12 +264,12 @@ void pbio_image_draw_vline(pbio_image_t *image, int x, int y, int l,
264264

265265
/**
266266
* Draw a line with a flat slope (less or equal to 1).
267-
* @param [in,out] image Image to draw into.
268-
* @param [in] x1 X coordinate of the first end.
269-
* @param [in] y1 Y coordinate of the first end.
270-
* @param [in] x2 X coordinate of the second end.
271-
* @param [in] y2 Y coordinate of the second end.
272-
* @param [in] value Pixel value.
267+
* @param [in] image Image to draw into.
268+
* @param [in] x1 X coordinate of the first end.
269+
* @param [in] y1 Y coordinate of the first end.
270+
* @param [in] x2 X coordinate of the second end.
271+
* @param [in] y2 Y coordinate of the second end.
272+
* @param [in] value Pixel value.
273273
*
274274
* This is an internal function, x2 must be greater or equal to x1.
275275
*
@@ -332,12 +332,12 @@ static void pbio_image_draw_line_flat(pbio_image_t *image, int x1, int y1,
332332

333333
/**
334334
* Draw a line with a steep slope (more than 1).
335-
* @param [in,out] image Image to draw into.
336-
* @param [in] x1 X coordinate of the first end.
337-
* @param [in] y1 Y coordinate of the first end.
338-
* @param [in] x2 X coordinate of the second end.
339-
* @param [in] y2 Y coordinate of the second end.
340-
* @param [in] value Pixel value.
335+
* @param [in] image Image to draw into.
336+
* @param [in] x1 X coordinate of the first end.
337+
* @param [in] y1 Y coordinate of the first end.
338+
* @param [in] x2 X coordinate of the second end.
339+
* @param [in] y2 Y coordinate of the second end.
340+
* @param [in] value Pixel value.
341341
*
342342
* This is an internal function, y2 must be greater or equal to y1.
343343
*
@@ -400,12 +400,12 @@ static void pbio_image_draw_line_steep(pbio_image_t *image, int x1, int y1,
400400

401401
/**
402402
* Draw a line.
403-
* @param [in,out] image Image to draw into.
404-
* @param [in] x1 X coordinate of the first end.
405-
* @param [in] y1 Y coordinate of the first end.
406-
* @param [in] x2 X coordinate of the second end.
407-
* @param [in] y2 Y coordinate of the second end.
408-
* @param [in] value Pixel value.
403+
* @param [in] image Image to draw into.
404+
* @param [in] x1 X coordinate of the first end.
405+
* @param [in] y1 Y coordinate of the first end.
406+
* @param [in] x2 X coordinate of the second end.
407+
* @param [in] y2 Y coordinate of the second end.
408+
* @param [in] value Pixel value.
409409
*
410410
* Clipping: drawing is clipped to image dimensions.
411411
*/
@@ -435,13 +435,13 @@ void pbio_image_draw_line(pbio_image_t *image, int x1, int y1, int x2, int y2,
435435

436436
/**
437437
* Draw a thick line.
438-
* @param [in,out] image Image to draw into.
439-
* @param [in] x1 X coordinate of the first end.
440-
* @param [in] y1 Y coordinate of the first end.
441-
* @param [in] x2 X coordinate of the second end.
442-
* @param [in] y2 Y coordinate of the second end.
443-
* @param [in] thickness Line thickness.
444-
* @param [in] value Pixel value.
438+
* @param [in] image Image to draw into.
439+
* @param [in] x1 X coordinate of the first end.
440+
* @param [in] y1 Y coordinate of the first end.
441+
* @param [in] x2 X coordinate of the second end.
442+
* @param [in] y2 Y coordinate of the second end.
443+
* @param [in] thickness Line thickness.
444+
* @param [in] value Pixel value.
445445
*
446446
* When line thickness is odd, pixels are centered on the line. When even,
447447
* line is thicker on left side, when looking from first end to second end.
@@ -499,12 +499,12 @@ void pbio_image_draw_thick_line(pbio_image_t *image, int x1, int y1, int x2,
499499

500500
/**
501501
* Draw a rectangle.
502-
* @param [in,out] image Image to draw into.
503-
* @param [in] x X coordinate of the top-left corner.
504-
* @param [in] y Y coordinate of the top-left corner.
505-
* @param [in] width Rectangle width.
506-
* @param [in] height Rectangle height.
507-
* @param [in] value Pixel value.
502+
* @param [in] image Image to draw into.
503+
* @param [in] x X coordinate of the top-left corner.
504+
* @param [in] y Y coordinate of the top-left corner.
505+
* @param [in] width Rectangle width.
506+
* @param [in] height Rectangle height.
507+
* @param [in] value Pixel value.
508508
*
509509
* Clipping: drawing is clipped to image dimensions.
510510
*/
@@ -523,12 +523,12 @@ void pbio_image_draw_rect(pbio_image_t *image, int x, int y, int width,
523523

524524
/**
525525
* Draw a filled rectangle.
526-
* @param [in,out] image Image to draw into.
527-
* @param [in] x X coordinate of the top-left corner.
528-
* @param [in] y Y coordinate of the top-left corner.
529-
* @param [in] width Rectangle width.
530-
* @param [in] height Rectangle height.
531-
* @param [in] value Pixel value.
526+
* @param [in] image Image to draw into.
527+
* @param [in] x X coordinate of the top-left corner.
528+
* @param [in] y Y coordinate of the top-left corner.
529+
* @param [in] width Rectangle width.
530+
* @param [in] height Rectangle height.
531+
* @param [in] value Pixel value.
532532
*
533533
* Clipping: drawing is clipped to image dimensions.
534534
*/
@@ -555,13 +555,13 @@ void pbio_image_fill_rect(pbio_image_t *image, int x, int y, int width,
555555

556556
/**
557557
* Draw a rounded rectangle.
558-
* @param [in,out] image Image to draw into.
559-
* @param [in] x X coordinate of the top-left corner.
560-
* @param [in] y Y coordinate of the top-left corner.
561-
* @param [in] width Rectangle width.
562-
* @param [in] height Rectangle height.
563-
* @param [in] r Corner radius.
564-
* @param [in] value Pixel value.
558+
* @param [in] image Image to draw into.
559+
* @param [in] x X coordinate of the top-left corner.
560+
* @param [in] y Y coordinate of the top-left corner.
561+
* @param [in] width Rectangle width.
562+
* @param [in] height Rectangle height.
563+
* @param [in] r Corner radius.
564+
* @param [in] value Pixel value.
565565
*
566566
* Clipping: drawing is clipped to image dimensions.
567567
*/
@@ -617,13 +617,13 @@ void pbio_image_draw_rounded_rect(pbio_image_t *image, int x, int y,
617617

618618
/**
619619
* Draw a filled rounded rectangle.
620-
* @param [in,out] image Image to draw into.
621-
* @param [in] x X coordinate of the top-left corner.
622-
* @param [in] y Y coordinate of the top-left corner.
623-
* @param [in] width Rectangle width.
624-
* @param [in] height Rectangle height.
625-
* @param [in] r Corner radius.
626-
* @param [in] value Pixel value.
620+
* @param [in] image Image to draw into.
621+
* @param [in] x X coordinate of the top-left corner.
622+
* @param [in] y Y coordinate of the top-left corner.
623+
* @param [in] width Rectangle width.
624+
* @param [in] height Rectangle height.
625+
* @param [in] r Corner radius.
626+
* @param [in] value Pixel value.
627627
*
628628
* Clipping: drawing is clipped to image dimensions.
629629
*/
@@ -676,11 +676,11 @@ void pbio_image_fill_rounded_rect(pbio_image_t *image, int x, int y,
676676

677677
/**
678678
* Draw a circle.
679-
* @param [in,out] image Image to draw into.
680-
* @param [in] x X coordinate of the circle center.
681-
* @param [in] y Y coordinate of the circle center.
682-
* @param [in] r Circle radius.
683-
* @param [in] value Pixel value.
679+
* @param [in] image Image to draw into.
680+
* @param [in] x X coordinate of the circle center.
681+
* @param [in] y Y coordinate of the circle center.
682+
* @param [in] r Circle radius.
683+
* @param [in] value Pixel value.
684684
*
685685
* Clipping: drawing is clipped to image dimensions.
686686
*/
@@ -714,11 +714,11 @@ void pbio_image_draw_circle(pbio_image_t *image, int x, int y, int r,
714714

715715
/**
716716
* Draw a disc.
717-
* @param [in,out] image Image to draw into.
718-
* @param [in] x X coordinate of the disc center.
719-
* @param [in] y Y coordinate of the disc center.
720-
* @param [in] r Disc radius.
721-
* @param [in] value Pixel value.
717+
* @param [in] image Image to draw into.
718+
* @param [in] x X coordinate of the disc center.
719+
* @param [in] y Y coordinate of the disc center.
720+
* @param [in] r Disc radius.
721+
* @param [in] value Pixel value.
722722
*
723723
* Clipping: drawing is clipped to image dimensions.
724724
*/

0 commit comments

Comments
 (0)