Skip to content

Operational Helpers

Logging

ziviDomeLive.enableDebugLogging();
ziviDomeLive.enableReleaseLogging();
ziviDomeLive.setLogMode(LogManager.Mode.DEBUG);

Configure logging before constructing the facade when startup diagnostics are needed.

Frame Rate

dome.setTargetFrameRate(60);

The value must be positive. Changes after setup are applied to Processing and update the default NDI frame-rate metadata. Fractional NDI metadata is available through OutputManager.setNdiFrameRate(numerator, denominator).

Set the target before setup() when possible. Changing Processing's frame rate from a scene's initialization path can force JOGL to restart its animator on the animator thread; use elapsed time or frame quantization for scene-local playback profiles instead.

Scene-Space Camera

OrbitCamera camera = dome.getSceneCamera();
dome.setSceneCameraInputEnabled(true);
camera.setDistanceLimits(100, 5000);
camera.setCollapseGuard(20);

The scene camera transforms scene space and is distinct from spherical pitch/yaw/roll, the canonical six-face CubemapFace table, and the Standard perspective camera. Its quaternion is automatically included in the Environment lookup; target and distance never affect the infinite background.

Disable camera input when the owning scene is disposed so later scenes do not inherit drag or wheel interaction unintentionally.

Environment Background

PImage stars = loadImage("textures/8k_stars_milky_way.jpg");
dome.setEquirectangularBackground(stars);
dome.setEnvironmentBackgroundVisible(true);
dome.setEnvironmentBackgroundIntensity(1.0f);
dome.setEnvironmentBackgroundYawOffset(0.0f);

The public LDR source is a borrowed PImage; the library resolves its Processing-managed GPU texture and samples it as an equirectangular map. One logical source and one set of visible, visual intensity, and longitude yawOffset values feed Standard, domemaster, equirectangular, and skybox preview/output passes. Service-aware scenes can additionally call setOrientationAxisAngle(...) to align the source lookup itself without rotating dome controls or scene geometry. The far-depth pass runs after sceneRender(), so scene-owned background() calls do not erase it and foreground geometry remains in front.

Standard combines its perspective basis with the shared scene-camera quaternion. Spherical modes compose shared Pitch/Yaw/Roll followed by that same scene-camera quaternion. Orbit target and distance never translate the panorama. Direct facade users call clearEnvironmentBackground() when ownership ends. Service-aware scenes can use services.environment(), which restores the state it replaced automatically; the borrowed PImage itself is never disposed by ziviDomeLive.

HDR loading, IBL maps, and ambient occlusion are not enabled by this helper yet.

Output Diagnostics

OutputManager outputs = dome.getOutputManager();
OutputManager.OutputState state =
    outputs.getOutputState(OutputManager.OutputType.NDI);
String reason = outputs.getOutputFailureReason(OutputManager.OutputType.NDI);

NDI telemetry methods report captured, sent, dropped, and failed frames. Dropped frames represent bounded latest-frame backpressure; failed frames represent capture or sender errors.

long captured = outputs.getNdiCapturedFrames();
long sent = outputs.getNdiSentFrames();
long dropped = outputs.getNdiDroppedFrames();
long failed = outputs.getNdiFailedFrames();

getLocalTextureBackendName(), isLocalTextureAvailable(), and isLocalTextureInitialized() describe the one platform-local texture backend. Do not infer availability from the operating-system name alone.

Calibration Reset

resetControls() restores spherical pitch, yaw, roll, FOV, and Size% defaults and synchronizes the ControlP5 values.

resetOrientation() resets only pitch, yaw, roll, and the shared quaternion. Use it before replaying an ordered calibration sequence. Programmatic FOV and Size% callers should remain within the supported panel ranges 0..360 and 0..100.

Resolution And Dimensions

dome.resetGraphics(2048);
int outputSize = dome.getOutputResolution();
int previewWidth = dome.getWidth();
int previewHeight = dome.getHeight();

resetGraphics() queues a high-resolution renderer reset; allocation occurs in the draw loop. getWidth() and getHeight() report the Processing window, not the spherical output size. Standard output aspect policy is configured through setStandardOutputAspectMode().

OpenGL Diagnostics

printOpenGLInfo(PApplet) logs vendor, renderer, version, and GLSL information from a valid OpenGL context. The packaged projection shaders target GLSL 4.10, so the production context must support OpenGL 4.1.