README
¶
luapixels
The beginnings of what could be a game engine for using GLFW + Go + Lua.
Example use
main.go:
package main
import (
"log"
_ "embed"
"github.com/xyproto/luapixels"
)
//go:embed game.lua
var luaCode string
func main() {
if err := luapixels.Run(luaCode); err != nil {
log.Fatalln(err)
}
}
game.lua:
window_title = "Simple Example"
function at_start()
print("hi")
-- Set color at palette index 7 to red (RGB 255, 0, 0)
setpal(7, 255, 0, 0)
end
function at_every_frame()
-- Set the background color to blue (RGB 0, 128, 255)
background(0, 128, 255)
-- At (100, 100), draw a red pixel (index 7 in the palette)
plot(100, 100, 7)
end
function at_key_pressed()
quit()
end
function at_end()
print("bye!")
end
Performance
There is a lot of room for improvements when it comes to performance, since this implementation is fresh and not yet optimized.
The pixels are quads right now, but a texture could be used instead. This would require no changes from the Lua code, though.
General info
- License: BSD-3
- Version: 0.0.0
Documentation
¶
Index ¶
- func CallLuaFunction(L *lua.LState, funcName string) error
- func ClearScreen()
- func DrawBackground(r, g, b byte)
- func GLSetColor(c color.RGBA)
- func GetLuaGlobalString(L *lua.LState, variableName string) (string, error)
- func GetPaletteColor(colorIndex byte) (byte, byte, byte)
- func GetPixel(x, y int) byte
- func InitAudio() error
- func InitGL(window *glfw.Window) error
- func PlaySound(frequency float32, duration int) error
- func PutPixel(x, y int, colorIndex byte)
- func Run(luaCode string) error
- func RunFile(luaFilename string) error
- func SetPaletteColor(colorIndex, r, g, b byte)
- func UpdateScreen(window *glfw.Window)
- type PixelSlice
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CallLuaFunction ¶
CallLuaFunction calls a Lua function by name.
func DrawBackground ¶
func DrawBackground(r, g, b byte)
DrawBackground sets the entire background to a specified color
func GetLuaGlobalString ¶
GetLuaGlobalString fetches the value of a global Lua variable as a string.
func GetPaletteColor ¶
GetPaletteColor retrieves the r,g,b colors of a given palette index.
func SetPaletteColor ¶
func SetPaletteColor(colorIndex, r, g, b byte)
SetPaletteColor sets a color in the palette.
func UpdateScreen ¶
UpdateScreen swaps the buffers and displays the rendered frame.
Types ¶
type PixelSlice ¶
type PixelSlice [width * height]byte
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.