GUI Config Interface

Small GUI interface to configure Monado based on SDL2. More...

Collaboration diagram for GUI Config Interface:

Files
file	gui_common.h
	Common file for the Monado GUI program.
file	gui_imgui.h
	Imgui integration for gui.
file	gui_ogl.c
	OpenGL functions to drive the gui.
file	gui_scene.cpp
	SDL2 functions to drive the GUI.
file	gui_scene_calibrate.c
	Calibration gui scene.
file	gui_scene_debug.c
	A debugging scene.
file	gui_scene_main_menu.c
	Main menu.
file	gui_scene_video.c
	A very small scene that lets the user select a video device.
file	gui_sdl2.c
	SDL2 functions to drive the GUI.
file	gui_sdl2.h
	Common file for the Monado SDL2 based GUI program.
file	gui_sdl2_imgui.c
	Main entrypoint for the Monado GUI program.
file	gui_sdl2_main.c
	Main entrypoint for the Monado GUI program.

Data Structures
struct	gui_program
	A gui program. More...
struct	gui_ogl_texture
	A OpenGL texture. More...
struct	sdl2_program
	Common struct holding state for the GUI interface. More...
struct	gui_imgui
	Internal gui state. More...

Functions
int	gui_prober_init (struct gui_program *p)
	Initialize the prober and open all devices found. More...
int	gui_prober_select (struct gui_program *p)
	Create devices. More...
void	gui_prober_update (struct gui_program *p)
	Update all devices. More...
void	gui_prober_teardown (struct gui_program *p)
	Destroy all opened devices and destroy the prober. More...
struct gui_ogl_texture *	gui_ogl_sink_create (const char *name, struct xrt_frame_context *xfctx, struct xrt_frame_sink **out_sink)
	Create a sink that will turn frames into OpenGL textures, since the frame can come from another thread gui_ogl_sink_update needs to be called. More...
void	gui_ogl_sink_update (struct gui_ogl_texture *)
	Update the texture to the latest received frame. More...
void	gui_scene_push_front (struct gui_program *p, struct gui_scene *me)
	Push the scene to the top of the lists. More...
void	gui_scene_delete_me (struct gui_program *p, struct gui_scene *me)
	Put a scene on the delete list, also removes it from any other list. More...
void	gui_scene_manager_render (struct gui_program *p)
	Render the scenes. More...
void	gui_scene_manager_init (struct gui_program *p)
	Initialize the scene manager. More...
void	gui_scene_manager_destroy (struct gui_program *p)
	Destroy the scene manager. More...
void	gui_scene_main_menu (struct gui_program *p)
	Shows the main menu. More...
void	gui_scene_select_video_calibrate (struct gui_program *p)
	Shows a UI that lets you select a video device and mode for calibration. More...
void	gui_scene_select_video_test (struct gui_program *p)
	Shows a UI that lets you select a video device and mode for testing. More...
void	gui_scene_debug (struct gui_program *p)
	Regular debug UI. More...
void	gui_scene_debug_video (struct gui_program *p, struct xrt_frame_context *xfctx, struct xrt_fs *xfs, size_t mode)
	Given the frameserver runs some debug code on it. More...
void	gui_scene_calibrate (struct gui_program *p, struct xrt_frame_context *xfctx, struct xrt_fs *xfs, size_t mode)
	Given the frameserver runs the calibration code on it. More...
int	gui_sdl2_init (struct sdl2_program *p)
	Init SDL2, create and show a window and bring up any other structs needed. More...
void	gui_sdl2_imgui_loop (struct sdl2_program *p)
	Loop until user request quit and show Imgui interface. More...
void	gui_sdl2_loop (struct sdl2_program *p)
	Loop until quit signal has been received. More...
void	gui_sdl2_quit (struct sdl2_program *p)
	Destroy all SDL things and quit SDL. More...

Detailed Description

Small GUI interface to configure Monado based on SDL2.

Function Documentation

gui_ogl_sink_create()

struct gui_ogl_texture* gui_ogl_sink_create	(	const char *	name,
		struct xrt_frame_context *	xfctx,
		struct xrt_frame_sink **	out_sink
	)

#include <state_trackers/gui/gui_common.h>

Create a sink that will turn frames into OpenGL textures, since the frame can come from another thread gui_ogl_sink_update needs to be called.

Destruction is handled by the frame context.

References xrt_frame_sink::push_frame, and U_TYPED_CALLOC.

gui_ogl_sink_update()

void gui_ogl_sink_update

(

struct gui_ogl_texture *

)

#include <state_trackers/gui/gui_common.h>

Update the texture to the latest received frame.

References container_of.

gui_prober_init()

int gui_prober_init

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Initialize the prober and open all devices found.

References time_state::time_state_create(), and xrt_prober_create().

gui_prober_select()

int gui_prober_select

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Create devices.

gui_prober_teardown()

void gui_prober_teardown

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Destroy all opened devices and destroy the prober.

gui_prober_update()

void gui_prober_update

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Update all devices.

References time_state::time_state_get_now_and_update().

Referenced by gui_sdl2_imgui_loop().

gui_scene_calibrate()

void gui_scene_calibrate	(	struct gui_program *	p,
		struct xrt_frame_context *	xfctx,
		struct xrt_fs *	xfs,
		size_t	mode
	)

#include <state_trackers/gui/gui_common.h>

Given the frameserver runs the calibration code on it.

References U_TYPED_CALLOC.

gui_scene_debug()

void gui_scene_debug

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Regular debug UI.

References U_TYPED_CALLOC.

gui_scene_debug_video()

void gui_scene_debug_video	(	struct gui_program *	p,
		struct xrt_frame_context *	xfctx,
		struct xrt_fs *	xfs,
		size_t	mode
	)

#include <state_trackers/gui/gui_common.h>

Given the frameserver runs some debug code on it.

References U_TYPED_CALLOC.

gui_scene_delete_me()

void gui_scene_delete_me	(	struct gui_program *	p,
		struct gui_scene *	me
	)

#include <state_trackers/gui/gui_common.h>

Put a scene on the delete list, also removes it from any other list.

gui_scene_main_menu()

void gui_scene_main_menu

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Shows the main menu.

References U_TYPED_CALLOC.

gui_scene_manager_destroy()

void gui_scene_manager_destroy

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Destroy the scene manager.

gui_scene_manager_init()

void gui_scene_manager_init

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Initialize the scene manager.

gui_scene_manager_render()

void gui_scene_manager_render

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Render the scenes.

Referenced by gui_sdl2_imgui_loop().

gui_scene_push_front()

void gui_scene_push_front	(	struct gui_program *	p,
		struct gui_scene *	me
	)

#include <state_trackers/gui/gui_common.h>

Push the scene to the top of the lists.

gui_scene_select_video_calibrate()

void gui_scene_select_video_calibrate

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Shows a UI that lets you select a video device and mode for calibration.

References U_TYPED_CALLOC.

gui_scene_select_video_test()

void gui_scene_select_video_test

(

struct gui_program *

p

)

#include <state_trackers/gui/gui_common.h>

Shows a UI that lets you select a video device and mode for testing.

References U_TYPED_CALLOC.

gui_sdl2_imgui_loop()

void gui_sdl2_imgui_loop

(

struct sdl2_program *

p

)

#include <targets/gui/gui_sdl2.h>

Loop until user request quit and show Imgui interface.

References gui_prober_update(), gui_scene_manager_render(), u_var_add_root(), and u_var_remove_root().

gui_sdl2_init()

int gui_sdl2_init

(

struct sdl2_program *

p

)

#include <targets/gui/gui_sdl2.h>

Init SDL2, create and show a window and bring up any other structs needed.

gui_sdl2_loop()

void gui_sdl2_loop

(

struct sdl2_program *

p

)

#include <targets/gui/gui_sdl2.h>

Loop until quit signal has been received.

gui_sdl2_quit()

void gui_sdl2_quit

(

struct sdl2_program *

p

)

#include <targets/gui/gui_sdl2.h>

Destroy all SDL things and quit SDL.