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...
Defines
#define	VLC_VOUT_WINDOW_H   1
Typedefs
typedef struct vout_window_t	vout_window_t
typedef struct vout_window_sys_t	vout_window_sys_t
Enumerations
enum	{ VOUT_WINDOW_TYPE_XID, VOUT_WINDOW_TYPE_HWND }
	Window handle type. More...
enum	{ VOUT_WINDOW_SET_ON_TOP, 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 *)
	It creates a new window.
void	vout_window_Delete (vout_window_t *)
	It deletes a window created by vout_window_New().
int	vout_window_Control (vout_window_t *, int query,...)
	It allows configuring a window.
static int	vout_window_SetOnTop (vout_window_t *window, bool is_on_top)
	Configure the "On Top" properties of a windows.
static int	vout_window_SetSize (vout_window_t *window, unsigned width, unsigned height)
	Configure the windows display size.
static int	vout_window_SetFullScreen (vout_window_t *window, bool full)
	Configure the windows fullscreen mode.

---

Detailed Description

This file defines vout windows structures and functions in vlc.

---

Define Documentation

#define VLC_VOUT_WINDOW_H   1

---

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_XID
VOUT_WINDOW_TYPE_HWND

anonymous enum

Control query for vout_window_t.

Enumerator:

VOUT_WINDOW_SET_ON_TOP
VOUT_WINDOW_SET_SIZE
VOUT_WINDOW_SET_FULLSCREEN

---

Function Documentation

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

It allows configuring a window.

Warning:

The caller must own the window, as vout_window_t is not thread safe. You should use it the vout_window_* wrappers instead of this function.

References vout_window_t::control.

void vout_window_Delete

(

vout_window_t *

)

It deletes a window created by vout_window_New().

Note:

See vout_window_New() about window recycling.

References window_t::inhibit, window_t::module, module_unneed, vlc_inhibit_Destroy(), vlc_object_detach, and vlc_object_release.

Referenced by Destroy(), DestroyWindow(), DirectXCloseWindow(), and vout_DeleteDisplayWindow().

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

It creates a new window.

Note:

If you are inside a "vout display", you must use vout_display_New/DeleteWindow when possible to allow window recycling.

References vout_window_t::cfg, vout_window_t::control, vout_window_t::handle, window_t::inhibit, window_t::module, module_need, name, vout_window_t::sys, vout_window_cfg_t::type, vlc_custom_create, vlc_inhibit_Create(), vlc_inhibit_Set(), VLC_OBJECT, vlc_object_attach, vlc_object_detach, VLC_OBJECT_GENERIC, vlc_object_release, VOUT_WINDOW_TYPE_HWND, VOUT_WINDOW_TYPE_XID, window_t::wnd, and vout_window_t::xid.

Referenced by CreateWindow(), DirectXCreateWindow(), InitWindow(), and vout_NewDisplayWindow().

static int vout_window_SetFullScreen	(	vout_window_t *	window,
		bool	full
	)			[inline, static]

Configure the windows fullscreen mode.

Referenced by CommonControlSetFullscreen(), Control(), and ToggleFullScreen().

static int vout_window_SetOnTop	(	vout_window_t *	window,
		bool	is_on_top
	)			[inline, static]

Configure the "On Top" properties of a windows.

Referenced by CommonControl(), Control(), and vaControlParentWindow().

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

Configure the windows display size.

Referenced by CommonControl(), Control(), and vaControlParentWindow().