README.md

Fenstim

Fenstim is a Nim wrapper for Fenster, the most minimal cross-platform GUI with 2D canvas library. It provides a simple and efficient way to create graphical applications in Nim.

Implementation status

• Minimal 24-bit RGB framebuffer.
• Application lifecycle and system events are all handled automatically.
• Simple polling API without a need for callbacks or multithreading (like Arduino/Processing).
• Cross-platform keyboard events (keycodes).
• Cross-platform mouse events (X/Y + mouse click).
• Cross-platform timers to have a stable FPS rate. (builtin)
• Cross-platform audio playback (WinMM, CoreAudio, ALSA).

Credits

Project done in collaboration with @ElegantBeef and @morturo at https://forum.nim-lang.org/t/12504

Examples

Basic usage

import fenstim, colors

var app = init(Fenster, "My Window", 800, 600, 60)

if app.loop:
  echo "Window target FPS: ", app.targetFps, ", Resolution: ", app.width, "x", app.height

while app.loop:
  # Set pixel color
  app.pixel(400, 300) = 16711680  # Decimal red
  app.pixel(420, 300) = 0x0000FF  # Hex blue
  pixel(app, 410, 300) = 0x00ff00 # Hex green

  # With colors module
  app.pixel(390, 300) = rgb(255, 0, 0).uint32        # Red
  app.pixel(380, 300) = parseColor("#00FF00").uint32 # Green
  app.pixel(370, 300) = colAliceBlue.uint32          # Alice Blue
  app.pixel(360, 300) = parseColor("silver").uint32  # Silver

  # Get pixel color
  let color = app.pixel(420, 300) # Decimal

  # Check key press if A key is pressed
  if app.keys[ord('A')] == 1:
    echo "A key is pressed"

  # Check if scape key is pressed
  if keys(app)[27] == 1:
    app.close
    break

  # Get mouse position and click state
  if app.mouse.mclick[0] == 1:
    echo "Clicked at: ", app.mouse.pos.x, "x", app.mouse.pos.y

  # Adjust FPS
  app.targetFps = 30

Opens a 60fps 800x600 window, draws a red square and exits when pressing the Escape key:

# examples/red_square.nim
import fenstim

var app = init(Fenster, "Red square with fenstim", 800, 600, 60)

while app.loop and app.keys[27] == 0:
  for x in 350 .. 450:
    for y in 250 .. 350:
      app.pixel(x, y) = 0xFF0000

API usage

Initialization

init*(_: type Fenster, title: string, width, height: int, fps: int = 60): Fenster

Creates a new Fenster window with the specified title, dimensions, and target FPS.

Main Loop

loop*(self: var Fenster): bool

Handles events and updates the display. Returns false when the window should close.

Pixel Manipulation

pixel*(self: Fenster, x, y: int): uint32

Get or set a uint32 pixel color at (x, y).

Window Properties

width*(self: Fenster): int
height*(self: Fenster): int
targetFps*(self: Fenster): int
close*(self: var Fenster)
clear*(self: Fenster)

Input Handling

keys*(self: Fenster): array[256, cint]
mouse*(self: Fenster): tuple[pos: tuple[x, y: int], mclick: array[5, cint], mhold: array[3, cint]]
modkey*(self: Fenster): int

keys = Array of key states. Index corresponds to ASCII value (0-255), but arrows are 17..20.
mouse = Get mouse position (x, y), clicked (left, right, middle, scroll up, scroll down) and holding buttons (left, right, middle)
modkey = 4 bits mask, ctrl=1, shift=2, alt=4, meta=8

Examples

Galery

interactive_julia_set.nim

mandelbrot.nim
threaded_mandelbrot.nim