Skip to content

display.md

Latest commit

 

History

History
53 lines (39 loc) · 2.18 KB

display.md

File metadata and controls

53 lines (39 loc) · 2.18 KB
Raw

Display

Purpose

ctx.res.Display() controls real HDR display output and reports the renderer's resolved state. The requested mode and active mode stay separate because the monitor, OS, graphics backend, and adapter all affect support.

It can also save the final composited viewport, including main UI and late 2D overlays.

Modes

Mode Result
HdrMode::Off Force an SDR sRGB surface.
HdrMode::Auto Use native linear extended-sRGB HDR when the surface, float scene path, and live display HDR signal support it.
HdrMode::On Request the extended-sRGB HDR surface; safely fall back to SDR when the surface or scene path lacks support.

API

hdr_set!(ctx.res, HdrMode::Auto);

let status = hdr_status!(ctx.res);
let supported = hdr_supported!(ctx.res);
let active = hdr_active!(ctx.res);

Method syntax:

ctx.res.Display().set_hdr_mode(HdrMode::On);
let status = ctx.res.Display().hdr_status();

let queued = ctx.res.Display().save_image("user://display.png");
let queued = display_save_image!(ctx.res, "user://display.png");

save_image uses the active viewport's native pixel size. true means the GPU readback was queued; disk I/O finishes asynchronously. The surface must support copy-source use. Camera save APIs remain camera-only and do not include the main UI.

HdrStatus reports requested mode, surface/scene support, active output path, internal scene HDR, resolved color space, live highlight headroom, optional peak nits, and any fallback reason. Queries read the last renderer status without blocking on GPU or display calls. active means the renderer selected the extended-linear surface; HdrMode::Auto selects it only when the display reports a live HDR signal, while HdrMode::On keeps the explicit request even when the OS display mode stays SDR.

Native HDR currently uses Rgba16Float with ExtendedSrgbLinear (scRGB). The renderer rechecks the display on resize and at most once per second before render idle checks, so monitor moves and OS HDR changes can update the Auto active state without a display query on every frame. Web HDR and HDR10/PQ output fall back to SDR until their encoded output paths are available.