X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_vout_window.h;h=e7944685b6ca9092ca77ec20d5aff55d32929e6b;hb=f41379c2a96d577a798b93c2baaec06d93490f6a;hp=58eaf4ecc51ac796228ad3519f14b1e495fc5410;hpb=0926bbb6104aa6bbb10918f753a8cc677a796f9b;p=vlc diff --git a/include/vlc_vout_window.h b/include/vlc_vout_window.h index 58eaf4ecc5..e7944685b6 100644 --- a/include/vlc_vout_window.h +++ b/include/vlc_vout_window.h @@ -7,19 +7,19 @@ * * Authors: Laurent Aimar * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or + * This program is free software; you can redistribute it and/or modify it + * under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ #ifndef VLC_VOUT_WINDOW_H @@ -41,16 +41,19 @@ typedef struct vout_window_sys_t vout_window_sys_t; * Window handle type */ enum { + VOUT_WINDOW_TYPE_INVALID=0, VOUT_WINDOW_TYPE_XID, VOUT_WINDOW_TYPE_HWND, + VOUT_WINDOW_TYPE_NSOBJECT, }; /** * Control query for vout_window_t */ enum { - VOUT_WINDOW_SET_ON_TOP, /* int b_on_top */ - VOUT_WINDOW_SET_SIZE, /* int i_width, int i_height */ + VOUT_WINDOW_SET_STATE, /* unsigned state */ + VOUT_WINDOW_SET_SIZE, /* unsigned i_width, unsigned i_height */ + VOUT_WINDOW_SET_FULLSCREEN, /* int b_fullscreen */ }; typedef struct { @@ -58,15 +61,15 @@ typedef struct { bool is_standalone; /* Window handle type */ - int type; + unsigned type; /* Window position hint */ int x; int y; - /* Windows size int */ - int width; - int height; + /* Windows size hint */ + unsigned width; + unsigned height; } vout_window_cfg_t; @@ -77,74 +80,84 @@ typedef struct { struct vout_window_t { VLC_COMMON_MEMBERS - /* Module */ - module_t *module; - - /* Initial state (reserved). - * Once the open function is called, it will be set to NULL - */ - const vout_window_cfg_t *cfg; - /* window handle (mandatory) * * It must be filled in the open function. */ union { - void *hwnd; /* Win32 window handle */ - uint32_t xid; /* X11 windows ID */ + void *hwnd; /* Win32 window handle */ + uint32_t xid; /* X11 windows ID */ + void *nsobject; /* Mac OSX view object */ } handle; + /* display server (mandatory) */ + union { + char *x11; /* X11 display (NULL = use default) */ + } display; + /* Control on the module (mandatory) * - * Do not use it directly but use vout_window_Control. + * Do not use it directly; use vout_window_Control instead. */ int (*control)(vout_window_t *, int query, va_list); /* Private place holder for the vout_window_t module (optional) * - * A module is free to used it as it wishes. + * A module is free to use it as it wishes. */ vout_window_sys_t *sys; }; -/** - * It creates a new window. - * - * XXX If you are inside a "vout display", you must use - * vout_display_New/DeleteWindow when possible to allow window recycling. +/** + * Creates a new window. + * + * @param 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. */ -VLC_EXPORT( vout_window_t *, vout_window_New, (vlc_object_t *, const char *module, const vout_window_cfg_t *) ); +VLC_API vout_window_t * vout_window_New(vlc_object_t *, const char *module, const vout_window_cfg_t *); /** - * It deletes a window created by vout_window_New. + * Deletes a window created by vout_window_New(). * - * XXX See vout_window_New about window recycling. + * @note See vout_window_New() about window recycling. */ -VLC_EXPORT( void, vout_window_Delete, (vout_window_t *) ); +VLC_API void vout_window_Delete(vout_window_t *); + /** - * It allows configuring a window. + * Reconfigures a window. * - * XXX you must own the windows, and vout_window_t are not thread safe. - * You must not use it directly but prefer the vout_window_* wrappers. + * @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. */ -VLC_EXPORT( int, vout_window_Control, (vout_window_t *, int query, ...) ); +VLC_API int vout_window_Control(vout_window_t *, int query, ...); /** - * Configure the "On Top" properties of a windows. + * Configures the window manager state for this window. */ -static inline int vout_window_SetOnTop(vout_window_t *window, bool is_on_top) +static inline int vout_window_SetState(vout_window_t *window, unsigned state) { - return vout_window_Control(window, VOUT_WINDOW_SET_ON_TOP, is_on_top); + return vout_window_Control(window, VOUT_WINDOW_SET_STATE, state); } /** - * Configure the windows display size. + * Configures the window display (i.e. inner/useful) size. */ -static inline int vout_window_SetSize(vout_window_t *window, int width, int height) +static inline int vout_window_SetSize(vout_window_t *window, + unsigned width, unsigned height) { return vout_window_Control(window, VOUT_WINDOW_SET_SIZE, width, height); } -#endif /* VLC_VOUT_WINDOW_H */ +/** + * Sets fullscreen mode. + */ +static inline int vout_window_SetFullScreen(vout_window_t *window, bool full) +{ + return vout_window_Control(window, VOUT_WINDOW_SET_FULLSCREEN, full); +} +#endif /* VLC_VOUT_WINDOW_H */