graphicscommand

Documentation

Overview

Package graphicscommand represents a low layer for graphics using OpenGL.

Index

• func FlushCommands() error
• func IsShaderAvailable() bool
• func NeedsRestoring() bool
• func ResetGraphicsDriverState() error
• func SetGraphicsDriver(driver driver.Graphics)
• type Image
  • func NewImage(width, height int) *Image
  • func NewScreenFramebufferImage(width, height int) *Image
  • func (i *Image) Dispose()
  • func (i *Image) DrawTriangles(src *Image, vertices []float32, indices []uint16, clr *affine.ColorM, ...)
  • func (i *Image) Dump(path string, blackbg bool) error
  • func (i *Image) InternalSize() (int, int)
  • func (i *Image) IsInvalidated() bool
  • func (i *Image) Pixels() ([]byte, error)
  • func (i *Image) ReplacePixels(pixels []byte, x, y, width, height int)
• type Shader
  • func NewShader(ir *shaderir.Program) *Shader
  • func (s *Shader) Dispose()

Functions

func FlushCommands

func FlushCommands() error

FlushCommands flushes the command queue.

func IsShaderAvailable

func IsShaderAvailable() bool

IsShaderAvailable reports whether shaders are available. This function is only for testing.

func NeedsRestoring

func NeedsRestoring() bool

func ResetGraphicsDriverState

func ResetGraphicsDriverState() error

ResetGraphicsDriverState resets or initializes the current graphics driver state.

func SetGraphicsDriver

func SetGraphicsDriver(driver driver.Graphics)

Types

type Image

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

Image represents an image that is implemented with OpenGL.

func NewImage

func NewImage(width, height int) *Image

NewImage returns a new image.

Note that the image is not initialized yet.

func NewScreenFramebufferImage

func NewScreenFramebufferImage(width, height int) *Image

func (*Image) Dispose

func (i *Image) Dispose()

func (*Image) DrawTriangles

func (i *Image) DrawTriangles(src *Image, vertices []float32, indices []uint16, clr *affine.ColorM, mode driver.CompositeMode, filter driver.Filter, address driver.Address, shader *Shader, uniforms []interface{})

DrawTriangles draws triangles with the given image.

The vertex floats are:

0:  Destination X in pixels
1:  Destination Y in pixels
2:  Source X in pixels (not texels!)
3:  Source Y in pixels
4:  Bounds of the source min X in pixels
5:  Bounds of the source min Y in pixels
6:  Bounds of the source max X in pixels
7:  Bounds of the source max Y in pixels
8:  Color R [0.0-1.0]
9:  Color G
10: Color B
11: Color Y

src and shader are exclusive and only either is non-nil.

The elements that index is in between 2 and 7 are used for the source images. The source image is 1) src argument if non-nil, or 2) an image value in the uniform variables if it exists. If there are multiple images in the uniform variables, the smallest ID's value is adopted.

If the source image is not specified, i.e., src is nil and there is no image in the uniform variables, the elements for the source image are not used.

func (*Image) Dump

func (i *Image) Dump(path string, blackbg bool) error

Dump dumps the image to the specified path. In the path, '*' is replaced with the image's ID.

If blackbg is true, any alpha values in the dumped image will be 255.

This is for testing usage.

func (*Image) InternalSize

func (i *Image) InternalSize() (int, int)

func (*Image) IsInvalidated

func (i *Image) IsInvalidated() bool

func (*Image) Pixels

func (i *Image) Pixels() ([]byte, error)

Pixels returns the image's pixels. Pixels might return nil when OpenGL error happens.

func (*Image) ReplacePixels

func (i *Image) ReplacePixels(pixels []byte, x, y, width, height int)

type Shader

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

func NewShader

func NewShader(ir *shaderir.Program) *Shader

func (*Shader) Dispose

func (s *Shader) Dispose()