https://github.com/mokiat/softgfx

Software Graphics in Go and WebAssembly
https://github.com/mokiat/softgfx

go golang software-rendering wasm webassembly

Last synced: 6 days ago
JSON representation

Software Graphics in Go and WebAssembly

• Host: GitHub
• URL: https://github.com/mokiat/softgfx
• Owner: mokiat
• License: mit
• Created: 2020-03-06T08:40:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-29T09:28:37.000Z (over 2 years ago)
• Last Synced: 2024-06-21T16:43:56.275Z (5 months ago)
• Topics: go, golang, software-rendering, wasm, webassembly
• Language: Go
• Homepage: https://mokiat.com/softgfx/
• Size: 3.04 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Software Graphics

This project demonstrates the implementation of old-school 3D software graphics in [Go](https://golang.org/) and [WebAssembly](https://github.com/golang/go/wiki/WebAssembly).

[![preview](preview.png)](http://mokiat.com/softgfx/index.html)

The demo can be accessed at [http://mokiat.com/softgfx/index.html](http://mokiat.com/softgfx/index.html)

## History

Originally, this project was implemented in Pascal and then in Delphi. I wanted to play around with Go and its WebAssembly support and this seemed like the ideal project to port. 

Along the way, I switched to 32 bit colors, from the original 8 bit ones, increased the resolution, fixed some bugs and improved the code. I also introduced my own level generator that converts obj files into bsp extrusion levels (with a lot of caveats).

I have bundled the application and level generator source code into a single repository (a monorepo). Originally they were split into two separate projects - `space-insomnia` and `space-insomnia-levgen` respectively. I have since renamed the project to a more descriptive, yet short, name.

## Tutorial

While the end result might not be that mesmerizing, when compared to modern hardware-accelerated 3D graphics, the algorithms and optimizations that were used can be quite fascinating, especially for someone that is new to graphics programming. In my early days, seeing how the math, data structures, and algorithms used in a few lines of code can produce something almost tangible inspired me to pursue software development further.

I would like to pass this feeling forward to the few brave individuals that dare to get their hands dirty. I am planning on documenting the main algorithms, equations, and optimizations that were used in the [Wiki](https://github.com/mokiat/softgfx/wiki) section of this project. Hopefully, it serves as a good starting point for anyone that wishes to understand the inner workings of the software renderer.

## References

Implementing the software renderer required the usage of both low-level and high-level optimizations, mathematics, data structures and algorithms. A key source of information has been _Ivaylo Belchev_'s masters thesis and the [BOOM 2 Engine](http://www.geocities.ws/SiliconValley/Bay/2234/boom2.htm).

The level that is shown in the demo was modeled in [Blender](https://www.blender.org), exported to an obj file and converted to an extrusion map with the custom level generator. The textures used were downloaded from [TextureHeaven](https://texturehaven.com/) and downscaled to the required size.

Following are some other interesting resources on the subject matter that I have since come across:

* [Lode's Computer Graphics Tutorial - Raycasting](http://lodev.org/cgtutor/raycasting.html)

* [Fabien Sanglard's Duke Nukem 3D: Build Engine Internals](http://fabiensanglard.net/duke3d/build_engine_internals.php)