session_display_config_t Struct Reference

Terminal-rendering and snapshot settings used to create a display context. More...

#include <src/common/session/display.h>

Data Fields
bool	snapshot_mode
	Enable snapshot mode (single frame capture).
palette_type_t	palette_type
	Palette type for ASCII rendering.
const char *	custom_palette
	Custom palette characters (required if palette_type == PALETTE_CUSTOM).
terminal_color_mode_t	color_mode
	Color mode override (TERM_COLOR_AUTO for auto-detection).
bool	enable_audio_playback
	Enable audio playback (mirror mode).
void *	audio_ctx
	Audio context for playback (borrowed, not owned).
session_display_should_exit_fn	should_exit_callback
	Optional: callback to check if initialization should be cancelled (e.g., shutdown signal).
void *	callback_data
	Opaque data passed to should_exit_callback.
uint32_t	render_fps
	Video FPS for render-file encoding (0 = use default/option).
bool	defer_render_file
	Defer render-file encoder creation until media timing is known.

Detailed Description

Terminal-rendering and snapshot settings used to create a display context.

Selects palette and color behavior, optional audio playback, render-file FPS, and deferred encoder creation. The palette and callback strings/data are borrowed; the display context copies the terminal-facing state it needs.

Definition at line 77 of file src/common/session/display.h.

Field Documentation

audio_ctx

void* session_display_config_t::audio_ctx

Audio context for playback (borrowed, not owned).

Definition at line 94 of file src/common/session/display.h.

Referenced by session_display_create().

callback_data

void* session_display_config_t::callback_data

Opaque data passed to should_exit_callback.

Definition at line 100 of file src/common/session/display.h.

Referenced by session_display_create().

color_mode

terminal_color_mode_t session_display_config_t::color_mode

Color mode override (TERM_COLOR_AUTO for auto-detection).

Definition at line 88 of file src/common/session/display.h.

Referenced by session_display_create().

custom_palette

const char* session_display_config_t::custom_palette

Custom palette characters (required if palette_type == PALETTE_CUSTOM).

Definition at line 85 of file src/common/session/display.h.

Referenced by session_display_create().

defer_render_file

bool session_display_config_t::defer_render_file

Defer render-file encoder creation until media timing is known.

Definition at line 106 of file src/common/session/display.h.

Referenced by session_display_create().

enable_audio_playback

bool session_display_config_t::enable_audio_playback

Enable audio playback (mirror mode).

Definition at line 91 of file src/common/session/display.h.

Referenced by session_display_create().

palette_type

palette_type_t session_display_config_t::palette_type

Palette type for ASCII rendering.

Definition at line 82 of file src/common/session/display.h.

Referenced by session_display_create().

render_fps

uint32_t session_display_config_t::render_fps

Video FPS for render-file encoding (0 = use default/option).

Definition at line 103 of file src/common/session/display.h.

Referenced by session_display_create().

should_exit_callback

session_display_should_exit_fn session_display_config_t::should_exit_callback

Optional: callback to check if initialization should be cancelled (e.g., shutdown signal).

Definition at line 97 of file src/common/session/display.h.

Referenced by session_display_create().

snapshot_mode

bool session_display_config_t::snapshot_mode

Enable snapshot mode (single frame capture).

Definition at line 79 of file src/common/session/display.h.

Referenced by session_display_create().

---

The documentation for this struct was generated from the following file:

• src/common/session/display.h