Package ballum
01-screen-inspection #sleela 2.5 (lib/ballum/examples/01-screen-inspection.sleela)
BallumScreenInspection class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
main | void main() | No description in source. |
02-safe-pixel #sleela 2.5 (lib/ballum/examples/02-safe-pixel.sleela)
BallumSafePixel class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
inBounds | boolean inBounds(int x, int y, int w, int h) | No description in source. |
main | void main() | No description in source. |
03-display-controls #sleela 2.5 (lib/ballum/examples/03-display-controls.sleela)
BallumDisplayControls class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
has | boolean has(int caps, int bit) | No description in source. |
main | void main() | No description in source. |
04-input-polling #sleela 2.5 (lib/ballum/examples/04-input-polling.sleela)
BallumInputPolling class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
main | void main() | No description in source. |
05-headless-safe #sleela 2.5 (lib/ballum/examples/05-headless-safe.sleela)
BallumHeadlessSafe class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
main | void main() | No description in source. |
ballum #sleela 2.5 (lib/ballum/ballum.sleela)
Ballum class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
width | int width | --- a single display's facts --- |
height | int height | No description in source. |
caps | int caps | No description in source. |
handle | int handle | --- manager state --- VM-local bridge index; <0 means no bridge |
lastStatus | int lastStatus | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
init | void init() | No description in source. |
nativeReady | boolean nativeReady() | No description in source. |
bind | void bind(int h) | No description in source. |
has | boolean has(int cap) | No description in source. |
contains | boolean contains(int x, int y) | No description in source. |
clampBrightness | int clampBrightness(int p) | No description in source. |
clampWarmth | int clampWarmth(int k) | No description in source. |
statusText | String statusText(int code) | No description in source. |
setPixel | int setPixel(int x, int y) | No description in source. |
setBrightness | int setBrightness(int percent) | No description in source. |
setWarmth | int setWarmth(int kelvin) | No description in source. |
main | void main() | No description in source. |
ballum-live #sleela 2.5 (lib/ballum/ballum-live.sleela)
BallumLive class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
capHas | boolean capHas(int caps, int bit) | No description in source. |
main | void main() | No description in source. |
input-demo #sleela 2.5 (lib/ballum/input-demo.sleela)
InputDemo class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
NONE | static final int NONE = 0 | No description in source. |
DOWN | static final int DOWN = 1 | No description in source. |
MOVE | static final int MOVE = 2 | No description in source. |
CLICK | static final int CLICK = 3 | No description in source. |
DRAG_BEGIN | static final int DRAG_BEGIN = 4 | No description in source. |
DRAG_MOVE | static final int DRAG_MOVE = 5 | No description in source. |
DRAG_END | static final int DRAG_END = 6 | No description in source. |
dragThreshold | int dragThreshold | No description in source. |
pressed | int pressed | No description in source. |
dragging | int dragging | No description in source. |
downX | int downX | No description in source. |
downY | int downY | No description in source. |
curX | int curX | No description in source. |
curY | int curY | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
init | void init() | No description in source. |
absDiff | int absDiff(int a, int b) | No description in source. |
fold | int fold(int raw) | No description in source. |
name | String name(int g) | No description in source. |
main | void main() | No description in source. |
screen-demo #sleela 2.5 (lib/ballum/screen-demo.sleela)
ScreenDemo class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
boundId | int boundId | No description in source. |
w | int w | No description in source. |
h | int h | No description in source. |
caps | int caps | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
capHas | boolean capHas(int bit) | No description in source. |
inBounds | boolean inBounds(int x, int y) | No description in source. |
statusText | String statusText(int code) | No description in source. |
open | int open() | Open the primary display and cache its facts. |
plot | int plot(int x, int y, int r, int g, int b) | plot(x,y,...): one pixel-accurate write, validated before dispatch. |
main | void main() | No description in source. |
session-demo #sleela 2.5 (lib/ballum/session-demo.sleela)
SessionDemo class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
state | int state | run states (mirror SLBallumSession): 0 idle, 1 running, 2 frame, 3 exit |
frame | int frame | No description in source. |
fadeFrames | int fadeFrames | No description in source. |
effect | int effect | No description in source. |
boundId | int boundId | No description in source. |
w | int w | No description in source. |
h | int h | No description in source. |
caps | int caps | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
param | String param(String name, String fallback) | No description in source. |
strToInt | int strToInt(String s, int fallback) | No description in source. |
capHas | boolean capHas(int bit) | No description in source. |
start | int start() | No description in source. |
paintWhite | void paintWhite() | fill the entire display white, pixel by pixel through the accurate bridge |
escPressed | void escPressed() | one ESC press: running -> frame, frame -> exit |
step | int step() | step(): poll ESC, advance the logo fade one frame, return the run state |
fadePercent | int fadePercent() | No description in source. |
stateName | String stateName(int s) | No description in source. |
main | void main() | No description in source. |
SLBallumColor #sleela 2.5 (lib/ballum/SLBallumColor.sleela)
SLBallumColor class
An 8-bit RGBA color, mirroring ballum_color_t.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
r | int r | No description in source. |
g | int g | No description in source. |
b | int b | No description in source. |
a | int a | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
clampChannel | int clampChannel(int v) | No description in source. |
setRgb | void setRgb(int red, int green, int blue) | No description in source. |
setRgba | void setRgba(int red, int green, int blue, int alpha) | No description in source. |
red | int red() | No description in source. |
green | int green() | No description in source. |
blue | int blue() | No description in source. |
alpha | int alpha() | No description in source. |
packed | int packed() | Pack to 0xAARRGGBB for a caller that wants a single int handle. |
SLBallumDisplay #sleela 2.5 (lib/ballum/SLBallumDisplay.sleela)
SLBallumDisplay class
A connected display description, mirroring ballum_display_t.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
CAP_NONE | static final int CAP_NONE = 0 | --- capability flags (mirror ballum_capability_t) --- |
CAP_PER_PIXEL | static final int CAP_PER_PIXEL = 1 | 1 << 0 |
CAP_REGION_BLIT | static final int CAP_REGION_BLIT = 2 | 1 << 1 |
CAP_BRIGHTNESS | static final int CAP_BRIGHTNESS = 4 | 1 << 2 |
CAP_COLOR_TEMPERATURE | static final int CAP_COLOR_TEMPERATURE = 8 | 1 << 3 |
CAP_GAMMA | static final int CAP_GAMMA = 16 | 1 << 4 |
id | int id | No description in source. |
name | String name | No description in source. |
width | int width | No description in source. |
height | int height | No description in source. |
refreshMilliHz | int refreshMilliHz | No description in source. |
primary | int primary | 1 if the primary display |
capabilities | int capabilities | OR of CAP_* flags |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure(int displayId, String displayName, int w, int h) | No description in source. |
setCapabilities | void setCapabilities(int caps) | No description in source. |
setPrimary | void setPrimary(boolean isPrimary) | No description in source. |
displayId | int displayId() | No description in source. |
displayName | String displayName() | No description in source. |
pixelWidth | int pixelWidth() | No description in source. |
pixelHeight | int pixelHeight() | No description in source. |
isPrimary | boolean isPrimary() | No description in source. |
has | boolean has(int cap) | Capability queries a GUI checks before enabling a control. |
supportsPerPixel | boolean supportsPerPixel() | No description in source. |
supportsBlit | boolean supportsBlit() | No description in source. |
supportsBrightness | boolean supportsBrightness() | No description in source. |
supportsColorTemperature | boolean supportsColorTemperature() | No description in source. |
supportsGamma | boolean supportsGamma() | No description in source. |
contains | boolean contains(int x, int y) | Is (x, y) a valid pixel on this display? |
SLBallumEffect #sleela 2.5 (lib/ballum/SLBallumEffect.sleela)
SLBallumEffect class
The catalog of Ballum transition effects a session uses to reveal a logo over a background across its fade timeline. Each effect id mirrors the native ballum_effects.h / ballum_fx_t set one-for-one; the native compositor (uiBallumLogoBlend) applies the chosen effect per frame. Effects are deliberately broad and fun: fades, wipes, iris, bars/blinds, dissolve, pixelate, slides, zoom, spotlight, ripple, checker, diamond, a radial clock wipe, and sparkle. Pick one with id() or byName(); a session passes the id to uiBallumLogoSetEffect before its fade. Family: ballum. Pure catalog; the compositing lives in native code.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
FADE | static final int FADE = 0 | effect ids -- must match ballum_fx_t in ballum/include/.../ballum_effects.h |
WIPE_LEFT | static final int WIPE_LEFT = 1 | No description in source. |
WIPE_RIGHT | static final int WIPE_RIGHT = 2 | No description in source. |
WIPE_UP | static final int WIPE_UP = 3 | No description in source. |
WIPE_DOWN | static final int WIPE_DOWN = 4 | No description in source. |
IRIS_IN | static final int IRIS_IN = 5 | No description in source. |
IRIS_OUT | static final int IRIS_OUT = 6 | No description in source. |
BARS | static final int BARS = 7 | No description in source. |
BLINDS | static final int BLINDS = 8 | No description in source. |
DISSOLVE | static final int DISSOLVE = 9 | No description in source. |
PIXELATE | static final int PIXELATE = 10 | No description in source. |
SLIDE_LEFT | static final int SLIDE_LEFT = 11 | No description in source. |
SLIDE_UP | static final int SLIDE_UP = 12 | No description in source. |
ZOOM | static final int ZOOM = 13 | No description in source. |
SPOTLIGHT | static final int SPOTLIGHT = 14 | No description in source. |
RIPPLE | static final int RIPPLE = 15 | No description in source. |
CHECKER | static final int CHECKER = 16 | No description in source. |
DIAMOND | static final int DIAMOND = 17 | No description in source. |
CLOCK | static final int CLOCK = 18 | No description in source. |
SPARKLE | static final int SPARKLE = 19 | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
count | int count() | How many effects the native catalog advertises (authoritative). |
name | String name(int fx) | The lowercase name of an effect id (e.g. 5 -> "iris-in"). |
byName | int byName(String n) | Resolve an effect id by name; unknown names resolve to FADE. |
catalog | String catalog() | A newline-separated listing of every effect: "id name". |
SLBallumInput #sleela 2.5 (lib/ballum/SLBallumInput.sleela)
SLBallumInput class
The Ballum touchscreen + mouse input listener (click, move, drag).
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
NONE | static final int NONE = 0 | --- gesture codes --- |
DOWN | static final int DOWN = 1 | No description in source. |
MOVE | static final int MOVE = 2 | No description in source. |
CLICK | static final int CLICK = 3 | No description in source. |
DRAG_BEGIN | static final int DRAG_BEGIN = 4 | No description in source. |
DRAG_MOVE | static final int DRAG_MOVE = 5 | No description in source. |
DRAG_END | static final int DRAG_END = 6 | No description in source. |
RAW_NONE | static final int RAW_NONE = 0 | --- raw native event types (ballum_event_type_t) --- |
RAW_DOWN | static final int RAW_DOWN = 1 | No description in source. |
RAW_MOVE | static final int RAW_MOVE = 2 | No description in source. |
RAW_UP | static final int RAW_UP = 3 | No description in source. |
dragThreshold | int dragThreshold | Movement (in pixels) past which a press becomes a drag rather than a click. |
pressed | int pressed | Pressed-gesture state. 1 while a button/finger is down |
dragging | int dragging | 1 once movement crossed the threshold |
downX | int downX | where the press started |
downY | int downY | No description in source. |
curType | int curType | The latched current event, for accessor reads after poll(). raw type of the last polled event |
curX | int curX | No description in source. |
curY | int curY | No description in source. |
curButton | int curButton | No description in source. |
curSource | int curSource | 0 mouse, 1 touch |
curContact | int curContact | No description in source. |
curModifiers | int curModifiers | No description in source. |
lastGesture | int lastGesture | the gesture poll() last returned |
KEY_NONE | static final int KEY_NONE = 0 | --- key codes (ballum_key_t) --- |
KEY_ENTER | static final int KEY_ENTER = 13 | No description in source. |
KEY_ESC | static final int KEY_ESC = 27 | No description in source. |
KEY_SPACE | static final int KEY_SPACE = 32 | No description in source. |
curKey | int curKey | the last key poll_key() returned (0 none) |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure() | No description in source. |
setDragThreshold | void setDragThreshold(int px) | No description in source. |
available | boolean available() | Is a pointer-input backend available on this host? |
hasKeyboard | boolean hasKeyboard() | Is a keyboard backend available on this host? |
pollKey | int pollKey() | pollKey(): dequeue one key, returning its code (0 none, 27 ESC, 13 ENTER, 32 SPACE, printable ASCII as itself). Fail closed: a host with no keyboard backend always returns KEY_NONE, never a false key. |
key | int key() | No description in source. |
isEscape | boolean isEscape() | No description in source. |
absDiff | int absDiff(int a, int b) | |a - b| for the threshold test. |
poll | int poll() | poll(): dequeue one raw event and fold it into the gesture state machine. Returns a gesture code (see the class header). Call repeatedly until it returns NONE to drain all input for this frame. |
gesture | int gesture() | ---- accessors for the latched event / gesture ---------------------- |
rawType | int rawType() | No description in source. |
x | int x() | No description in source. |
y | int y() | No description in source. |
button | int button() | No description in source. |
source | int source() | 0 mouse, 1 touch |
contact | int contact() | No description in source. |
modifiers | int modifiers() | No description in source. |
isTouch | boolean isTouch() | No description in source. |
isMouse | boolean isMouse() | No description in source. |
isPressed | boolean isPressed() | No description in source. |
isDragging | boolean isDragging() | No description in source. |
pressX | int pressX() | The start point of the current press/drag. |
pressY | int pressY() | No description in source. |
snapshot | SLBallumPointerEvent snapshot() | Build an SLBallumPointerEvent snapshot of the latched raw event, for code that prefers a value object over the inline accessors. |
gestureName | String gestureName(int g) | No description in source. |
SLBallumManager #sleela 2.5 (lib/ballum/SLBallumManager.sleela)
SLBallumManager class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
STATE_NEW | static final int STATE_NEW = 0 | No description in source. |
STATE_BRIDGE_READY | static final int STATE_BRIDGE_READY = 1 | No description in source. |
STATE_ENUMERATED | static final int STATE_ENUMERATED = 2 | No description in source. |
BRIGHTNESS_MIN | static final int BRIGHTNESS_MIN = 0 | Documented native ranges (mirror ballum_manager.h). |
BRIGHTNESS_MAX | static final int BRIGHTNESS_MAX = 100 | No description in source. |
WARMTH_MIN_KELVIN | static final int WARMTH_MIN_KELVIN = 1000 | No description in source. |
WARMTH_NEUTRAL_K | static final int WARMTH_NEUTRAL_K = 6500 | No description in source. |
WARMTH_MAX_KELVIN | static final int WARMTH_MAX_KELVIN = 10000 | No description in source. |
GAMMA_SCALE | static final int GAMMA_SCALE = 100 | gamma 2.20 is encoded as 220 |
GAMMA_MIN | static final int GAMMA_MIN = 10 | 0.10 |
GAMMA_MAX | static final int GAMMA_MAX = 1000 | 10.00 |
nativeHandle | int nativeHandle | VM-local bridge index, not a native pointer |
state | int state | No description in source. |
lastStatus | int lastStatus | No description in source. |
displayCount | int displayCount | No description in source. |
status | SLBallumStatus status | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure() | No description in source. |
bindNativeHandle | boolean bindNativeHandle(int handle) | Bind the VM-side native handle (returned by the host bridge). A negative handle means the backend is unavailable on this host. |
nativeReady | boolean nativeReady() | No description in source. |
handle | int handle() | No description in source. |
managerState | int managerState() | No description in source. |
statusCode | int statusCode() | No description in source. |
statusText | String statusText() | No description in source. |
displays | int displays() | No description in source. |
clampBrightness | int clampBrightness(int percent) | ---- clamps (mirror ballum_clamp_*) -------------------------------- |
clampWarmth | int clampWarmth(int kelvin) | No description in source. |
clampGamma | int clampGamma(int gammaScaled) | No description in source. |
acceptEnumerateResult | int acceptEnumerateResult(int statusCode, int count) | ---- enumeration ---------------------------------------------------- acceptEnumerateResult: the host bridge calls this with the native status and the display count after ballum_manager_enumerate runs. |
requestSetPixel | int requestSetPixel(SLBallumDisplay display, int x, int y, SLBallumColor color) | ---- per-pixel ------------------------------------------------------ requestSetPixel: validate against the display before asking the bridge. Returns OK when the request is well-formed and may be dispatched, else a failing status that the caller surfaces without touching the device. |
requestGetPixel | int requestGetPixel(SLBallumDisplay display, int x, int y) | No description in source. |
requestBlit | int requestBlit(SLBallumDisplay display, int x, int y, int w, int h, int pixelCount) | requestBlit: the rectangle must be inside the display and the pixel count must equal width*height. |
requestBrightness | int requestBrightness(SLBallumDisplay display, int percent) | ---- whole-display controls ----------------------------------------- Each returns the value to hand the native layer (already clamped), via lastStatus = OK, or a failing status when unsupported / no bridge. |
requestWarmth | int requestWarmth(SLBallumDisplay display, int kelvin) | No description in source. |
requestGamma | int requestGamma(SLBallumDisplay display, int gammaScaled) | No description in source. |
reset | void reset() | No description in source. |
backendSupported | boolean backendSupported() | 1 if a real per-OS backend is compiled in, 0 if the fallback. |
backendName | String backendName() | No description in source. |
enumerate | int enumerate() | Enumerate displays; records the count and marks the manager ENUMERATED. |
displayIdAt | int displayIdAt(int index) | No description in source. |
displayNameAt | String displayNameAt(int index) | No description in source. |
displayWidthAt | int displayWidthAt(int index) | No description in source. |
displayHeightAt | int displayHeightAt(int index) | No description in source. |
displayPrimaryAt | boolean displayPrimaryAt(int index) | No description in source. |
displayCapsAt | int displayCapsAt(int index) | No description in source. |
setPixel | int setPixel(int id, int x, int y, SLBallumColor color) | Set a pixel's color on display `id`. Returns the native status. |
getPixelPacked | int getPixelPacked(int id, int x, int y) | Read a pixel; returns packed 0xAARRGGBB, or -1 on failure. |
setBrightness | int setBrightness(int id, int percent) | Whole-display controls (clamped locally, then dispatched to native). |
setWarmth | int setWarmth(int id, int kelvin) | No description in source. |
setGamma | int setGamma(int id, int gammaScaled) | No description in source. |
hasSurface | boolean hasSurface(int id) | ---- fullscreen surface: total, owned, fast per-pixel control ------- Does display `id` offer a claimable fullscreen framebuffer surface? |
claimSurface | int claimSurface(int id) | Claim an override-redirect fullscreen surface over display `id`. While claimed, setPixel writes to an in-memory framebuffer (no device round- trips) and present() pushes the whole frame in one shot. |
present | int present(int id) | Push the claimed framebuffer to the screen (one native XPutImage; MIT-SHM when available). |
releaseSurface | int releaseSurface(int id) | Release the claimed surface; drawing reverts to the live-desktop fallback. |
SLBallumPointerEvent #sleela 2.5 (lib/ballum/SLBallumPointerEvent.sleela)
SLBallumPointerEvent class
One Ballum pointer (mouse/touch) event, mirroring ballum_pointer_event_t.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
TYPE_NONE | static final int TYPE_NONE = 0 | --- event type (mirror ballum_event_type_t) --- |
TYPE_DOWN | static final int TYPE_DOWN = 1 | No description in source. |
TYPE_MOVE | static final int TYPE_MOVE = 2 | No description in source. |
TYPE_UP | static final int TYPE_UP = 3 | No description in source. |
BUTTON_NONE | static final int BUTTON_NONE = 0 | --- button (mirror ballum_pointer_button_t) --- |
BUTTON_LEFT | static final int BUTTON_LEFT = 1 | No description in source. |
BUTTON_MIDDLE | static final int BUTTON_MIDDLE = 2 | No description in source. |
BUTTON_RIGHT | static final int BUTTON_RIGHT = 3 | No description in source. |
SOURCE_MOUSE | static final int SOURCE_MOUSE = 0 | --- source (mirror ballum_pointer_source_t) --- |
SOURCE_TOUCH | static final int SOURCE_TOUCH = 1 | No description in source. |
MOD_SHIFT | static final int MOD_SHIFT = 1 | --- modifier bits (mirror BALLUM_MOD_*) --- |
MOD_CTRL | static final int MOD_CTRL = 2 | No description in source. |
MOD_ALT | static final int MOD_ALT = 4 | No description in source. |
MOD_SUPER | static final int MOD_SUPER = 8 | No description in source. |
type | int type | No description in source. |
x | int x | No description in source. |
y | int y | No description in source. |
button | int button | No description in source. |
source | int source | No description in source. |
contactId | int contactId | No description in source. |
modifiers | int modifiers | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure(int evType, int px, int py, int evButton, | No description in source. |
eventType | int eventType() | No description in source. |
posX | int posX() | No description in source. |
posY | int posY() | No description in source. |
pointerButton | int pointerButton() | No description in source. |
pointerSource | int pointerSource() | No description in source. |
touchContact | int touchContact() | No description in source. |
modifierMask | int modifierMask() | No description in source. |
isDown | boolean isDown() | No description in source. |
isMove | boolean isMove() | No description in source. |
isUp | boolean isUp() | No description in source. |
isNone | boolean isNone() | No description in source. |
isTouch | boolean isTouch() | No description in source. |
isMouse | boolean isMouse() | No description in source. |
isLeft | boolean isLeft() | No description in source. |
hasModifier | boolean hasModifier(int bit) | No description in source. |
shift | boolean shift() | No description in source. |
ctrl | boolean ctrl() | No description in source. |
alt | boolean alt() | No description in source. |
SLBallumScreen #sleela 2.5 (lib/ballum/SLBallumScreen.sleela)
SLBallumScreen class
The clean, pixel-accurate Screen API for Ballum developers.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
manager | SLBallumManager manager | the low-level bridge-boundary driver |
status | SLBallumStatus status | result-code text |
boundIndex | int boundIndex | enumerate() index of the bound display, or -1 |
boundId | int boundId | native display id of the bound display, or -1 |
w | int w | cached width (pixels) of the bound display |
h | int h | cached height (pixels) of the bound display |
caps | int caps | cached capability bitmask of the bound display |
lastStatus | int lastStatus | the status of the most recent operation |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
create | void create() | Prepare the Screen. Call open()/openIndex() before drawing. |
attach | boolean attach(int nativeHandle) | Bind the native backend handle the host VM provides. A negative handle means no display backend is available on this host. |
open | int open() | open(): enumerate displays and bind the primary one (or display 0 if no display is flagged primary). Returns the result code. |
openIndex | int openIndex(int index) | openIndex(index): enumerate displays and bind the one at `index`. |
isReady | boolean isReady() | A Screen is ready to draw once a display is bound. |
screenCount | int screenCount() | No description in source. |
primaryIndex | int primaryIndex() | Index of the primary display among the enumerated set, or 0 as a safe default when none is flagged. Enumerates first if needed. |
width | int width() | Geometry + identity of the bound display. |
height | int height() | No description in source. |
displayId | int displayId() | No description in source. |
name | String name() | No description in source. |
isPrimary | boolean isPrimary() | No description in source. |
capHas | boolean capHas(int bit) | Capability queries a developer checks before enabling a control. These read the advertised capability bitmask of the bound display (ballum_capability_t: 1 per-pixel, 2 blit, 4 brightness, 8 warmth, 16 gamma). |
canPlotPixels | boolean canPlotPixels() | No description in source. |
canSetBrightness | boolean canSetBrightness() | No description in source. |
canSetWarmth | boolean canSetWarmth() | No description in source. |
canSetGamma | boolean canSetGamma() | No description in source. |
canFullScreen | boolean canFullScreen() | 128 == BALLUM_CAP_FULLSCREEN_SURFACE: a claimable, owned fullscreen frame. |
claimFullScreen | int claimFullScreen() | ---- fullscreen surface: total, owned, fast per-pixel control -------- Claim an override-redirect fullscreen surface over the bound display. The window manager/compositor leaves every pixel to this program, so drawing is total (not overpainted). While claimed, plot()/fillRect() write to an in-memory framebuffer with no per-pixel device round-trips; call present() to push the whole frame to the screen in one native image transfer (MIT-SHM when the server supports it). Call releaseFullScreen() to give the screen back. Returns the result code (also in lastStatus). |
present | int present() | Push the claimed framebuffer to the screen in one shot. Call after a batch of plot()/fillRect() writes to make them visible. |
releaseFullScreen | int releaseFullScreen() | Release a claimed fullscreen surface; drawing reverts to the live desktop. |
inBounds | boolean inBounds(int x, int y) | Is (x, y) an exact, in-range pixel on the bound display? This is the accuracy gate every placement passes through. |
rgb | SLBallumColor rgb(int r, int g, int b) | Build a color without needing to name SLBallumColor at the call site. |
rgba | SLBallumColor rgba(int r, int g, int b, int a) | No description in source. |
plot | int plot(int x, int y, SLBallumColor color) | plot(x, y, color): set exactly one pixel. Validates readiness, capability, and bounds before the write, so the pixel lands precisely or a clear status is returned. Returns the result code (also in lastStatus). |
plotRgb | int plotRgb(int x, int y, int r, int g, int b) | plotRgb: the common case, one call, no color object at the call site. |
sample | int sample(int x, int y) | sample(x, y): read a pixel back, returned packed as 0xAARRGGBB, or -1 if the read is out of bounds / unsupported. Lets a developer verify accuracy. |
fillRect | int fillRect(int x, int y, int rectW, int rectH, SLBallumColor color) | fillRect(x, y, rectW, rectH, color): set every pixel in an exact rectangle, one accurate plot at a time. The rectangle must lie fully inside the display; otherwise OUT_OF_BOUNDS is returned and nothing is drawn. Returns the result code; stops and reports the first non-OK pixel. |
brightness | int brightness(int percent) | brightness(percent): 0..100. |
warmth | int warmth(int kelvin) | warmth(kelvin): color temperature, 1000..10000K (6500 neutral; lower warmer). |
gamma | int gamma(int gammaScaled) | gamma(gammaScaled): gamma encoded x100 (2.20 gamma == 220), 10..1000. |
gammaPoint | int gammaPoint(int whole, int hundredths) | gammaPoint(whole, hundredths): convenience for gamma(2, 20) == 2.20 gamma. |
statusCode | int statusCode() | No description in source. |
ok | boolean ok() | No description in source. |
lastMessage | String lastMessage() | No description in source. |
SLBallumScreenFit #sleela 2.5 (lib/ballum/SLBallumScreenFit.sleela)
SLBallumScreenFit class
SLBallumScreenFit — the screen-size bridge between the Ballum
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
screenW | int screenW | last discovered primary-display size (0 until a fit* call succeeds) |
screenH | int screenH | No description in source. |
gotReal | int gotReal | 1 once a real screen size was obtained from the Ballum backend |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
create | void create() | No description in source. |
discover | boolean discover() | No description in source. |
width | int width() | The last discovered primary-display width (0 if none). |
height | int height() | The last discovered primary-display height (0 if none). |
hasRealScreen | boolean hasRealScreen() | True if the last fit*/discover obtained a real screen size from the backend. |
fitFrame | boolean fitFrame(SLLayoutFrame frame, int x, int y) | No description in source. |
SLBallumSession #sleela 2.5 (lib/ballum/SLBallumSession.sleela)
SLBallumSession class
A full-screen Ballum session with an easy, one-call startup: a
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
IDLE | static final int IDLE = 0 | ---- session run states (returned by step()) --- not started yet |
RUNNING | static final int RUNNING = 1 | fading the logo in / holding full screen |
FRAME | static final int FRAME = 2 | first ESC: yielded full screen to a framed context |
EXIT | static final int EXIT = 3 | second ESC (or requestExit): leaving the program |
screen | SLBallumScreen screen | the bound full-screen display |
input | SLBallumInput input | keyboard + pointer input (for ESC and the pointer exit fallback) |
logoUrl | String logoUrl | startup configuration (easy defaults; override before start()) |
logoPath | String logoPath | local file path to decode the logo from (empty = none; URL is for display) |
effect | int effect | transition effect id (SLBallumEffect.*); default FADE |
fadeFrames | int fadeFrames | No description in source. |
displayIndex | int displayIndex | No description in source. |
bgR | int bgR | background is pure white by default, as an RGB triple |
bgG | int bgG | No description in source. |
bgB | int bgB | No description in source. |
state | int state | live state |
frame | int frame | current fade frame, 0..fadeFrames |
painted | int painted | 1 once the white background has been painted |
logoReady | int logoReady | 1 once a logo decoder supplied pixels (host-dependent) |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure() | Prepare a session with sensible, user-friendly defaults. |
defaultLogoUrl | String defaultLogoUrl() | The default splash logo (the national bitcoin / ICC mark). |
withLogo | SLBallumSession withLogo(String url) | No description in source. |
withLogoFile | SLBallumSession withLogoFile(String path) | No description in source. |
withEffect | SLBallumSession withEffect(int fx) | Choose a transition effect (SLBallumEffect.* -- FADE, IRIS_IN, SPARKLE...). |
withFadeFrames | SLBallumSession withFadeFrames(int frames) | No description in source. |
withDisplayIndex | SLBallumSession withDisplayIndex(int index) | No description in source. |
withBackground | SLBallumSession withBackground(int r, int g, int b) | No description in source. |
start | int start() | No description in source. |
paintBackground | void paintBackground() | No description in source. |
step | int step() | No description in source. |
handleInput | void handleInput() | No description in source. |
escPressed | void escPressed() | Apply one ESC press to the state machine. |
requestExit | void requestExit() | No description in source. |
resume | int resume() | Return a FRAME-mode session to full-screen running. |
finish | void finish() | No description in source. |
renderFade | void renderFade() | No description in source. |
fadePercent | int fadePercent() | The current fade opacity as a percent 0..100. |
isFullScreen | boolean isFullScreen() | ---- queries -------------------------------------------------------- |
isRunning | boolean isRunning() | No description in source. |
isFrameMode | boolean isFrameMode() | No description in source. |
isExiting | boolean isExiting() | No description in source. |
fadeComplete | boolean fadeComplete() | No description in source. |
logoPending | boolean logoPending() | No description in source. |
runState | int runState() | No description in source. |
currentFrame | int currentFrame() | No description in source. |
screenWidth | int screenWidth() | No description in source. |
screenHeight | int screenHeight() | No description in source. |
logo | String logo() | No description in source. |
stateName | String stateName(int s) | No description in source. |
SLBallumStatus #sleela 2.5 (lib/ballum/SLBallumStatus.sleela)
SLBallumStatus class
Ballum result/status codes, mirroring ballum_status_t.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
OK | static final int OK = 0 | --- native ballum_status_t (same ordinals) --- |
INVALID_ARGUMENT | static final int INVALID_ARGUMENT = 1 | No description in source. |
BACKEND_UNAVAILABLE | static final int BACKEND_UNAVAILABLE = 2 | No description in source. |
BACKEND_ERROR | static final int BACKEND_ERROR = 3 | No description in source. |
DISPLAY_NOT_FOUND | static final int DISPLAY_NOT_FOUND = 4 | No description in source. |
OUT_OF_BOUNDS | static final int OUT_OF_BOUNDS = 5 | No description in source. |
BUFFER_TOO_SMALL | static final int BUFFER_TOO_SMALL = 6 | No description in source. |
UNSUPPORTED | static final int UNSUPPORTED = 7 | No description in source. |
PERMISSION_DENIED | static final int PERMISSION_DENIED = 8 | No description in source. |
NOT_INITIALIZED | static final int NOT_INITIALIZED = 9 | No description in source. |
BRIDGE_REQUIRED | static final int BRIDGE_REQUIRED = 100 | --- SLeeLa bridge-boundary code (no native equivalent) --- Returned before a host SLVM binding connects this facade to the native ballum_manager_* API. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
text | String text(int code) | No description in source. |
ok | boolean ok(int code) | No description in source. |
SLLinuxBallumProfile #sleela 2.5 (lib/ballum/platforms/GNU/Linux/SLLinuxBallumProfile.sleela)
SLLinuxBallumProfile class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
brand | String brand() | No description in source. |
name | String name() | No description in source. |
backendName | String backendName() | No description in source. |
displayServer | String displayServer() | No description in source. |
systemLibraries | String systemLibraries() | No description in source. |
supportsPerPixel | boolean supportsPerPixel() | No description in source. |
supportsRegionBlit | boolean supportsRegionBlit() | No description in source. |
supportsBrightness | boolean supportsBrightness() | via CRTC gamma scaling |
supportsColorTemperature | boolean supportsColorTemperature() | via CRTC gamma ramp |
supportsGamma | boolean supportsGamma() | No description in source. |
supportsDdcBacklight | boolean supportsDdcBacklight() | DDC/CI backlight is hardware-dependent; advertised separately. |
SLMacOSBallumProfile #sleela 2.5 (lib/ballum/platforms/Apple/macOS/SLMacOSBallumProfile.sleela)
SLMacOSBallumProfile class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
brand | String brand() | No description in source. |
name | String name() | No description in source. |
backendName | String backendName() | No description in source. |
displayServer | String displayServer() | No description in source. |
systemLibraries | String systemLibraries() | No description in source. |
supportsPerPixel | boolean supportsPerPixel() | No description in source. |
supportsRegionBlit | boolean supportsRegionBlit() | No description in source. |
supportsBrightness | boolean supportsBrightness() | via transfer formula |
supportsColorTemperature | boolean supportsColorTemperature() | via transfer formula |
supportsGamma | boolean supportsGamma() | No description in source. |
supportsDdcBacklight | boolean supportsDdcBacklight() | No description in source. |
SLPackage #sleela 2.5 (lib/ballum/SLPackage.sleela)
SLPackage class
Defines the SLeeLa standard-library package for ballum.
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
packageName | String packageName | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
configure | void configure(String name) | No description in source. |
name | String name() | No description in source. |
available | boolean available() | No description in source. |
SLWindowsBallumProfile #sleela 2.5 (lib/ballum/platforms/Microsoft/Windows/SLWindowsBallumProfile.sleela)
SLWindowsBallumProfile class
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
brand | String brand() | No description in source. |
name | String name() | No description in source. |
minimumVersion | String minimumVersion() | No description in source. |
backendName | String backendName() | No description in source. |
displayServer | String displayServer() | No description in source. |
systemLibraries | String systemLibraries() | No description in source. |
supportsPerPixel | boolean supportsPerPixel() | No description in source. |
supportsRegionBlit | boolean supportsRegionBlit() | No description in source. |
supportsBrightness | boolean supportsBrightness() | via gamma ramp scaling |
supportsColorTemperature | boolean supportsColorTemperature() | via gamma ramp |
supportsGamma | boolean supportsGamma() | No description in source. |
supportsDdcBacklight | boolean supportsDdcBacklight() | No description in source. |
surface-demo #sleela 2.5 (lib/ballum/surface-demo.sleela)
SurfaceDemo class
Fields — the named values this unit stores.
| Field | Declaration | What it holds |
|---|---|---|
boundId | int boundId | No description in source. |
w | int w | No description in source. |
h | int h | No description in source. |
caps | int caps | No description in source. |
Methods — the actions this unit can perform.
| Method | Signature | What it does |
|---|---|---|
capHas | boolean capHas(int bit) | No description in source. |
statusText | String statusText(int code) | No description in source. |
open | int open() | No description in source. |
main | void main() | No description in source. |