gl

Documentation

Overview

Package gl provides a full Fyne render implementation using system OpenGL libraries.

Index

• type Attribute
• type Buffer
• type Painter
  • func NewPainter(c fyne.Canvas, ctx driver.WithContext) Painter
• type Program
• type Shader
• type Texture
• type Uniform

Types

type Attribute

type Attribute gl.Attrib

Attribute represents a GL attribute

type Buffer

type Buffer gl.Buffer

Buffer represents a GL buffer

type Painter

type Painter interface {
	// Init tell a new painter to initialise, usually called after a context is available
	Init()
	// Capture requests that the specified canvas be drawn to an in-memory image
	Capture(fyne.Canvas) image.Image
	// Clear tells our painter to prepare a fresh paint
	Clear()
	// Free is used to indicate that a certain canvas object is no longer needed
	Free(fyne.CanvasObject)
	// Paint a single fyne.CanvasObject but not its children.
	Paint(fyne.CanvasObject, fyne.Position, fyne.Size)
	// SetFrameBufferScale tells us when we have more than 1 framebuffer pixel for each output pixel
	SetFrameBufferScale(float32)
	// SetOutputSize is used to change the resolution of our output viewport
	SetOutputSize(int, int)
	// StartClipping tells us that the following paint actions should be clipped to the specified area.
	StartClipping(fyne.Position, fyne.Size)
	// StopClipping stops clipping paint actions.
	StopClipping()
}

Painter defines the functionality of our OpenGL based renderer

func NewPainter

func NewPainter(c fyne.Canvas, ctx driver.WithContext) Painter

NewPainter creates a new GL based renderer for the provided canvas. If it is a master painter it will also initialise OpenGL

type Program

type Program gl.Program

Program represents a compiled GL program

type Shader

type Shader gl.Shader

Shader represents a GL shader

type Texture

type Texture cache.TextureType

Texture represents an uploaded GL texture

type Uniform

type Uniform gl.Uniform

Uniform represents a GL uniform