gogl

README

GoGL utils

A set of utilities for using openGl with go in the context of 3d games

Documentation

Index

• func BindTexture(id TextureID)
• func BindVertexArray(id BufferID)
• func BufferData[T any](target uint32, data []T, usage uint32)
• func Cos32(x float32) float32
• func Cos32Deg(x float32) float32
• func GetVersion() string
• func Mod32(a, b float32) float32
• func SetupFPSWindow(title string, width, height int32) (window *sdl.Window, cleanup func())
• func Sin32(x float32) float32
• func Sin32Deg(x float32) float32
• func TriangleNormal(p1, p2, p3 mgl32.Vec3) mgl32.Vec3
• func UseProgram(id ProgramID)
• type BufferID
  • func GenBindBuffer(target uint32) BufferID
  • func GenBindVertexArray() BufferID
• type BufferLayout
  • func NewBufferLayout[T any](segments []int32, data []T) BufferLayout[T]
• type BufferLoader
  • func NewBufferLoader() *BufferLoader
  • func (b *BufferLoader) BuildFloatBuffer(id BufferID, layout BufferLayout[float32])
• type Camera
  • func NewCamera(pos, worldUp mgl32.Vec3, yaw, pitch, speed, sensitivity float32) *Camera
  • func (c *Camera) GetViewMatrix() mgl32.Mat4
  • func (c *Camera) UpdateCamera(dir MovementDirs, deltaTime, mouseDx, mouseDy float32)
• type EmbeddedShader
  • func NewEmbeddedShader(vertShader string, fragShader string) *EmbeddedShader
  • func (s *EmbeddedShader) CheckShadersForChanges()
  • func (s *EmbeddedShader) SetFloat(name string, value float32)
  • func (s *EmbeddedShader) SetMatrix4(name string, value mgl32.Mat4)
  • func (s *EmbeddedShader) SetVec3(name string, value mgl32.Vec3)
  • func (s *EmbeddedShader) Use()
• type MovementDirs
  • func NewMoveDirs(f, b, r, l, u, d bool) MovementDirs
• type Object
  • func Cube(size float32) Object
  • func Pentahedron(size float32) Object
  • func (o *Object) CalcNormals(triangleCount int)
  • func (o Object) Draw(shader Shader, drawMatrix mgl32.Mat4)
  • func (o Object) DrawMultiple(shader Shader, num int, drawMatrix func(int) mgl32.Mat4)
  • func (o *Object) FillBuffers()
• type ProgramID
  • func CreateProgram(vertPath string, fragPath string) ProgramID
  • func CreateProgramFromShaders(vertShader string, fragShader string) ProgramID
• type Shader
• type ShaderID
  • func CreateShader(shaderSource string, shaderType uint32) ShaderID
  • func LoadShader(path string, shaderType uint32) ShaderID
• type ShaderWithPaths
  • func NewShaderFromFilePaths(vertPath string, fragPath string) *ShaderWithPaths
  • func (s *ShaderWithPaths) CheckShadersForChanges()
  • func (s *ShaderWithPaths) SetFloat(name string, value float32)
  • func (s *ShaderWithPaths) SetMatrix4(name string, value mgl32.Mat4)
  • func (s *ShaderWithPaths) SetVec3(name string, value mgl32.Vec3)
  • func (s *ShaderWithPaths) Use()
• type TextureID
  • func GenBindTexture() TextureID
  • func LoadTexture(filename string) TextureID
  • func LoadTextureFromImage(img image.Image) TextureID

Functions

func BindTexture

func BindTexture(id TextureID)

binds a texture to gl.TEXTURE_2D from its texture id

func BindVertexArray

func BindVertexArray(id BufferID)

func BufferData

func BufferData[T any](target uint32, data []T, usage uint32)

used for initialising the target with the go array at data a more go-esque wrapper for the gl.BufferData function

func Cos32

func Cos32(x float32) float32

func Cos32Deg

func Cos32Deg(x float32) float32

func GetVersion

func GetVersion() string

func Mod32

func Mod32(a, b float32) float32

func SetupFPSWindow

func SetupFPSWindow(title string, width, height int32) (window *sdl.Window, cleanup func())

sets up a window with openGL and sdl this window behaves like an fps game where the mouse is in relative mode

func Sin32

func Sin32(x float32) float32

func Sin32Deg

func Sin32Deg(x float32) float32

func TriangleNormal

func TriangleNormal(p1, p2, p3 mgl32.Vec3) mgl32.Vec3

func UseProgram

func UseProgram(id ProgramID)

Types

type BufferID

type BufferID uint32

func GenBindBuffer

func GenBindBuffer(target uint32) BufferID

used for generating and binding general buffers e.g. VertexBufferObject or NormalArrayObject

func GenBindVertexArray

func GenBindVertexArray() BufferID

used for generating and binding vertex buffers

type BufferLayout

type BufferLayout[T any] struct {
	// contains filtered or unexported fields
}

func NewBufferLayout

func NewBufferLayout[T any](segments []int32, data []T) BufferLayout[T]

type BufferLoader

type BufferLoader struct {
	// contains filtered or unexported fields
}

func NewBufferLoader

func NewBufferLoader() *BufferLoader

func (*BufferLoader) BuildFloatBuffer

func (b *BufferLoader) BuildFloatBuffer(id BufferID, layout BufferLayout[float32])

type Camera

type Camera struct {
	Pos mgl32.Vec3

	Up      mgl32.Vec3
	Right   mgl32.Vec3
	Forward mgl32.Vec3

	WorldUp mgl32.Vec3

	Yaw   float32
	Pitch float32

	MovementSpeed    float32
	MouseSensitivity float32
	Zoom             float32
}

func NewCamera

func NewCamera(pos, worldUp mgl32.Vec3, yaw, pitch, speed, sensitivity float32) *Camera

func (*Camera) GetViewMatrix

func (c *Camera) GetViewMatrix() mgl32.Mat4

func (*Camera) UpdateCamera

func (c *Camera) UpdateCamera(dir MovementDirs, deltaTime, mouseDx, mouseDy float32)

type EmbeddedShader

type EmbeddedShader struct {
	// contains filtered or unexported fields
}

func NewEmbeddedShader

func NewEmbeddedShader(vertShader string, fragShader string) *EmbeddedShader

func (*EmbeddedShader) CheckShadersForChanges

func (s *EmbeddedShader) CheckShadersForChanges()

func (*EmbeddedShader) SetFloat

func (s *EmbeddedShader) SetFloat(name string, value float32)

func (*EmbeddedShader) SetMatrix4

func (s *EmbeddedShader) SetMatrix4(name string, value mgl32.Mat4)

func (*EmbeddedShader) SetVec3

func (s *EmbeddedShader) SetVec3(name string, value mgl32.Vec3)

func (*EmbeddedShader) Use

func (s *EmbeddedShader) Use()

type MovementDirs

type MovementDirs struct {
	Forward int
	Right   int
	Up      int
}

func NewMoveDirs

func NewMoveDirs(f, b, r, l, u, d bool) MovementDirs

type Object

type Object struct {
	Type         string
	Verticies    []float32 //in XYZ UV
	VertexStride int       // 5 if using XYZ UV
	// contains filtered or unexported fields
}

func Cube

func Cube(size float32) Object

func Pentahedron

func Pentahedron(size float32) Object

func (*Object) CalcNormals

func (o *Object) CalcNormals(triangleCount int)

func (Object) Draw

func (o Object) Draw(shader Shader, drawMatrix mgl32.Mat4)

func (Object) DrawMultiple

func (o Object) DrawMultiple(shader Shader, num int, drawMatrix func(int) mgl32.Mat4)

func (*Object) FillBuffers

func (o *Object) FillBuffers()

type ProgramID

type ProgramID uint32

func CreateProgram

func CreateProgram(vertPath string, fragPath string) ProgramID

func CreateProgramFromShaders

func CreateProgramFromShaders(vertShader string, fragShader string) ProgramID

type Shader

type Shader interface {
	CheckShadersForChanges()
	Use()

	SetFloat(name string, value float32)
	SetVec3(name string, value mgl32.Vec3)
	SetMatrix4(name string, value mgl32.Mat4)
}

type ShaderID

type ShaderID uint32

func CreateShader

func CreateShader(shaderSource string, shaderType uint32) ShaderID

func LoadShader

func LoadShader(path string, shaderType uint32) ShaderID

type ShaderWithPaths

type ShaderWithPaths struct {
	// contains filtered or unexported fields
}

func NewShaderFromFilePaths

func NewShaderFromFilePaths(vertPath string, fragPath string) *ShaderWithPaths

func (*ShaderWithPaths) CheckShadersForChanges

func (s *ShaderWithPaths) CheckShadersForChanges()

func (*ShaderWithPaths) SetFloat

func (s *ShaderWithPaths) SetFloat(name string, value float32)

func (*ShaderWithPaths) SetMatrix4

func (s *ShaderWithPaths) SetMatrix4(name string, value mgl32.Mat4)

func (*ShaderWithPaths) SetVec3

func (s *ShaderWithPaths) SetVec3(name string, value mgl32.Vec3)

func (*ShaderWithPaths) Use

func (s *ShaderWithPaths) Use()

type TextureID

type TextureID uint32

func GenBindTexture

func GenBindTexture() TextureID

generates a new nexture ID and binds it to gl.TEXTURE_2D

func LoadTexture

func LoadTexture(filename string) TextureID

func LoadTextureFromImage

func LoadTextureFromImage(img image.Image) TextureID