Bitmap.md

Bitmap

Warning

If all you want is to load grapics, from Images, please read the Graphics & Sound Section first

Sub Package: GoWas/core

A struct holding a slice of uint32 pixels and accompanying MetaData

Constructors

There are 2 ways to create A Bitmap.

func CreateBitmap(
	pixelsPerLine uint16, 	// the PixelWidth of the Bitmap
	pixelMemory *[]uint32	// The Memory containing all individual pixels
) *Bitmap 

//and 

func CreateBitmapFromCompressed(
	pixelsPerLine uint16, 		// the PixelWidth of the Bitmap
	uncompressedLength int, 	// The Total number of pixels in the uncompressed version
	compressedDate *[]uint32	// The Memory containing complressed version of the Bitmap 
) *Bitmap

These 2 are not meant to be used directly for now.

Methods

Once you have access to an Instance of a core.Bitmap you can use the following Methods.

// Get the Full Pixel-Width and Height of the Bitmap
func (me *core.Bitmap) Width() uint16  
func (me *core.Bitmap) Height() uint16 

// To Create a Renderabel Entity out of the Bitmap
func (me *core.Bitmap) MakeEntity() *core.BitmapEntity 

Usage Guide

For GoWas to be able to do anything useful with a Bitmap (Like rendering it), it needs to be converted or passed to a Processor (A Tileset constructor for example).

Bitmap-Entities

If you want to use the Bitmap by itself, it must be converted into a core.BitmapEntity.
you can do this via the MakeEntity() method on the Bitmap.

var bmp *coreBitmap /* = loaded from somewhere */

var entity *core.BitmapEntity = bmp.MakeEntity()

entity.MoveTo(20, 20); //<--Entity should be drawn on coordinates 20, 20
entity.ToCanvas(canvasinstance /*<- also defined somewhere else */)
// See the BitmapEntity Documentation for more options 

TileSets

Bitmaps can also act as a source for a TileSet
, which can then be further converted into a TileMap

var bmp *coreBitmap /* = loaded from somewhere */

var tileSet gfx.TileSet;
tileSet.InitFromMapSheet(bmp, 8, 8) //<-create a tileset where each tile is 8x8 pixels

// ... Further process TIleset into a TileMap
var tileMap gfx.TileMap;
tileMap.Init(&tileSet, 10, 10) //<- create a map of 10x10 tiles