From 71e438865ad50c7dea00946d1ac6570f038318d4 Mon Sep 17 00:00:00 2001 From: KikooDX Date: Sun, 12 Apr 2020 18:48:22 +0200 Subject: [PATCH] (README.md) Started documentation --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1045c2e..a398ad6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ -# sprito +# Sprito +CG-50 Python drawing framework -CG-50 Python drawing framework. -Early Access. \ No newline at end of file +## 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.