https://github.com/xyproto/pixelpusher

:space_invader: Plot pixels on a 320x200 256c canvas
https://github.com/xyproto/pixelpusher

256-colors gamedev go graphics pixel-art rasterization renderer sdl2 software-renderer

Last synced: 20 days ago
JSON representation

:space_invader: Plot pixels on a 320x200 256c canvas

• Host: GitHub
• URL: https://github.com/xyproto/pixelpusher
• Owner: xyproto
• License: bsd-3-clause
• Created: 2018-08-17T10:08:52.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-01-08T12:26:43.000Z (about 1 year ago)
• Last Synced: 2024-12-25T09:23:15.670Z (about 1 month ago)
• Topics: 256-colors, gamedev, go, graphics, pixel-art, rasterization, renderer, sdl2, software-renderer
• Language: Go
• Homepage:
• Size: 38.8 MB
• Stars: 10
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pixelpusher

![Build](https://github.com/xyproto/pixelpusher/workflows/Build/badge.svg)

[![GoDoc](https://godoc.org/github.com/xyproto/pixelpusher?status.svg)](http://godoc.org/github.com/xyproto/pixelpusher)

[![License](http://img.shields.io/badge/license-BSD-green.svg?style=flat)](https://raw.githubusercontent.com/xyproto/pixelpusher/master/LICENSE)

[![Go Report Card](https://goreportcard.com/badge/github.com/xyproto/pixelpusher)](https://goreportcard.com/report/github.com/xyproto/pixelpusher)

Concurrent software rendering, triangle rasterization and pixel buffer manipulation.

![screencap](img/screencap.gif) ![triangles](img/triangles.png)

![butterflies](img/butterfly.png) ![glitch effect](img/strobe.png)

![software rendered duck with glitch effect](img/glitch.png) ![software rendered beveled cube](img/cube.png)

## Features and limitations

* Can draw software-rendered triangles concurrently, using goroutines. The work of drawing the triangles is divided on the available CPU cores.

* Provides flat-shaded triangles.

* Everything is drawn to a `[]uint32` pixel buffer (containing "red", "green", "blue" and "alpha").

* Tested together with SDL2, but can be used with any graphics library that can output pixels from a pixel buffer.

* The software rendering of 3D graphics in the screenshot above is provided by [fauxgl](https://github.com/fogleman/fauxgl). The outputs from this can be combined with effects from `pixelpusher`.

## Getting started

This program imports `pixelpusher`, sets up a callback function for drawing pixels to the `gfx.Pixels` slice, creates a `pixelpusher.Config` struct and then calls the `.Run` function. The window title is `Red Pixel`:

```go

package main

import (

    pp "github.com/xyproto/pixelpusher"

)

func onDraw(canvas *pp.Canvas) error {

    // x=0, y=0, red=255, green=0, blue=0

    return pp.Plot(canvas, 0, 0, 255, 0, 0)

}

func main() {

    // The window title is "Red Pixel"

    canvas := pp.New("Red Pixel")

    // onDraw will be called whenever it is time to draw a frame

    canvas.Run(onDraw, nil, nil, nil)

}

```

This program allows the user to press the arrow keys or the WASD keys to move a red pixel around and draw something. Press `ctrl-s` to save the image and press `Esc` or `q` to quit.

```go

package main

import (

    "errors"

    pp "github.com/xyproto/pixelpusher"

)

var x, y = 160, 100

func onDraw(canvas *pp.Canvas) error {

    return pp.Plot(canvas, x, y, 255, 0, 0)

}

func onPress(left, right, up, down, space, enter, esc bool) error {

    if up {

        y--

    } else if down {

        y++

    }

    if left {

        x--

    } else if right {

        x++

    }

    if esc {

        return errors.New("quit")

    }

    return nil

}

func main() {

    pp.New("Simple Draw").Run(onDraw, onPress, nil, nil)

}

```

# General information

* Version: 1.2.1

* License: BSD-3

* Author: Alexander F. Rødseth <[email protected]>