gallium/docs: clairify dmabuf fd ownership
authorRob Clark <robclark@freedesktop.org>
Thu, 3 Sep 2015 18:53:03 +0000 (14:53 -0400)
committerRob Clark <robclark@freedesktop.org>
Wed, 9 Sep 2015 15:24:56 +0000 (11:24 -0400)
Since debugging issues w/ fd's close()d at the wrong time can be quite
fun, this should probably be made more explicit in the docs.

Signed-off-by: Rob Clark <robclark@freedesktop.org>
src/gallium/include/pipe/p_screen.h

index a7b7b72ac89e4ed88b9c115edcc7e026f9b12efa..a22fb938dbb7a66eb283527a20454c89b76fe818 100644 (file)
@@ -173,6 +173,10 @@ struct pipe_screen {
     * Create a texture from a winsys_handle. The handle is often created in
     * another process by first creating a pipe texture and then calling
     * resource_get_handle.
+    *
+    * NOTE: in the case of DRM_API_HANDLE_TYPE_FD handles, the caller
+    * retains ownership of the FD.  (This is consistent with
+    * EGL_EXT_image_dma_buf_import)
     */
    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
                                                  const struct pipe_resource *templat,
@@ -190,6 +194,10 @@ struct pipe_screen {
     * Get a winsys_handle from a texture. Some platforms/winsys requires
     * that the texture is created with a special usage flag like
     * DISPLAYTARGET or PRIMARY.
+    *
+    * NOTE: in the case of DRM_API_HANDLE_TYPE_FD handles, the caller
+    * takes ownership of the FD.  (This is consistent with
+    * EGL_MESA_image_dma_buf_export)
     */
    boolean (*resource_get_handle)(struct pipe_screen *,
                                  struct pipe_resource *tex,