[vlc-devel] commit: Improve libvlc drawable documentation ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <rdenis at simphalempin.com> | Mon Feb  2 21:02:39 2009 +0200| [248faa09ed297b6674672e841751996b5265e8e2] | committer: Rémi Denis-Courmont 

Improve libvlc drawable documentation

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=248faa09ed297b6674672e841751996b5265e8e2
---

 include/vlc/deprecated.h |    5 +++--
 include/vlc/libvlc.h     |   13 ++++++++++++-
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/include/vlc/deprecated.h b/include/vlc/deprecated.h
index ba9a7be..f7711ca 100644
--- a/include/vlc/deprecated.h
+++ b/include/vlc/deprecated.h
@@ -37,10 +37,11 @@ extern "C" {
 /**
  * Set the default video output's parent.
  *
- * This setting will be used as default for all video outputs.
+ * This setting will be used as default for any video output.
  *
  * \param p_instance libvlc instance
- * \param drawable the new parent window (Drawable on X11, CGrafPort on MacOSX, HWND on Win32)
+ * \param drawable the new parent window
+ *                 (see libvlc_media_player_set_drawable() for details)
  * \param p_e an initialized exception pointer
  * @deprecated Use libvlc_media_player_set_drawable
  */
diff --git a/include/vlc/libvlc.h b/include/vlc/libvlc.h
index 11c4fb9..baab65f 100644
--- a/include/vlc/libvlc.h
+++ b/include/vlc/libvlc.h
@@ -550,7 +550,18 @@ VLC_PUBLIC_API void libvlc_media_player_pause ( libvlc_media_player_t *, libvlc_
 VLC_PUBLIC_API void libvlc_media_player_stop ( libvlc_media_player_t *, libvlc_exception_t * );
 
 /**
- * Set the drawable where the media player should render its video output
+ * 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