improving rotozoom() argument docstrings

This commit is contained in:
foamyguy 2022-06-10 18:01:02 -05:00
parent 6925a00138
commit b6c7815f83
1 changed files with 12 additions and 6 deletions

View File

@ -139,23 +139,29 @@ STATIC void validate_clip_region(displayio_bitmap_t *bitmap, mp_obj_t clip0_tupl
//| :param bitmap dest_bitmap: Destination bitmap that will be copied into //| :param bitmap dest_bitmap: Destination bitmap that will be copied into
//| :param bitmap source_bitmap: Source bitmap that contains the graphical region to be copied //| :param bitmap source_bitmap: Source bitmap that contains the graphical region to be copied
//| :param int ox: Horizontal pixel location in destination bitmap where source bitmap //| :param int ox: Horizontal pixel location in destination bitmap where source bitmap
//| point (px,py) is placed //| point (px,py) is placed. Defaults to None which causes it to use the horizontal
//| midway point of the destination bitmap.
//| :param int oy: Vertical pixel location in destination bitmap where source bitmap //| :param int oy: Vertical pixel location in destination bitmap where source bitmap
//| point (px,py) is placed //| point (px,py) is placed. Defaults to None which causes it to use the vertical
//| midway point of the destination bitmap.
//| :param Tuple[int,int] dest_clip0: First corner of rectangular destination clipping //| :param Tuple[int,int] dest_clip0: First corner of rectangular destination clipping
//| region that constrains region of writing into destination bitmap //| region that constrains region of writing into destination bitmap
//| :param Tuple[int,int] dest_clip1: Second corner of rectangular destination clipping //| :param Tuple[int,int] dest_clip1: Second corner of rectangular destination clipping
//| region that constrains region of writing into destination bitmap //| region that constrains region of writing into destination bitmap
//| :param int px: Horizontal pixel location in source bitmap that is placed into the //| :param int px: Horizontal pixel location in source bitmap that is placed into the
//| destination bitmap at (ox,oy) //| destination bitmap at (ox,oy). Defaults to None which causes it to use the
//| horizontal midway point in the source bitmap.
//| :param int py: Vertical pixel location in source bitmap that is placed into the //| :param int py: Vertical pixel location in source bitmap that is placed into the
//| destination bitmap at (ox,oy) //| destination bitmap at (ox,oy). Defaults to None which causes it to use the
//| vertical midway point in the source bitmap.
//| :param Tuple[int,int] source_clip0: First corner of rectangular source clipping //| :param Tuple[int,int] source_clip0: First corner of rectangular source clipping
//| region that constrains region of reading from the source bitmap //| region that constrains region of reading from the source bitmap
//| :param Tuple[int,int] source_clip1: Second corner of rectangular source clipping //| :param Tuple[int,int] source_clip1: Second corner of rectangular source clipping
//| region that constrains region of reading from the source bitmap //| region that constrains region of reading from the source bitmap
//| :param float angle: Angle of rotation, in radians (positive is clockwise direction) //| :param float angle: Angle of rotation, in radians (positive is clockwise direction).
//| :param float scale: Scaling factor //| Defaults to None which gets treated as 0.0 radians or no rotation.
//| :param float scale: Scaling factor. Defaults to None which gets treated as 1.0 or same
//| as original source size.
//| :param int skip_index: Bitmap palette index in the source that will not be copied, //| :param int skip_index: Bitmap palette index in the source that will not be copied,
//| set to None to copy all pixels""" //| set to None to copy all pixels"""
//| ... //| ...