https://github.com/itsyakub/soft

Simple 2D Real-Time Graphics Library
https://github.com/itsyakub/soft

c c-programming c-programming-language c-project cpu cpu-render cpu-rendering graphics graphics-library graphics-programming handmade library open-source sdl sdl2 sdl2-library

Last synced: 24 days ago
JSON representation

Simple 2D Real-Time Graphics Library

• Host: GitHub
• URL: https://github.com/itsyakub/soft
• Owner: itsYakub
• License: mit
• Created: 2024-05-16T17:19:55.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-27T19:05:35.000Z (5 months ago)
• Last Synced: 2024-09-30T01:05:52.821Z (about 1 month ago)
• Topics: c, c-programming, c-programming-language, c-project, cpu, cpu-render, cpu-rendering, graphics, graphics-library, graphics-programming, handmade, library, open-source, sdl, sdl2, sdl2-library
• Language: C
• Homepage:
• Size: 129 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# Soft

**Simple 2D Real-Time Graphics Library**



## Introduction

This project was created purely for learning purposes. It allows me to get the deeper knowledge of how to graphics programming work under the hood. The big source of information was [raylib](https://github.com/raysan5/raylib), a simple and easy-to-use library to enjoy videogames programming. All of the external sources I've used are mentioned as the coude blocks in the `soft.c` implementation file. My main inspirations were:

- ["olive.c" by Tsoding.](https://www.youtube.com/playlist?list=PLpM-Dvs8t0Va-Gb0Dp4d9t8yvNFHaKH6N)

- ["Programming a first person shooter from scratch like it's 1995" by Jdh.](https://www.youtube.com/watch?v=fSjc8vLMg8c)

## Example

```c

#include "soft.h"

int main(int argc, char** argv) {

    softInit(1024, 768, softTextFormat("Soft %s", SOFT_VERSION));

    while(!softWindowShoulClose()) {

        softClearBufferColor(WHITE);

        softDrawCircle((Circle) { softGetWindowCenter(), 100 }, RED);

        softBlit();

    }

    softClose();

    return 0;

}

```

## Setup

### 0. Prerequesites:

- **[Git](https://git-scm.com/);**

- **[CMake](https://cmake.org/);**

### 1. Dependencies:

*(NOTE: All of the external dependencies should be fetched by CMake using FetchContent)*

- **[SDL2](https://www.libsdl.org/);**

### 2. Setup:

- Clone this repository:

    ```console

    $ git clone https://github.com/itsYakub/Soft.git --branch=master --depth=1 

    $ cd Soft/

    ```

- Create a binary directory:

    ```console

    $ mkdir bin

    $ cd bin/

    ```

- Compile the project using **CMake**:

    ```console

    $ cmake ..

    $ cmake --build .

    ```

- Run the executable:

    ```console

    $ ./example/demo.out

    ```

## Credits

- **[Differential Line Algorithm's `Wikipedia` page](https://en.wikipedia.org/wiki/Digital_differential_analyzer_(graphics_algorithm));**

- **[Filled circle drawing algorithm on `Stack Overflow`](https://stackoverflow.com/questions/1201200/fast-algorithm-for-drawing-filled-circles/14976268#14976268);**

- **[Raylib's `TextFormat` solution](https://github.com/raysan5/raylib/blob/master/src/rtext.c#L1408);**

- **[Bresenham's algorithms](https://zingl.github.io/bresenham.html);**

- **[olive.c](https://github.com/tsoding/olive.c)**

## Licence

This project is under the **[MIT Licence]()**.