session_display_config_t Struct Reference

Configuration for session 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

Configuration for session display context.

Specifies display parameters including snapshot mode, palette, and color mode.

Definition at line 75 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 92 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 98 of file src/common/session/display.h.

Referenced by session_client_like_run(), and 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 86 of file src/common/session/display.h.

Referenced by session_client_like_run(), and 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 83 of file src/common/session/display.h.

Referenced by session_client_like_run(), and 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 104 of file src/common/session/display.h.

Referenced by session_client_like_run(), and session_display_create().

enable_audio_playback

bool session_display_config_t::enable_audio_playback

Enable audio playback (mirror mode)

Definition at line 89 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 80 of file src/common/session/display.h.

Referenced by session_client_like_run(), and 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 101 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 95 of file src/common/session/display.h.

Referenced by session_client_like_run(), and session_display_create().

snapshot_mode

bool session_display_config_t::snapshot_mode

Enable snapshot mode (single frame capture)

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

Referenced by display_init(), session_client_like_run(), and session_display_create().

---

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

• src/common/session/display.h