wayland-egl-tizen: Add description of set_frontbuffer_mode

Change-Id: Ic9e966c1b7b7f4064996765cb5e4f63cd55f813a
Signed-off-by: Joonbum Ko <joonbum.ko@samsung.com>

diff --git a/src/wayland-egl-tizen/wayland-egl-tizen.h b/src/wayland-egl-tizen/wayland-egl-tizen.h
index 206f632..2cb0d25 100644 (file)
--- a/src/wayland-egl-tizen/wayland-egl-tizen.h
+++ b/src/wayland-egl-tizen/wayland-egl-tizen.h
@@ -58,6 +58,27 @@ void
 wl_egl_window_tizen_set_buffer_transform(struct wl_egl_window *egl_window,
                                                                                 int wl_output_transform);
 
+/**
+ * Set/unset frontbuffer rendering mode.
+ *
+ *  It makes be able to set frontbuffer rendering mode
+ * by passed wl_egl_window.
+ *  Even if caller set the frontbuffer mode, it works only if
+ * frontbuffer rendering is possible.
+ *  Even if frontbuffer rendering is impossible,
+ * the set value is maintained, and when it is possible,
+ * it operates as frontbuffer mode.
+ *  If the wl_egl_window does not have to use the fronbuffer mode,
+ * client can call it with set=0.
+ *
+ * Important *
+ * It is recommaned to call before draw call of every frame begins.
+ *
+ * @param egl_window handle to wl_egl_window.
+ * @param set 1 if user wants to set wl_egl_window to frontbuffer mode.
+ *            0 if user wants to unset frontbuffer mode.
+ *            default : 0
+ */
 void
 wl_egl_window_tizen_set_frontbuffer_mode(struct wl_egl_window *egl_window,
                                                                                 int set);
@@ -73,7 +94,6 @@ void
 wl_egl_window_tizen_set_window_serial(struct wl_egl_window *egl_window,
                                                                          unsigned int serial);
 
-/* temporary APIs for testing sync feature */
 /**
  * Create a sync fence fd that can tell wl_surface_commit done.
  *