Skip to content

Commit b6c7815

Browse files
committed
improving rotozoom() argument docstrings
1 parent 6925a00 commit b6c7815

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

shared-bindings/bitmaptools/__init__.c

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,23 +139,29 @@ STATIC void validate_clip_region(displayio_bitmap_t *bitmap, mp_obj_t clip0_tupl
139139
//| :param bitmap dest_bitmap: Destination bitmap that will be copied into
140140
//| :param bitmap source_bitmap: Source bitmap that contains the graphical region to be copied
141141
//| :param int ox: Horizontal pixel location in destination bitmap where source bitmap
142-
//| point (px,py) is placed
142+
//| point (px,py) is placed. Defaults to None which causes it to use the horizontal
143+
//| midway point of the destination bitmap.
143144
//| :param int oy: Vertical pixel location in destination bitmap where source bitmap
144-
//| point (px,py) is placed
145+
//| point (px,py) is placed. Defaults to None which causes it to use the vertical
146+
//| midway point of the destination bitmap.
145147
//| :param Tuple[int,int] dest_clip0: First corner of rectangular destination clipping
146148
//| region that constrains region of writing into destination bitmap
147149
//| :param Tuple[int,int] dest_clip1: Second corner of rectangular destination clipping
148150
//| region that constrains region of writing into destination bitmap
149151
//| :param int px: Horizontal pixel location in source bitmap that is placed into the
150-
//| destination bitmap at (ox,oy)
152+
//| destination bitmap at (ox,oy). Defaults to None which causes it to use the
153+
//| horizontal midway point in the source bitmap.
151154
//| :param int py: Vertical pixel location in source bitmap that is placed into the
152-
//| destination bitmap at (ox,oy)
155+
//| destination bitmap at (ox,oy). Defaults to None which causes it to use the
156+
//| vertical midway point in the source bitmap.
153157
//| :param Tuple[int,int] source_clip0: First corner of rectangular source clipping
154158
//| region that constrains region of reading from the source bitmap
155159
//| :param Tuple[int,int] source_clip1: Second corner of rectangular source clipping
156160
//| region that constrains region of reading from the source bitmap
157-
//| :param float angle: Angle of rotation, in radians (positive is clockwise direction)
158-
//| :param float scale: Scaling factor
161+
//| :param float angle: Angle of rotation, in radians (positive is clockwise direction).
162+
//| Defaults to None which gets treated as 0.0 radians or no rotation.
163+
//| :param float scale: Scaling factor. Defaults to None which gets treated as 1.0 or same
164+
//| as original source size.
159165
//| :param int skip_index: Bitmap palette index in the source that will not be copied,
160166
//| set to None to copy all pixels"""
161167
//| ...

0 commit comments

Comments
 (0)