1 /*****************************************************************************
2 * vlc_vout_window.h: vout_window_t definitions
3 *****************************************************************************
4 * Copyright (C) 2008 RĂ©mi Denis-Courmont
5 * Copyright (C) 2009 Laurent Aimar
8 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 #ifndef VLC_VOUT_WINDOW_H
26 #define VLC_VOUT_WINDOW_H 1
30 * This file defines vout windows structures and functions in vlc
33 #include <vlc_common.h>
36 typedef struct vout_window_t vout_window_t
;
37 typedef struct vout_window_sys_t vout_window_sys_t
;
45 VOUT_WINDOW_TYPE_HWND
,
49 * Control query for vout_window_t
52 VOUT_WINDOW_SET_ON_TOP
, /* int b_on_top */
53 VOUT_WINDOW_SET_SIZE
, /* unsigned i_width, unsigned i_height */
54 VOUT_WINDOW_SET_FULLSCREEN
, /* int b_fullscreen */
58 /* If true, a standalone window is requested */
61 /* Window handle type */
64 /* Window position hint */
68 /* Windows size hint */
75 * FIXME do we need an event system in the window too ?
76 * or the window user will take care of it ?
78 struct vout_window_t
{
81 /* Initial state (reserved).
82 * Once the open function is called, it will be set to NULL
84 const vout_window_cfg_t
*cfg
;
86 /* window handle (mandatory)
88 * It must be filled in the open function.
91 void *hwnd
; /* Win32 window handle */
92 uint32_t xid
; /* X11 windows ID */
95 /* Control on the module (mandatory)
97 * Do not use it directly; use vout_window_Control instead.
99 int (*control
)(vout_window_t
*, int query
, va_list);
101 /* Private place holder for the vout_window_t module (optional)
103 * A module is free to use it as it wishes.
105 vout_window_sys_t
*sys
;
109 * It creates a new window.
111 * @note If you are inside a "vout display", you must use
112 * vout_display_New/DeleteWindow when possible to allow window recycling.
114 VLC_EXPORT( vout_window_t
*, vout_window_New
, (vlc_object_t
*, const char *module
, const vout_window_cfg_t
*) );
117 * It deletes a window created by vout_window_New().
119 * @note See vout_window_New() about window recycling.
121 VLC_EXPORT( void, vout_window_Delete
, (vout_window_t
*) );
124 * It allows configuring a window.
126 * @warning The caller must own the window, as vout_window_t is not thread safe.
127 * You should use it the vout_window_* wrappers instead of this function.
129 VLC_EXPORT( int, vout_window_Control
, (vout_window_t
*, int query
, ...) );
132 * Configure the "On Top" properties of a windows.
134 static inline int vout_window_SetOnTop(vout_window_t
*window
, bool is_on_top
)
136 return vout_window_Control(window
, VOUT_WINDOW_SET_ON_TOP
, is_on_top
);
140 * Configure the windows display size.
142 static inline int vout_window_SetSize(vout_window_t
*window
,
143 unsigned width
, unsigned height
)
145 return vout_window_Control(window
, VOUT_WINDOW_SET_SIZE
, width
, height
);
149 * Configure the windows fullscreen mode.
151 static inline int vout_window_SetFullScreen(vout_window_t
*window
, bool full
)
153 return vout_window_Control(window
, VOUT_WINDOW_SET_FULLSCREEN
, full
);
156 #endif /* VLC_VOUT_WINDOW_H */