maprenderer

README

Minetest map renderer library for go

State: WIP

Licenses

Code: MIT

Other assets

• colormapping/testdata/unifieddyes_palette_extended.png GPL 2.0 https://github.com/mt-mods/unifieddyes/blob/master/textures/unifieddyes_palette_extended.png

Documentation

Index

• Constants
• func AddColorComponent(c *color.RGBA, value int) *color.RGBA
• func AdjustAndFill(dc *gg.Context, r, g, b, adjust int)
• func Clamp(num int) uint8
• type IsoDirection
• type IsoRenderer
  • func NewIsoRenderer(cm *colormapping.ColorMapping, mba MapblockAccessor, height int) (*IsoRenderer, error)
  • func (r *IsoRenderer) GetImagePos(x, y, z float64) (float64, float64)
  • func (r *IsoRenderer) Render(pos MapblockPosGetter, y_block_height int, direction IsoDirection) (*image.NRGBA, error)
• type MapRenderer
  • func NewMapRenderer(cm *colormapping.ColorMapping, mba MapblockAccessor, size int) (*MapRenderer, error)
  • func (r *MapRenderer) IsViewBocking(nodename string) bool
  • func (r *MapRenderer) Render(pos MapblockPosGetter, y_block_height int) (*image.NRGBA, error)
• type Mapblock
• type MapblockAccessor
• type MapblockPos
  • func (pos *MapblockPos) GetX() int
  • func (pos *MapblockPos) GetY() int
  • func (pos *MapblockPos) GetZ() int
• type MapblockPosGetter

Examples

• MapRenderer

Constants

const (
	EXPECTED_BLOCKS_PER_FLAT_MAPBLOCK = 16 * 16
)

Functions

func AddColorComponent

func AddColorComponent(c *color.RGBA, value int) *color.RGBA

add a color component (darker, lighter)

func AdjustAndFill

func AdjustAndFill(dc *gg.Context, r, g, b, adjust int)

func Clamp

func Clamp(num int) uint8

limit a number from 0 to 255

Types

type IsoDirection

type IsoDirection uint8

const (
	// default direction, x and z increase
	IsoDirectionNorthEast IsoDirection = 0
	IsoDirectionNorthWest IsoDirection = 1
	IsoDirectionSouthWest IsoDirection = 2
	IsoDirectionSouthEast IsoDirection = 3
)

look direction

type IsoRenderer

type IsoRenderer struct {
	// contains filtered or unexported fields
}

func NewIsoRenderer

func NewIsoRenderer(cm *colormapping.ColorMapping, mba MapblockAccessor, height int) (*IsoRenderer, error)

func (*IsoRenderer) GetImagePos

func (r *IsoRenderer) GetImagePos(x, y, z float64) (float64, float64)

func (*IsoRenderer) Render

func (r *IsoRenderer) Render(pos MapblockPosGetter, y_block_height int, direction IsoDirection) (*image.NRGBA, error)

type MapRenderer

type MapRenderer struct {
	// contains filtered or unexported fields
}

Example

// create color mapping
cm := colormapping.NewColorMapping()

// TODO: implemement mapblock fetching and parsing here
accessor := func(pos MapblockPosGetter) (Mapblock, error) {
	return nil, nil
}

// create renderer with 256 px sidelength
r, err := NewMapRenderer(cm, accessor, 256)
if err != nil {
	panic(err)
}

// render the mapblock at 0,0,0 with 10 mapblocks y-height into an image
img, err := r.Render(&MapblockPos{X: 0, Y: 0, Z: 0}, 10)
if err != nil {
	panic(err)
}

// create an output file
f, err := os.Create("output.png")
if err != nil {
	panic(err)
}

// write to the file
err = png.Encode(f, img)
if err != nil {
	panic(err)
}

func NewMapRenderer

func NewMapRenderer(cm *colormapping.ColorMapping, mba MapblockAccessor, size int) (*MapRenderer, error)

func (*MapRenderer) IsViewBocking

func (r *MapRenderer) IsViewBocking(nodename string) bool

func (*MapRenderer) Render

func (r *MapRenderer) Render(pos MapblockPosGetter, y_block_height int) (*image.NRGBA, error)

type Mapblock

type Mapblock interface {
	GetNodeName(x, y, z int) string
	GetParam2(x, y, z int) int
	IsEmpty() bool
}

type MapblockAccessor

type MapblockAccessor func(pos MapblockPosGetter) (Mapblock, error)

type MapblockPos

type MapblockPos struct {
	X, Y, Z int
}

func (*MapblockPos) GetX

func (pos *MapblockPos) GetX() int

func (*MapblockPos) GetY

func (pos *MapblockPos) GetY() int

func (*MapblockPos) GetZ

func (pos *MapblockPos) GetZ() int

type MapblockPosGetter

type MapblockPosGetter interface {
	GetX() int
	GetY() int
	GetZ() int
}