viewport

Documentation

Index

• type Component
• type ComponentFactory
  • func (concrete *ComponentFactory) Add(id akara.EID) *Viewport
  • func (concrete *ComponentFactory) ExportToLua(_ *lua.LState, table *lua.LTable) *lua.LTable
  • func (concrete *ComponentFactory) Get(id akara.EID) (*Viewport, bool)
• type Viewport
  • func (component *Viewport) ExportToLua(_ *lua.LState, table *lua.LTable) *lua.LTable
  • func (*Viewport) New() akara.Component

Types

type Component

type Component = Viewport // Component is an alias to Viewport

type ComponentFactory

type ComponentFactory struct {
	*akara.ComponentFactory
}

ComponentFactory is a wrapper for the generic viewport component factory.

func (*ComponentFactory) Add

func (concrete *ComponentFactory) Add(id akara.EID) *Viewport

Add adds a Viewport component to the given entity and returns it

func (*ComponentFactory) ExportToLua

func (concrete *ComponentFactory) ExportToLua(_ *lua.LState, table *lua.LTable) *lua.LTable

ExportToLua exports the component into the given table, using the given lua state machine.

func (*ComponentFactory) Get

func (concrete *ComponentFactory) Get(id akara.EID) (*Viewport, bool)

Get returns the Viewport component for the given entity, and a bool for whether or not it exists

type Viewport

type Viewport struct {
	CameraEntity akara.EID
	Background   color.Color
}

Viewport represents a rendering viewport within a scene. This consists of a camera and background color.

func (*Viewport) ExportToLua

func (component *Viewport) ExportToLua(_ *lua.LState, table *lua.LTable) *lua.LTable

ExportToLua exports the component into the given table, using the given lua state machine.

func (*Viewport) New

func (*Viewport) New() akara.Component

New creates a new viewport