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

libvlc_video_set_fullscreen: fix documentation

parent e8e65d95
...@@ -501,15 +501,14 @@ VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t ...@@ -501,15 +501,14 @@ VLC_PUBLIC_API void libvlc_track_description_release( libvlc_track_description_t
VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi ); VLC_PUBLIC_API void libvlc_toggle_fullscreen( libvlc_media_player_t *p_mi );
/** /**
* Enable or disable fullscreen on non-embedded video outputs. * Enable or disable fullscreen.
* *
* @warning With most window managers, only a top-level windows can switch to * @warning With most window managers, only a top-level windows can be in
* full-screen mode. Hence, this function will not operate properly if * full-screen mode. Hence, this function will not operate properly if
* libvlc_media_player_set_xid() or libvlc_media_player_set_hwnd() was * libvlc_media_player_set_xid() was used to embed the video in a non-top-level
* used to embed the video in a non-LibVLC widget. If you want to to render an * window. In that case, the embedding window must be reparented to the root
* embedded LibVLC video full-screen, the parent embedding widget must expanded * window <b>before</b> fullscreen mode is enabled. You will want to reparent
* to full screen (LibVLC cannot take care of that). * it back to its normal parent when disabling fullscreen.
* LibVLC will then automatically resize the video as appropriate.
* *
* \param p_mi the media player * \param p_mi the media player
* \param b_fullscreen boolean for fullscreen status * \param b_fullscreen boolean for fullscreen status
......
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