diff --git a/source/color.c b/source/color.c index bb27e80..a044b99 100644 --- a/source/color.c +++ b/source/color.c @@ -1,3 +1,8 @@ +/*** +The `gfx.color` module +@module ctr.gfx.color +@usage local color = require("ctr.gfx.color") +*/ #include #include @@ -6,18 +11,33 @@ u32 color_default = RGBA8(255, 255, 255, 255); u32 color_background = RGBA8(0, 0, 0, 255); +/*** +Set a color as the default one. +@function setDefault +@tparam integer color the color to set as the default one. +*/ static int color_setDefault(lua_State *L) { color_default = luaL_checkinteger(L, 1); return 0; } +/*** +Return the default color. +@function getDefault +@treturn integer default color +*/ static int color_getDefault(lua_State *L) { lua_pushinteger(L, color_default); return 1; } +/*** +Set a color as the background one. +@function setBackground +@tparam integer color the color to set as the background one. +*/ static int color_setBackground(lua_State *L) { color_background = luaL_checkinteger(L, 1); sf2d_set_clear_color(color_background); @@ -25,12 +45,26 @@ static int color_setBackground(lua_State *L) { return 0; } +/*** +Return the background color. +@function getBackground +@treturn integer background color +*/ static int color_getBackground(lua_State *L) { lua_pushinteger(L, color_background); return 1; } +/*** +Return a color from red, green, blue and alpha values. +@function RGBA8 +@tparam integer r the red value (0-255) +@tparam integer g the green value (0-255) +@tparam integer b the blue value (0-255) +@tparam[opt=255] integer a the alpha (opacity) value (0-255) +@treturn integer the color +*/ static int color_RGBA8(lua_State *L) { int r = luaL_checkinteger(L, 1); int g = luaL_checkinteger(L, 2);