README.md

Shape Drawer

---

Draws simple shapes like libgdx's ShapeRenderer does, but uses a Batch to perform the drawing.

Comes with overloaded methods to draw lines, paths, ellipses, regular polygons and rectangles. Since it uses a Batch to perform the drawing, it can be used in between Batch#begin() and Batch#end() without needing to flush the Batch.

Just needs to be provided with a Batch (SpriteBatch or PolygonSpriteBatch will work) and a TextureRegion.

---

Including in Project

To use this in your gradle project, add the following to your root build.gradle file:

	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

And in your core project add the dependency:

	dependencies {
	        implementation 'com.github.earlygrey:shapedrawer:master-SNAPSHOT'
	}

See the jitpack website for more info.

Usage

To create a ShapeDrawer instance you just need a Batch and a TextureRegion. Typically this is a single white pixel so that you can easily colour it, and this is best packed into an atlas with your other textures. However for testing purposes you can make one programmatically:

Pixmap pixmap = new Pixmap(1, 1, Format.RGBA8888);
pixmap.setColor(Color.WHITE);
pixmap.drawPixel(0, 0);
texture = new Texture(pixmap); //remember to dispose of later
pixmap.dispose();
TextureRegion region = new TextureRegion(texture, 0, 0, 1, 1);

Then instantiate a ShapeDrawer:

ShapeDrawer drawer = new ShapeDrawer(batch, region);

To use it, simply call its drawing methods in between Batch.begin() and Batch#end(). Something like this:

batch.begin();
drawer.line(0,0,100,100);
batch.end();

That's it!

---

Test application uses the Commodore 64 UI Skin created by Raymond "Raeleus" Buckley under the CC BY license, check out the others!