atlas

Documentation

Index

• Variables
• func BeginFrame(graphicsDriver graphicsdriver.Graphics) error
• func DumpImages(graphicsDriver graphicsdriver.Graphics, dir string) (string, error)
• func EndFrame() error
• func SwapBuffers(graphicsDriver graphicsdriver.Graphics) error
• type Image
  • func NewImage(width, height int, imageType ImageType) *Image
  • func (i *Image) Deallocate()
  • func (i *Image) DrawTriangles(srcs [graphics.ShaderSrcImageCount]*Image, vertices []float32, ...)
  • func (i *Image) DumpScreenshot(graphicsDriver graphicsdriver.Graphics, path string, blackbg bool) (string, error)
  • func (i *Image) ReadPixels(graphicsDriver graphicsdriver.Graphics, pixels []byte, region image.Rectangle) (ok bool, err error)
  • func (i *Image) WritePixels(pix []byte, region image.Rectangle)
• type ImageType
• type Shader
  • func NewShader(ir *shaderir.Program, name string) *Shader
  • func (s *Shader) Deallocate()

Variables

var (
	NearestFilterShader = &Shader{shader: restorable.NearestFilterShader}
	LinearFilterShader  = &Shader{shader: restorable.LinearFilterShader}
)

Functions

func BeginFrame

func BeginFrame(graphicsDriver graphicsdriver.Graphics) error

func DumpImages

func DumpImages(graphicsDriver graphicsdriver.Graphics, dir string) (string, error)

func EndFrame

func EndFrame() error

func SwapBuffers

func SwapBuffers(graphicsDriver graphicsdriver.Graphics) error

Types

type Image

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

Image is a rectangle pixel set that might be on an atlas.

func NewImage

func NewImage(width, height int, imageType ImageType) *Image

func (*Image) Deallocate

func (i *Image) Deallocate()

Deallocate deallocates the internal state. Even after this call, the image is still available as a new cleared image.

func (*Image) DrawTriangles

func (i *Image) DrawTriangles(srcs [graphics.ShaderSrcImageCount]*Image, vertices []float32, indices []uint32, blend graphicsdriver.Blend, dstRegion image.Rectangle, srcRegions [graphics.ShaderSrcImageCount]image.Rectangle, shader *Shader, uniforms []uint32, fillRule graphicsdriver.FillRule, hint restorable.Hint)

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 (the upper-left is (0, 0))
3: Source Y in pixels
4: Color R [0.0-1.0]
5: Color G
6: Color B
7: Color Y

func (*Image) DumpScreenshot

func (i *Image) DumpScreenshot(graphicsDriver graphicsdriver.Graphics, path string, blackbg bool) (string, error)

func (*Image) ReadPixels

func (i *Image) ReadPixels(graphicsDriver graphicsdriver.Graphics, pixels []byte, region image.Rectangle) (ok bool, err error)

func (*Image) WritePixels

func (i *Image) WritePixels(pix []byte, region image.Rectangle)

WritePixels replaces the pixels on the image.

type ImageType

type ImageType int

ImageType represents the type of an image.

const (
	// ImageTypeRegular is a regular image, that can be on a big texture atlas (backend).
	ImageTypeRegular ImageType = iota

	// ImageTypeScreen is a screen image that is not on an atlas.
	// A screen image is also unmanaged.
	ImageTypeScreen

	// ImageTypeVolatile is a volatile image that is cleared every frame.
	// A volatile image is also unmanaged.
	ImageTypeVolatile

	// ImageTypeUnmanaged is an unmanaged image that is not on an atlas.
	ImageTypeUnmanaged
)

type Shader

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

func NewShader

func NewShader(ir *shaderir.Program, name string) *Shader

func (*Shader) Deallocate

func (s *Shader) Deallocate()

Deallocate deallocates the internal state.