Commit 248faa09 authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

Improve libvlc drawable documentation

parent 76fd9cb9
......@@ -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
*/
......
......@@ -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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment