From 7fc999b5777696c552e8b1b587aa55821e30bda2 Mon Sep 17 00:00:00 2001
From: wm4 <wm4@nowhere>
Date: Wed, 30 Apr 2014 22:25:11 +0200
Subject: vo: document draw_image

---
 video/out/vo.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'video/out/vo.h')

diff --git a/video/out/vo.h b/video/out/vo.h
index e096c3c208..629e25e0b0 100644
--- a/video/out/vo.h
+++ b/video/out/vo.h
@@ -177,6 +177,12 @@ struct vo_driver {
      */
     int (*control)(struct vo *vo, uint32_t request, void *data);
 
+    /*
+     * Render the given frame to the VO's backbuffer. This operation will be
+     * followed by a draw_osd and a flip_page[_timed] call.
+     * mpi belongs to the caller; if the VO needs it longer, it has to create
+     * a new reference to mpi.
+     */
     void (*draw_image)(struct vo *vo, struct mp_image *mpi);
 
     /*
-- 
cgit v1.2.3