upipe-gl/upipe_glx_sink.h header reference

Upipe GLX (OpenGL/X11) sink module. More

Header inclusion

Members

Types

enum upipe_glx_sink_command
enum uprobe_glx_sink_event

Functions

bool upipe_glx_sink_init(struct upipe *upipe, int x, int y, int width, int height)
struct upipe_mgr * upipe_glx_sink_mgr_alloc(void )

Description

This sink module renders rgb pics in a GL/X window. This is typically used by a player. It must be given a specific probe at allocation to catch GL events (init, render, reshape) defined in <upipe-gl/upipe_gl_sink_common.h>. Application developers can either use a predefined probe or use their own probe structure. uprobe_gl_sink_cube is currently provided as an example. Please read tests/upipe_glx_sink_test.c. You can also read examples/glxplay.c for a more complete example.

Members detail

#define UPIPE_GLX_SINK_SIGNATURE

This macro is declared in upipe-gl/upipe_glx_sink.h source file, line 48.

#define _UPIPE_GL_UPIPE_GLX_SINK_H_

This macro is declared in upipe-gl/upipe_glx_sink.h source file, line 40.

enum upipe_glx_sink_command

This enum is declared in upipe-gl/upipe_glx_sink.h source file, line 62.

This enum extends upipe_command with specific commands for glx sink.

Identifier	Value	Description
UPIPE_GLX_SINK_SENTINEL	UPIPE_GL_SINK_CONTROL_LOCAL
UPIPE_GLX_SINK_INIT	unknown	launch glx with window size and position (int, int, int, int)
UPIPE_GLX_SINK_GET_SIZE	unknown	returns the current window size (int , int )
UPIPE_GLX_SINK_SET_SIZE	unknown	set window size (int, int)

bool upipe_glx_sink_init(struct upipe *upipe, int x, int y, int width, int height)

This function is declared in upipe-gl/upipe_glx_sink.h source file, line 84.

This function inits the glx window/context and displays it

Parameter list:

upipe: description structure of the pipe
x: window position x
y: window position y
width: window width
height: window height

The return value is false in case of error

struct upipe_mgr * upipe_glx_sink_mgr_alloc(void )

This function is declared in upipe-gl/upipe_glx_sink.h source file, line 93.

This function returns the management structure for all glx sinks.

The return value is pointer to manager

enum uprobe_glx_sink_event

This enum is declared in upipe-gl/upipe_glx_sink.h source file, line 52.

This enum extends uprobe_event with specific events for glx sink.

Identifier	Value	Description
UPROBE_GLX_SINK_SENTINEL	UPROBE_GL_SINK_LOCAL
UPROBE_GLX_SINK_KEYPRESS	unknown	received keypress event (unsigned long keysym)
UPROBE_GLX_SINK_KEYRELEASE	unknown	received keyrelease event (unsigned long keysym)