Deprecate libvlc_media_player_(g|s)et_drawable
authorRémi Denis-Courmont <rdenis@simphalempin.com>
Sat, 7 Feb 2009 17:27:44 +0000 (19:27 +0200)
committerRémi Denis-Courmont <rdenis@simphalempin.com>
Sat, 7 Feb 2009 17:32:11 +0000 (19:32 +0200)
include/vlc/deprecated.h
include/vlc/libvlc.h
include/vlc/libvlc_structures.h

index f7711ca..bb966d0 100644 (file)
  * This file defines libvlc depreceated API
  */
 
  * This file defines libvlc depreceated API
  */
 
+/**
+ * This is the legacy representation of a platform-specific drawable. Because
+ * it cannot accomodate a pointer on most 64-bits platforms, it should not be
+ * used anymore.
+ */
+typedef int libvlc_drawable_t;
+
 # ifdef __cplusplus
 extern "C" {
 # endif
 
 # ifdef __cplusplus
 extern "C" {
 # endif
 
+/**
+ * Set the drawable where the media player should render its video output.
+ *
+ * On Windows 32-bits, a window handle (HWND) is expected.
+ * On Windows 64-bits, this function will always fail.
+ *
+ * On OSX 32-bits, a CGrafPort is expected.
+ * On OSX 64-bits, this function will always fail.
+ *
+ * On other platforms, an existing X11 window ID is expected. See
+ * libvlc_media_player_set_xid() for details.
+ *
+ * \param p_mi the Media Player
+ * \param drawable the libvlc_drawable_t where the media player
+ *        should render its video
+ * \param p_e an initialized exception pointer
+ */
+VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
+
+/**
+ * Get the drawable where the media player should render its video output
+ *
+ * \param p_mi the Media Player
+ * \param p_e an initialized exception pointer
+ * \return the libvlc_drawable_t where the media player
+ *         should render its video
+ */
+VLC_PUBLIC_API libvlc_drawable_t
+                    libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
+
 /**
  * Set the default video output's parent.
  *
 /**
  * Set the default video output's parent.
  *
index a720c76..290da21 100644 (file)
@@ -580,38 +580,6 @@ VLC_PUBLIC_API void libvlc_media_player_set_xid ( libvlc_media_player_t *p_mi, u
  */
 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
 
  */
 VLC_PUBLIC_API void libvlc_media_player_set_hwnd ( libvlc_media_player_t *p_mi, void *drawable, libvlc_exception_t *p_e );
 
-/**
- * Set the drawable where the media player should render its video output.
- *
- * On Windows 32-bits, a window handle (HWND) is expected.
- * On Windows 64-bits, this function will always fail.
- *
- * On OSX, a CGrafPort is expected.
- *
- * Otherwise, this shall be the identifier of an existing X11 drawable (window
- * or pixmap). It is assumed that the X11 server is the same as the one in
- * x11-display if configured. If XVideo is <b>not</b> supported, it is assumed
- * that the drawable has the same pixmap format as the default X11 screen
- * (especially depth, scan line pad, black pixel); this is a bug.
- *
- * \param p_mi the Media Player
- * \param drawable the libvlc_drawable_t where the media player
- *        should render its video
- * \param p_e an initialized exception pointer
- */
-VLC_PUBLIC_API void libvlc_media_player_set_drawable ( libvlc_media_player_t *, libvlc_drawable_t, libvlc_exception_t * );
-
-/**
- * Get the drawable where the media player should render its video output
- *
- * \param p_mi the Media Player
- * \param p_e an initialized exception pointer
- * \return the libvlc_drawable_t where the media player
- *         should render its video
- */
-VLC_PUBLIC_API libvlc_drawable_t
-                    libvlc_media_player_get_drawable ( libvlc_media_player_t *, libvlc_exception_t * );
-
 /** \bug This might go away ... to be replaced by a broader system */
 
 /**
 /** \bug This might go away ... to be replaced by a broader system */
 
 /**
index e5e1be3..bede67c 100644 (file)
@@ -265,14 +265,6 @@ typedef struct libvlc_audio_output_t
  * @{
  */
 
  * @{
  */
 
-/**
-* Downcast to this general type as placeholder for a platform specific one, such as:
-*  Drawable on X11,
-*  CGrafPort on MacOSX,
-*  HWND on win32
-*/
-typedef int libvlc_drawable_t;
-
 /**
 * Rectangle type for video geometry
 */
 /**
 * Rectangle type for video geometry
 */