From 8155eade51a897da19d7e3758e68251f2bd0b066 Mon Sep 17 00:00:00 2001 From: dario-loi Date: Sun, 24 Nov 2024 13:42:44 +0100 Subject: Fixed example code in README.md Example code now correctly declares a fbgl_t buffer and passes it to relevant functions, also, fbgl_get_{width,height} are renamed to the kernel functions fb_get_{width,height} as a library-provided wrapper is non-existent (and probably unnecessary). --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d324714..ee279d0 100644 --- a/README.md +++ b/README.md @@ -40,31 +40,36 @@ No installation is required! Simply copy the `fbgl.h` file into your project dir Here’s a simple program that initializes the framebuffer, clears it to a blue color, and draws a red diagonal line. ```c -#include #include "fbgl.h" +#define FBGL_IMPLEMENTATION +#include + +int main() +{ + + fbgl_t buffer; -int main() { // Initialize the framebuffer - if (fbgl_init("/dev/fb0") != 0) { + if (fbgl_init("/dev/fb0", &buffer) != 0) { fprintf(stderr, "Failed to initialize framebuffer\n"); return 1; } - printf("Framebuffer size: %dx%d\n", fbgl_get_width(), fbgl_get_height()); + printf("Framebuffer size: %dx%d\n", fb_get_width(), fb_get_height()); // Clear framebuffer to blue fbgl_clear(0x0000FFFF); // Blue color // Draw a red diagonal line - for (int i = 0; i < fbgl_get_width() && i < fbgl_get_height(); i++) { - fbgl_put_pixel(i, i, 0xFFFF0000); // Red + for (int i = 0; i < fb_get_width() && i < fb_get_height(); i++) { + fbgl_put_pixel(i, i, 0xFFFF0000, &buffer); // Red } // Wait for user input before exiting getchar(); // Clean up - fbgl_destroy(); + fbgl_destroy(&buffer); return 0; } ``` -- cgit v1.2.3 From f1cde5cdc57e18a455859582ee2fd56b6e61c714 Mon Sep 17 00:00:00 2001 From: dario-loi Date: Sun, 24 Nov 2024 13:45:32 +0100 Subject: Specified the need for implementation macro in README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee279d0..a564393 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,11 @@ ### Installation -No installation is required! Simply copy the `fbgl.h` file into your project directory and include it in your source files. +No installation is required! Simply copy the `fbgl.h` file into your project directory and include it in your source files, +while also defining the `FBGL_IMPLEMENTATION` macro in one of your source files. ```c +#define FBGL_IMPLEMENTATION #include "fbgl.h" ``` -- cgit v1.2.3