Add a bunch of \file doxygen comments
[vlc.git] / include / vlc_window.h
1 /*****************************************************************************
2  * vlc_window.h: Embedded video output window
3  *****************************************************************************
4  * Copyright (C) 2008 RĂ©mi Denis-Courmont
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
19  *****************************************************************************/
20
21 #ifndef LIBVLCCORE_WINDOW_H
22 # define LIBVLCCORE_WINDOW_H 1
23
24 /**
25  * \file
26  * This file defines functions and structures for output windows
27  */
28
29 # include <stdarg.h>
30
31 typedef struct vout_window_t vout_window_t;
32
33 struct vout_window_t
34 {
35     VLC_COMMON_MEMBERS
36
37     module_t      *module;
38     vout_thread_t *vout;
39     void          *handle; /* OS-specific Window handle */
40
41     unsigned       width;  /* pixels width */
42     unsigned       height; /* pixels height */
43     int            pos_x;  /* horizontal position hint */
44     int            pos_y;  /* vertical position hint */
45
46     int (*control) (struct vout_window_t *, int, va_list);
47 };
48
49 #endif /* !LIBVLCCORE_WINDOW_H */