[vlc-commits] window: document vout_window_ReportSize()

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sun Jan 29 19:52:09 2017 +0200| [809e7f7b04ca115067f5d4b6af7837b593651a9a] | committer: Rémi Denis-Courmont

window: document vout_window_ReportSize()

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

 include/vlc_vout_window.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/include/vlc_vout_window.h b/include/vlc_vout_window.h
index f40bbce..69a719b 100644
--- a/include/vlc_vout_window.h
+++ b/include/vlc_vout_window.h
@@ -230,6 +230,15 @@ static inline int vout_window_HideMouse(vout_window_t *window, bool hide)
     return vout_window_Control(window, VOUT_WINDOW_HIDE_MOUSE, hide);
 }
 
+/**
+ * Report current window size
+ *
+ * This notifies the user of the window what the pixel dimensions of the
+ * window are (or should be, depending on the windowing system).
+ *
+ * \note This function is thread-safe. In case of concurrent call, it is
+ * undefined which one is taken into account (but at least one is).
+ */
 static inline void vout_window_ReportSize(vout_window_t *window,
                                           unsigned width, unsigned height)
 {