49 lines
1.7 KiB
Markdown
49 lines
1.7 KiB
Markdown
# gl [](https://travis-ci.org/goxjs/gl) [](https://godoc.org/github.com/fyne-io/gl-js)
|
|
|
|
Package gl is a Go cross-platform binding for OpenGL, with an OpenGL ES 2-like API.
|
|
|
|
It supports:
|
|
|
|
- **macOS**, **Linux** and **Windows** via OpenGL 2.1 backend,
|
|
|
|
- **iOS** and **Android** via OpenGL ES 2.0 backend,
|
|
|
|
- **Modern Browsers** (desktop and mobile) via WebGL 1.0 backend.
|
|
|
|
This is a fork of golang.org/x/mobile/gl package with [CL 8793](https://go-review.googlesource.com/8793)
|
|
merged in and Windows support added. This package is fully functional, but may eventually become superceded by
|
|
the new x/mobile/gl plan. It will exist and be fully supported until it can be safely replaced by a better package.
|
|
|
|
Installation
|
|
------------
|
|
|
|
```bash
|
|
go get -u github.com/fyne-io/gl-js/...
|
|
GOARCH=js go get -u -d github.com/fyne-io/gl-js/...
|
|
```
|
|
|
|
Usage
|
|
-----
|
|
|
|
This OpenGL binding has a ContextWatcher, which implements [glfw.ContextWatcher](https://godoc.org/github.com/goxjs/glfw#ContextWatcher)
|
|
interface. Recommended usage is with github.com/fyne-io/glfw-js package, which accepts a ContextWatcher in its Init, and takes on the responsibility
|
|
of notifying it when context is made current or detached.
|
|
|
|
```Go
|
|
if err := glfw.Init(gl.ContextWatcher); err != nil {
|
|
// Handle error.
|
|
}
|
|
defer glfw.Terminate()
|
|
```
|
|
|
|
If you're not using a ContextWatcher-aware glfw library, you must call methods of gl.ContextWatcher yourself whenever
|
|
you make a context current or detached.
|
|
|
|
```Go
|
|
window.MakeContextCurrent()
|
|
gl.ContextWatcher.OnMakeCurrent(nil)
|
|
|
|
glfw.DetachCurrentContext()
|
|
gl.ContextWatcher.OnDetach()
|
|
```
|