Home /Modules/ballum/README.md

README.md

lib/ballum/examples/README.md · 31 line(s) · markdown

Ballum Examples

These examples demonstrate the SLeeLa-facing Ballum API and its native bridge boundary. They complement the aggregate demos in the parent directory; they do not replace testing on a real display.

Start Here

ExampleFocusNotes
01-screen-inspection.sleelaEnumerate displays and inspect geometry/capabilitiesRequires the host's Ballum VM bridge
02-safe-pixel.sleelaValidate coordinates and issue a single pixel writeDeliberately includes an out-of-bounds case
03-display-controls.sleelaBrightness, warmth, and gammaEach control is capability-gated
04-input-polling.sleelaBounded pointer-event pollingDoes not wait indefinitely
05-headless-safe.sleelaExercise honest failure pathsSuitable for headless smoke tests when bridge symbols are available

Running

From the repository root, use the compiler/runtime commands documented by the SLeeLa build instructions. For example, where sleelvac is installed:

sleelvac lib/ballum/examples/01-screen-inspection.sleela

If your local toolchain separates compilation and execution, follow its documented invocation. These examples target SLeeLa 2.1 syntax, matching the current Ballum demo files.

Safety