Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ProtoTurtle/UnityBitmapDrawing

Bitmap Drawing API extension methods for Unity 3D's Texture2D class
https://github.com/ProtoTurtle/UnityBitmapDrawing

Last synced: 2 days ago
JSON representation

Bitmap Drawing API extension methods for Unity 3D's Texture2D class

Awesome Lists containing this project

README

        

UnityBitmapDrawing
==================

http://prototurtle.com

Bitmap Drawing API extension methods for Unity 3D's Texture2D class.

What is it?
By default, Texture2D only provides the methods SetPixel and GetPixel (and SetPixels and GetPixels). This library extends that functionality with useful basic drawing operations. It outputs pixel perfect and not anti-aliased bitmaps.
```csharp
texture.DrawLine(new Vector2(0,0), new Vector2(100,200), Color.red);
```

x = 0, y = 0 is the top left corner
This library uses the convention of having the left top corner of the bitmap be the 0, 0 position. By default, Texture2D uses the bottom left corner convention which can be confusing for bitmap operations.

Extension Methods
![ScreenShot](https://raw.githubusercontent.com/ProtoTurtle/UnityBitmapDrawing/master/documentation/extensionMethods.png)
C# Extension Methods work in a way that adds methods to a existing class. To start using this, you only need to include the namespace:
```
using ProtoTurtle.BitmapDrawing;
```
Your Texture2D instances will then have all the new methods available.

Features
* DrawPixel(position, color) - Draws a pixel but with the top left corner being position (x = 0, y = 0)
* DrawLine(start, end, color) - Draws a line between two points
* DrawCircle(position, radius, color) - Draws a circle
* DrawFilledCircle(position, radius, color) - Draws a circle filled with a color
* DrawRectangle(rectangle, color) - Draws a rectangle or a square
* DrawFilledRectangle(rectangle, color) - Draws a rectangle or a square filled with a color
* FloodFill(position, color) - Starts a flood fill of a certaing at the point

Example
```csharp
using ProtoTurtle.BitmapDrawing;

// ...

Texture2D texture = new Texture2D(1024, 1024, TextureFormat.RGB24, false, true);
texture.filterMode = FilterMode.Point;
texture.wrapMode = TextureWrapMode.Clamp;
texture.DrawFilledRectangle(new Rect(0, 0, TEXTURE_SIZE, TEXTURE_SIZE), Color.grey);

texture.DrawCircle(100, 100, 20, Color.green);
texture.DrawCircle(80, 150, 5, Color.blue);
texture.DrawCircle(300, 300, 200, Color.black);
texture.FloodFill(100, 100, Color.green);
texture.FloodFill(300, 300, Color.white);
texture.DrawLine(new Vector2(10, 10), new Vector2(400, 200), Color.magenta);
texture.DrawLine(new Vector2(400, 200), new Vector2(100, 200), Color.magenta);
texture.Apply();
```
Output from this example (cropped the image to fit):
![ScreenShot](https://raw.githubusercontent.com/ProtoTurtle/UnityBitmapDrawing/master/documentation/output.png)

Example project
Here is a ready-to-go Unity project for easy testing.
https://github.com/ProtoTurtle/BitmapDrawingExampleProject