kdx
/
sprito
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(README.md) Started documentation

This commit is contained in:
KikooDX 2020-04-12 18:48:22 +02:00
parent 85b5d24449
commit 71e438865a
1 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,4 +1,23 @@
# sprito
# Sprito
CG-50 Python drawing framework
CG-50 Python drawing framework.
Early Access.
## Drawing functions
`rect(x: int, y: int, w: int, h: int, color: tuple) -> None` :
Draw a rectangle with the given **color** from (**x**;**y**) of size **w**
(width) times **h** (height).
`fill_screen(color: tuple) -> None` :
Fill the screen with the given **color**.
`invert_pixel(x: int, y: int) -> None` :
Invert the pixel color at (**x**;**y**).
`invert_rect(x: int, y: int, w: int, h: int) -> None` :
Invert all the pixels of the rectangle from (**x**;**y**) of size **w** (width)
times **h** (height).
## Sprite classes (WIP)
`SpriteIndexed` : indexed sprite. Draw using pallets.
`SpriteRaw` : raw sprite, usually heavier than an indexed sprite but faster to
draw.