framebuffer

Documentation

Overview

Package framebuffer provides a convenient way of working with OpenGL framebuffers

Index

• type FBO
• type Flip
  • func NewFlip(clearOnRender bool) *Flip
  • func (fb *Flip) Clear()
  • func (fb *Flip) Copy(src FBO) uint32
  • func (fb *Flip) Destroy()
  • func (fb *Flip) Dimensions() (width int32, height int32)
  • func (fb *Flip) Process(draw func()) uint32
  • func (fb *Flip) Setup(width int32, height int32) bool
  • func (fb *Flip) Texture() uint32
• type Single
  • func NewSingle(clearOnRender bool) *Single
  • func (fb *Single) Clear()
  • func (fb *Single) Copy(src FBO) uint32
  • func (fb *Single) Destroy()
  • func (fb *Single) Dimensions() (width int32, height int32)
  • func (fb *Single) Process(draw func()) uint32
  • func (fb *Single) Setup(width int32, height int32) bool
  • func (fb *Single) Texture() uint32

Types

type FBO

type FBO interface {
	// contains filtered or unexported methods
}

type Flip

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

Flip provides a two paged framebuffer

func NewFlip

func NewFlip(clearOnRender bool) *Flip

NewFlip is the preferred method of initialisation of the Flip type

func (*Flip) Clear

func (fb *Flip) Clear()

func (*Flip) Copy

func (fb *Flip) Copy(src FBO) uint32

Copy another framebuffer to the Flip instance. Framebuffers must be of the same dimensions

func (*Flip) Destroy

func (fb *Flip) Destroy()

Destroy should be called when the Flip is no longer required

func (*Flip) Dimensions

func (fb *Flip) Dimensions() (width int32, height int32)

Dimensions returns the width and height of the frame buffer used in the Flip

func (*Flip) Process

func (fb *Flip) Process(draw func()) uint32

Process the Flip using the suppied draw function. The draw function should typically invoke a GLSL shader. The texture ID of the shader will be returned by the Process function. This is ID is the same as the ID returned by the Texture() function

func (*Flip) Setup

func (fb *Flip) Setup(width int32, height int32) bool

Setup Flip for specified dimensions

Returns true if any previous texture data has been lost. This can happen when the dimensions have changed. By definition, the first call to Setup() will always return false.

If the supplied width or height are less than zero the function will return false with no explanation.

func (*Flip) Texture

func (fb *Flip) Texture() uint32

Texture returns the texture ID of the last Flip texture to be processed. Using this ID can be an effective way of chaining shaders

type Single

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

Single provides a single framebuffer

func NewSingle

func NewSingle(clearOnRender bool) *Single

NewFlip is the preferred method of initialisation of the Single type

func (*Single) Clear

func (fb *Single) Clear()

func (*Single) Copy

func (fb *Single) Copy(src FBO) uint32

Copy another framebuffer to the Single instance. Framebuffers must be of the same dimensions

func (*Single) Destroy

func (fb *Single) Destroy()

Destroy should be called when the Single is no longer required

func (*Single) Dimensions

func (fb *Single) Dimensions() (width int32, height int32)

Dimensions returns the width and height of the frame buffer used in the Single

func (*Single) Process

func (fb *Single) Process(draw func()) uint32

Process the Single using the suppied draw function. The draw function should typically invoke a GLSL shader. The texture ID of the shader will be returned by the Process function. This is ID is the same as the ID returned by the Texture() function.

func (*Single) Setup

func (fb *Single) Setup(width int32, height int32) bool

Setup Single for specified dimensions

Returns true if any previous texture data has been lost. This can happen when the dimensions have changed. By definition, the first call to Setup() will always return false.

If the supplied width or height are less than zero the function will return false with no explanation.

func (*Single) Texture

func (fb *Single) Texture() uint32

Texture returns the texture ID used by the single framebuffer