gui

Documentation

Overview

Package gui is an abstraction layer for real GUI implementations. It defines the Events that can be passed from the GUI to the emulation code and also the Requests that can be made from the emulation code to the GUI. Implementations need to convert their specific signals and requests to and from these abstractions.

Index

• Constants
• type FeatureReq
• type FeatureReqData
• type GUI
• type PlusROMFirstInstallation
• type Stub
  • func (s Stub) GetFeature(request FeatureReq) (FeatureReqData, error)
  • func (s Stub) SetFeature(request FeatureReq, args ...FeatureReqData) error
  • func (s Stub) SetFeatureNoError(request FeatureReq, args ...FeatureReqData)

Constants

const (
	UnsupportedGuiFeature = "unsupported gui feature: %v"
)

Sentinal error returned if GUI does no support requested feature.

Types

type FeatureReq

type FeatureReq string

FeatureReq is used to request the setting of a gui attribute eg. toggling the overlay.

const (
	// set the underlying emulation for the gui.
	ReqSetEmulation FeatureReq = "ReqSetEmulation" // emulation.Emulation

	// notify GUI of emulation state. the GUI should use this to alter how
	// infomration, particularly the display of the PixelRenderer.
	ReqState FeatureReq = "ReqState" // EmulationState

	// whether gui should try to sync with the monitro refresh rate. not all
	// gui modes have to obey this but for presentation/play modes it's a good
	// idea to have it set.
	ReqMonitorSync FeatureReq = "ReqMonitorSync" // bool

	// whether the gui is visible or not. results in an error if requested in
	// playmode.
	ReqSetVisibility FeatureReq = "ReqSetVisibility" // bool

	// put gui output into full-screen mode (ie. no window border and content
	// the size of the monitor).
	ReqFullScreen FeatureReq = "ReqFullScreen" // bool

	// special request for PlusROM cartridges.
	ReqPlusROMFirstInstallation FeatureReq = "ReqPlusROMFirstInstallation" // PlusROMFirstInstallation

	// controller has changed for one of the ports. the string is a description
	// of the controller.
	ReqControllerChange FeatureReq = "ReqControllerChange" // plugging.PortID, plugging.PeripheralID

	ReqCartridgeEvent FeatureReq = "ReqCartridgeEvent" // mapper.Event
)

List of valid feature requests. argument must be of the type specified or else the interface{} type conversion will fail and the application will probably crash.

Note that, like the name suggests, these are requests, they may or may not be satisfied depending other conditions in the GUI.

type FeatureReqData

type FeatureReqData interface{}

FeatureReqData represents the information associated with a FeatureReq. See commentary for the defined FeatureReq values for the underlying type.

type GUI

type GUI interface {
	// Send a request to set a GUI feature.
	SetFeature(request FeatureReq, args ...FeatureReqData) error

	// Same as SetFeature() but not waiting for the result. Useful in time
	// critical situations when you are absolutely sure there will be no
	// errors that need handling.
	SetFeatureNoError(request FeatureReq, args ...FeatureReqData)

	// Return current state of GUI feautre.
	GetFeature(request FeatureReq) (FeatureReqData, error)
}

GUI defines the operations that can be performed on visual user interfaces.

type PlusROMFirstInstallation

type PlusROMFirstInstallation struct {
	Finish chan error
	Cart   *plusrom.PlusROM
}

PlusROMFirstInstallation is used to pass information to the GUI as part of the request.

type Stub

type Stub struct{}

func (Stub) GetFeature

func (s Stub) GetFeature(request FeatureReq) (FeatureReqData, error)

GetFeature implements the GUI interface.

func (Stub) SetFeature

func (s Stub) SetFeature(request FeatureReq, args ...FeatureReqData) error

SetFeature implements the GUI interface.

func (Stub) SetFeatureNoError

func (s Stub) SetFeatureNoError(request FeatureReq, args ...FeatureReqData)

SetFeatureNoError implements the GUI interface.