vlc_vout_window.h File Reference

This file defines vout windows structures and functions in vlc. More...

Include dependency graph for vlc_vout_window.h:

Go to the source code of this file.

Data Structures
struct	vout_window_cfg_t
struct	vout_window_t
	FIXME do we need an event system in the window too ? or the window user will take care of it ? More...

Typedefs
typedef struct vout_window_t	vout_window_t
typedef struct vout_window_sys_t	vout_window_sys_t

Enumerations
enum	{ VOUT_WINDOW_TYPE_INVALID = 0, VOUT_WINDOW_TYPE_XID, VOUT_WINDOW_TYPE_HWND, VOUT_WINDOW_TYPE_NSOBJECT }
	Window handle type. More...
enum	{ VOUT_WINDOW_SET_STATE, VOUT_WINDOW_SET_SIZE, VOUT_WINDOW_SET_FULLSCREEN }
	Control query for vout_window_t. More...

Functions
vout_window_t *	vout_window_New (vlc_object_t *, const char *module, const vout_window_cfg_t *)
	Creates a new window.
void	vout_window_Delete (vout_window_t *)
	Deletes a window created by vout_window_New().
int	vout_window_Control (vout_window_t *, int query,...)
	Reconfigures a window.
static int	vout_window_SetState (vout_window_t *window, unsigned state)
	Configures the window manager state for this window.
static int	vout_window_SetSize (vout_window_t *window, unsigned width, unsigned height)
	Configures the window display (i.e.
static int	vout_window_SetFullScreen (vout_window_t *window, bool full)
	Sets fullscreen mode.

Detailed Description

This file defines vout windows structures and functions in vlc.

Typedef Documentation

typedef struct vout_window_sys_t vout_window_sys_t

typedef struct vout_window_t vout_window_t

Enumeration Type Documentation

anonymous enum

Window handle type.

Enumerator:

VOUT_WINDOW_TYPE_INVALID
VOUT_WINDOW_TYPE_XID
VOUT_WINDOW_TYPE_HWND
VOUT_WINDOW_TYPE_NSOBJECT

anonymous enum

Control query for vout_window_t.

Enumerator:

VOUT_WINDOW_SET_STATE
VOUT_WINDOW_SET_SIZE
VOUT_WINDOW_SET_FULLSCREEN

Function Documentation

int vout_window_Control	(	vout_window_t *	,
		int	query,
			...
	)

Reconfigures a window.

Note

The vout_window_* wrappers should be used instead of this function.

Warning

The caller must own the window, as vout_window_t is not thread safe.

References vout_window_t::control.

Referenced by vout_window_SetFullScreen(), vout_window_SetSize(), and vout_window_SetState().

void vout_window_Delete

(

vout_window_t *

)

Deletes a window created by vout_window_New().

Note

See vout_window_New() about window recycling.

References window_t::inhibit, window_t::module, vlc_inhibit_Destroy(), VLC_INHIBIT_NONE, vlc_inhibit_Set(), vlc_module_unload(), vlc_object_release, and vout_window_stop().

Referenced by ThreadClean(), vout_DeleteDisplayWindow(), vout_NewDisplayWindow(), and VoutDisplayDelWindow().

vout_window_t* vout_window_New	(	vlc_object_t *	,
		const char *	module,
		const vout_window_cfg_t *
	)

Creates a new window.

Parameters

module

plugin name (usually "$window")

Note

If you are inside a "vout display", you must use / vout_display_NewWindow() and vout_display_DeleteWindow() instead. This enables recycling windows.

References vout_window_t::control, vout_window_t::display, vout_window_t::handle, vout_window_t::hwnd, window_t::inhibit, window_t::module, vout_window_t::nsobject, vout_window_t::sys, vout_window_cfg_t::type, var_InheritBool, vlc_custom_create, vlc_inhibit_Create(), vlc_inhibit_Set(), VLC_INHIBIT_VIDEO, vlc_module_load, VLC_OBJECT, vlc_object_release, vout_window_start(), VOUT_WINDOW_TYPE_HWND, VOUT_WINDOW_TYPE_NSOBJECT, VOUT_WINDOW_TYPE_XID, window_t::wnd, vout_window_t::x11, and vout_window_t::xid.

Referenced by vout_NewDisplayWindow(), and VoutDisplayNewWindow().

static int vout_window_SetFullScreen ( vout_window_t *  window, bool  full  )

inlinestatic

Sets fullscreen mode.

References vout_window_Control(), and VOUT_WINDOW_SET_FULLSCREEN.

static int vout_window_SetSize ( vout_window_t *  window, unsigned  width, unsigned  height  )

inlinestatic

Configures the window display (i.e.

inner/useful) size.

References vout_window_Control(), and VOUT_WINDOW_SET_SIZE.

Referenced by vout_NewDisplayWindow().

static int vout_window_SetState ( vout_window_t *  window, unsigned  state  )

inlinestatic

Configures the window manager state for this window.

References vout_window_Control(), and VOUT_WINDOW_SET_STATE.