effect

Documentation

Index

• type BasicEffect
  • func (e BasicEffect) Priority() int
  • func (e BasicEffect) Render(time.Time, common.Renderable)
  • func (e *BasicEffect) SetSpan(span common.Spanner)
• type Future
  • func (e Future) Copy() common.Effect
  • func (e *Future) GetStabilizeFuncs() []func(p common.Palette)
  • func (e Future) Render(t time.Time, obj common.Renderable)
  • func (e Future) String() string
• type Solid
  • func (e Solid) Copy() common.Effect
  • func (e *Solid) GetStabilizeFuncs() []func(p common.Palette)
  • func (e Solid) Render(t time.Time, obj common.Renderable)
  • func (e Solid) String() string

Types

type BasicEffect

type BasicEffect struct {
	common.Spanner
	Rank int
}

func (BasicEffect) Priority

func (e BasicEffect) Priority() int

func (BasicEffect) Render

func (e BasicEffect) Render(time.Time, common.Renderable)

Render will alter obj based on its information and alterability

func (*BasicEffect) SetSpan

func (e *BasicEffect) SetSpan(span common.Spanner)

SetSpan sets the start and end of a span from the provided span

type Future

type Future struct {
	BasicEffect
	TimePerLight *time.Duration
	Painter      common.Painter
}

Future is an Effect which displays each consecutive light as the "future" of the previous light

func (Future) Copy

func (e Future) Copy() common.Effect

Copy returns a deep copy of the Effect

func (*Future) GetStabilizeFuncs

func (e *Future) GetStabilizeFuncs() []func(p common.Palette)

GetStabilizeFuncs returns StabilizeFunc for all remaining unstablaized traits

func (Future) Render

func (e Future) Render(t time.Time, obj common.Renderable)

Render will alter obj based on its information and alterability

func (Future) String

func (e Future) String() string

String returns a string representation of the Effect

type Solid

type Solid struct {
	BasicEffect
	Painter common.Painter
}

Solid is an Effect which displays all lights as a single color

func (Solid) Copy

func (e Solid) Copy() common.Effect

Copy returns a deep copy of the Effect

func (*Solid) GetStabilizeFuncs

func (e *Solid) GetStabilizeFuncs() []func(p common.Palette)

GetStabilizeFuncs returns StabilizeFunc for all remaining unstablaized traits

func (Solid) Render

func (e Solid) Render(t time.Time, obj common.Renderable)

Render will alter obj based on its information and alterability

func (Solid) String

func (e Solid) String() string

String returns a string representation of the Effect