readme.md

go-glx/vgl

VGL is vulkan graphics library

NOT READY FOR ANY REAL USAGE YET (IN DEV)

---

Its primitive 2D-only graphics library for drawing simple staff like circles, boxes, lines, polygons and textures.

Also support custom SPIR-V shaders

This library use Vulkan for sending GPU commands.

Development

Currently package configured for development in go-work namespace (this will not change until 1.0 release)

1. Install vgl, glx and other packages from go.mod into /home/../go/src/github.com/go-glx
2. Add go.work file

go 1.20

use (
	vgl
	vgl/arch/glfw
	vgl/example
	glx
)

3. Run with CG CGO_ENABLED=1 env variable (you need install gcc compiler)

Requirements in host (for lib development)

• gcc
• g++
• deps for chosen window render arch:
  • for glfw: x-libs (see instructions in https://github.com/go-gl/glfw)
  • for opengl: todo
  • for SDL: todo

Usage

This library can be used in high performance and rich graphic applications. (2D Game engines)

3D not supported right now

Arch

vgl -> driver -> GPU
                  |
                  WM

Available drivers:

• vulkan

Available WM:

• glfw
• SDL (todo)

Available GPUs:

• any discrete/integrated/dual(optimus) GPU with shader v1+ support

Current state of dev

Basic triangles rendering:

• shaders rendering
• instancing, optimizations
• buildIn shaders libs: point(+), line(+), circle, triangle(+), rect(+), polygon
• culling in local space
• move arch package to separate go module (go.mod deps split)
• blend modes
• 2d textures
• bunnies stress test
• polish
• tests
  • integrated GPU
  • PRESENT_MODE_MAILBOX_KHR (on integrated GPU)
  • close all todos
• documentation
• release v1.0