[vlc-devel] commit: Note that embedded video cannot go to fullscreen directly ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Wed Dec 16 17:45:14 2009 +0200| [28c09f9f93b91c536a0d83fc0ab5280a101a5cb1] | committer: Rémi Denis-Courmont 

Note that embedded video cannot go to fullscreen directly

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

 include/vlc/libvlc_media_player.h |   15 +++++++++++++--
 1 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h
index 07a18af..220a547 100644
--- a/include/vlc/libvlc_media_player.h
+++ b/include/vlc/libvlc_media_player.h
@@ -511,7 +511,10 @@ VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t
  */
 
 /**
- * Toggle fullscreen status on video output.
+ * Toggle fullscreen status on a non-embedded video output.
+ *
+ * @warning The same limitations applies to this function
+ * as to libvlc_set_fullscreen().
  *
  * \param p_mediaplayer the media player
  * \param p_e an initialized exception pointer
@@ -519,7 +522,15 @@ VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t
 VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *, libvlc_exception_t * );
 
 /**
- * Enable or disable fullscreen on a video output.
+ * Enable or disable fullscreen on a non-embedded video output.
+ *
+ * @warning With most window managers, only a top-level windows can switch to
+ * full-screen mode. Hence, this function will not operate properly if
+ * libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was
+ * used to embed the video in a non-LibVLC widget. If you want to to render an
+ * embedded LibVLC video full-screen, the parent embedding widget must expanded
+ * to full screen (LibVLC cannot take care of that).
+ * LibVLC will then automatically resize the video as appropriate.
  *
  * \param p_mediaplayer the media player
  * \param b_fullscreen boolean for fullscreen status