https://github.com/wojciech-graj/termgl

2D & 3D graphics engine in the terminal [C/C++]
https://github.com/wojciech-graj/termgl

3d 3d-graphics c c-plus-plus cli computer-graphics cpp cpp-library graphics graphics-engine graphics-library linux linux-shell terminal terminal-based terminal-graphics unix unix-shell windows

Last synced: 5 days ago
JSON representation

2D & 3D graphics engine in the terminal [C/C++]

• Host: GitHub
• URL: https://github.com/wojciech-graj/termgl
• Owner: wojciech-graj
• License: mit
• Created: 2021-06-25T11:32:47.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-16T18:17:53.000Z (2 months ago)
• Last Synced: 2025-01-15T04:34:33.097Z (12 days ago)
• Topics: 3d, 3d-graphics, c, c-plus-plus, cli, computer-graphics, cpp, cpp-library, graphics, graphics-engine, graphics-library, linux, linux-shell, terminal, terminal-based, terminal-graphics, unix, unix-shell, windows
• Language: C
• Homepage:
• Size: 13.8 MB
• Stars: 315
• Watchers: 5
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# TermGL

A terminal-based graphics library for 2D and 3D graphics.

Features:

- Windows & *NIX support

- C99 compliant without external dependencies

- Custom vertex and pixel shaders

- Affine texture mapping

- 24 bit RGB

- Indexed color mode: 16 Background colors, 16 foreground colors, bold and underline

- Non-blocking input from terminal

- Mouse tracking

### Gallery

![LOGO](https://w-graj.net/images/termgl/logo.gif)

![CUBE](https://w-graj.net/images/termgl/textures.gif)

![CANYON](https://w-graj.net/images/termgl/canyon.gif)

### Build

You can compile `termgl.c` as you would any other C source file. You can also compile it as a shared library `libtermgl.so` by calling `make shared`. To install the shared library, `sudo make install`.

To enable 3D functionality, define `TERMGL3D` or use the `-DTERMGL3D` compiler flag.

To enable utility functions, define `TERMGLUTIL` or use the `-DTERMGLUTIL` compiler flag.

To disable helper functions for vector math and shaders, define `TERMGL_MINIMAL` or use the `-DTERMGL_MINIMAL` compiler flag.

To use TermGL in C++, compile it as a shared library and link against the `libtermgl.so` file. The `termgl.h` header can be included from C++ files.

To compile a demo program, run  `make demo`, creating the `termgl_demo` binary.

### Documentation

The header file `termgl.h` contains brief documentation for all functions and structs. The TermGLUtil extension contains functions for reading keyboard input, but requires either Windows or *NIX headers.

### Demo

A demo program can be found at `demo/termgl_demo.c`.

Available demos and TermGL features used:

1. Utah Teapot\

Renders a rotating 3D Utah Teapot.

	- Backface culling

	- Z buffering

	- Double-width characters

	- 3D rendering

	- Custom shaders

2. Color Palette\

Renders a palette of various text colors and styles.

	- Colors & Modifiers

3. Mandelbrot\

Renders an infinitely zooming-in Mandelbrot set.

	- Point rendering

4. Realtime Keyboard\

Displays keyboard input in realtime.

	- Text rendering

	- Realtime keyboard input

5. Textured Cube\

Renders a texture-mapped cube.

	- Backface culling

	- Z buffering

	- Double-width characters

	- 3D rendering

	- Shaders

	- Texture mapping

6. RGB\

Renders overlapping red, green, and blue circles.

	- 24 bit RGB

	- Text rendering

7. Mouse\

Displays mouse position and button state.

	- Mouse tracking

	- Text rendering