sdldebug

Documentation

Overview

Package sdldebug implements the GUI interface. Suitable for applications that require a screen and debugging overlays. Currently, it can show:

• alternative "debug" colours
• show a "meta-pixel" overlay (see debugger.reflection package)
• show an unmasked screen, showing off-screen sprite pixels when using debug colors

Index

• type SdlDebug
  • func NewSdlDebug(tv television.Television, scale float32) (*SdlDebug, error)
  • func (scr *SdlDebug) Destroy(output io.Writer)
  • func (scr *SdlDebug) EndRendering() error
  • func (scr *SdlDebug) GetReflectionRenderer() reflection.Renderer
  • func (scr *SdlDebug) NewFrame(frameNum int, _ bool) error
  • func (scr *SdlDebug) NewScanline(scanline int) error
  • func (scr *SdlDebug) Reflect(result reflection.LastResult) error
  • func (scr *SdlDebug) ReqFeature(request gui.FeatureReq, args ...interface{}) (returnedErr error)
  • func (scr *SdlDebug) Resize(_ *television.Specification, topScanline, numScanlines int) error
  • func (scr *SdlDebug) Service()
  • func (scr *SdlDebug) SetPixel(x, y int, red, green, blue byte, vblank bool) error

Types

type SdlDebug

type SdlDebug struct {
	television.Television
	// contains filtered or unexported fields
}

SdlDebug is a simple SDL implementation of the television.PixelRenderer interfac

func NewSdlDebug

func NewSdlDebug(tv television.Television, scale float32) (*SdlDebug, error)

NewSdlDebug is the preferred method of initialisation for SdlDebug.

func (*SdlDebug) Destroy

func (scr *SdlDebug) Destroy(output io.Writer)

Destroy implements GuiCreator interface

func (*SdlDebug) EndRendering

func (scr *SdlDebug) EndRendering() error

EndRendering implements television.PixelRenderer interface

UNUSED

func (*SdlDebug) GetReflectionRenderer

func (scr *SdlDebug) GetReflectionRenderer() reflection.Renderer

GetReflectionRenderer implements the relfection.Broker interface

func (*SdlDebug) NewFrame

func (scr *SdlDebug) NewFrame(frameNum int, _ bool) error

NewFrame implements television.PixelRenderer interface

func (*SdlDebug) NewScanline

func (scr *SdlDebug) NewScanline(scanline int) error

NewScanline implements television.PixelRenderer interface

UNUSED

func (*SdlDebug) Reflect

func (scr *SdlDebug) Reflect(result reflection.LastResult) error

Reflect implements the relfection.Renderer interface

func (*SdlDebug) ReqFeature

func (scr *SdlDebug) ReqFeature(request gui.FeatureReq, args ...interface{}) (returnedErr error)

ReqFeature implements the GUI interface

func (*SdlDebug) Resize

func (scr *SdlDebug) Resize(_ *television.Specification, topScanline, numScanlines int) error

Resize implements television.PixelRenderer interface

MUST NOT be called from #mainthread

func (*SdlDebug) Service

func (scr *SdlDebug) Service()

Service implements GuiCreator interface.

func (*SdlDebug) SetPixel

func (scr *SdlDebug) SetPixel(x, y int, red, green, blue byte, vblank bool) error

SetPixel implements television.PixelRenderer interface