Introduction

This is Silk - 2D single-header graphics library. The soul-purpose of this library is to give you the front-end for rendering graphics immediately to the screen. Everything works on CPU, completely on stack. Note that you MUST provide your own rendering and/or windowing back-end to work with Silk.

#include "your_backend_of_choosing.h"

#define SILK_PIXELBUFFER_WIDTH 800
#define SILK_PIXELBUFFER_HEIGHT 600

#define SILK_IMPLEMENTATION
#include "../../silk.h"

i32 main(i32 argc, const string argv[]) {
    // Setting-up the main pixel-buffer
    pixel buffer[SILK_PIXELBUFFER_WIDTH * SILK_PIXELBUFFER_HEIGHT] = { 0 };

    // Set-up your back-end here ...

    while(true) {
        // Clearing the pixel-buffer to white (0xffffffff -> #FFFFFFFF -> WHITE)
        silkClearPixelBufferColor(buffer, 0xffffffff);

        // Draw the red rectangle at the position in the middle of the pixel-buffer
        silkDrawRect(
            buffer,                                                             // pixel-buffer
            (vec2i) { SILK_PIXELBUFFER_WIDTH, SILK_PIXELBUFFER_HEIGHT },        // pixel-buffer size
            SILK_PIXELBUFFER_WIDTH,                                             // pixel-buffer stride
            (vec2i) { SILK_PIXELBUFFER_CENTER_X, SILK_PIXELBUFFER_CENTER_Y },   // The position where we want to draw our red rectangle
            (vec2i) { 64, 64 },                                                 // The size of our red rectangle
            0xff0000ff                                                          // The color of our rectangle (0xff0000ff -> #FF0000FF -> RED)
        );

        // ... Blit your graphics using your back-end ...
    }

    // ... close your back-end here

    return 0;
}

Check out examples to see how you can do this with some of the most popular libraries! If you wish to extand the list of examples, check out the example template. You can also use it to build your application using Silk!

You can also check out TODO.md file to see the possible additions in the future!

Lastly, check out the docs for documentation.

Setup

1. Getting started

Get the silk.h header file into your project:

• You can download the file directly form GitHub
• You can clone this repository ...

$ git clone https://github.com/itsYakub/Silk.git

... and then provide the directory to include silk.h into your project

2. Project setup

Design of the single-header libraries allows us to simply include the header file in your project:

#include "silk.h"

WARNING: You must, at least and no more than only once, provide the special macro SILK_IMPLEMENTATION in one of your source files, before the include directive:

#define SILK_IMPLEMENTATION
#include "silk.h"

This macro tells the preprocessor to not only include the function declarations, but also their defnitions.

• Not calling this macro ever in your project causes the undefined reference to .. error.
• Calling this macro multiple time throughout the project causes the multiple definitions of .. error.

Examples

This is the list of available examples provided by Silk:

• PPM Example
• X11 Example
• SDL Example
• Raylib Example
• STB_Image Example
• RGFW Example

Credits

1. Inspiration:

• Olive.c
• Programming a first person shooter from scratch like it's 1995
• nothings/stb

2. Sources:

• My previous project: Soft
• DDA Algorithm / Line-Drawing algorithm
• Circle-Drawing algorithm
• Triangle-Drawing algorithm
• Equations for equilateral triangle vertices

Licence

This project is under the MIT Licence.