options

Documentation

Overview

Package options deals with configuration at the libretro core level. Each core exports a list of variables that can take different values. This package can list them, load them, and save them.

Index

• type Options
  • func New(vars []VariableInterface) (*Options, error)
  • func (o *Options) Save() error
• type Variable
• type VariableInterface

Types

type Options

type Options struct {
	Vars    []*Variable // the variables exposed by the core
	Updated bool        // notify the core that values have been updated

	sync.Mutex
}

Options is a container type for core options internals

func New

func New(vars []VariableInterface) (*Options, error)

New instantiate a core options manager

func (*Options) Save

func (o *Options) Save() error

Save core options to a file

type Variable

type Variable struct {
	Key     string   // unique id of the variable
	Desc    string   // human readable name of the variable
	Choices []string // available values
	Choice  int      // index of the current value
	Default string
}

Variable represents one core option. A variable can take a limited number of values. The possibilities are stored in v.Choices. The current value can be accessed with v.Choices[v.Choice]

type VariableInterface

type VariableInterface interface {
	Key() string
	Desc() string
	Choices() []string
	DefaultValue() string
}

VariableInterface is used as a compatibility layer for old v0 options and v1 options