Document the color format for clear commands

Kode · Feb 21, 2024 · 8ede7f3 · 8ede7f3
1 parent 78eb9e7
commit 8ede7f3
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/Sources/kinc/graphics4/graphics.h b/Sources/kinc/graphics4/graphics.h
@@ -112,7 +112,7 @@ KINC_FUNC bool kinc_g4_swap_buffers(void);
 /// Clears the color, depth and/or stencil-components of the current framebuffer or render-target.
 /// </summary>
 /// <param name="flags">Defines what components to clear</param>
-/// <param name="color">The color-value to clear to</param>
+/// <param name="color">The color-value to clear to in 0xAARRGGBB</param>
 /// <param name="depth">The depth-value to clear to</param>
 /// <param name="stencil">The stencil-value to clear to</param>
 KINC_FUNC void kinc_g4_clear(unsigned flags, unsigned color, float depth, int stencil);

diff --git a/Sources/kinc/graphics5/commandlist.h b/Sources/kinc/graphics5/commandlist.h
@@ -77,7 +77,7 @@ KINC_FUNC void kinc_g5_command_list_end(kinc_g5_command_list_t *list);
 /// <param name="list">The list to write the command to</param>
 /// <param name="render_target">The render-target to clear</param>
 /// <param name="flags">Defines what components to clear</param>
-/// <param name="color">The color-value to clear to</param>
+/// <param name="color">The color-value to clear to in 0xAARRGGBB</param>
 /// <param name="depth">The depth-value to clear to</param>
 /// <param name="stencil">The stencil-value to clear to</param>
 KINC_FUNC void kinc_g5_command_list_clear(kinc_g5_command_list_t *list, struct kinc_g5_render_target *render_target, unsigned flags, unsigned color,