src/cairo-drm.h

   1 /* Cairo - a vector graphics library with display and print output
   2  *
   3  * Copyright © 2009 Chris Wilson
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it either under the terms of the GNU Lesser General Public
   7  * License version 2.1 as published by the Free Software Foundation
   8  * (the "LGPL") or, at your option, under the terms of the Mozilla
   9  * Public License Version 1.1 (the "MPL"). If you do not alter this
  10  * notice, a recipient may use your version of this file under either
  11  * the MPL or the LGPL.
  12  *
  13  * You should have received a copy of the LGPL along with this library
  14  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
  16  * You should have received a copy of the MPL along with this library
  17  * in the file COPYING-MPL-1.1
  18  *
  19  * The contents of this file are subject to the Mozilla Public License
  20  * Version 1.1 (the "License"); you may not use this file except in
  21  * compliance with the License. You may obtain a copy of the License at
  22  * http://www.mozilla.org/MPL/
  23  *
  24  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
  25  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
  26  * the specific language governing rights and limitations.
  27  *
  28  * The Original Code is the cairo graphics library.
  29  *
  30  * The Initial Developer of the Original Code is Chris Wilson.
  31  */
  32
  33 #ifndef CAIRO_DRM_H
  34 #define CAIRO_DRM_H
  35
  36 #include "cairo.h"
  37
  38 #if CAIRO_HAS_DRM_SURFACE
  39
  40 CAIRO_BEGIN_DECLS
  41
  42 struct udev_device;
  43
  44 cairo_public cairo_device_t *
  45 cairo_drm_device_get (struct udev_device *device);
  46
  47 cairo_public cairo_device_t *
  48 cairo_drm_device_get_for_fd (int fd);
  49
  50 cairo_public cairo_device_t *
  51 cairo_drm_device_default (void);
  52
  53 cairo_public int
  54 cairo_drm_device_get_fd (cairo_device_t *device);
  55
  56 cairo_public void
  57 cairo_drm_device_throttle (cairo_device_t *device);
  58
  59 cairo_public cairo_surface_t *
  60 cairo_drm_surface_create (cairo_device_t *device,
  61                           cairo_format_t format,
  62                           int width, int height);
  63
  64 cairo_public cairo_surface_t *
  65 cairo_drm_surface_create_for_name (cairo_device_t *device,
  66                                    unsigned int name,
  67                                    cairo_format_t format,
  68                                    int width, int height, int stride);
  69
  70 cairo_public cairo_surface_t *
  71 cairo_drm_surface_create_from_cacheable_image (cairo_device_t *device,
  72                                                cairo_surface_t *surface);
  73
  74 cairo_public cairo_status_t
  75 cairo_drm_surface_enable_scan_out (cairo_surface_t *surface);
  76
  77 cairo_public unsigned int
  78 cairo_drm_surface_get_handle (cairo_surface_t *surface);
  79
  80 cairo_public unsigned int
  81 cairo_drm_surface_get_name (cairo_surface_t *surface);
  82
  83 cairo_public cairo_format_t
  84 cairo_drm_surface_get_format (cairo_surface_t *surface);
  85
  86 cairo_public int
  87 cairo_drm_surface_get_width (cairo_surface_t *surface);
  88
  89 cairo_public int
  90 cairo_drm_surface_get_height (cairo_surface_t *surface);
  91
  92 cairo_public int
  93 cairo_drm_surface_get_stride (cairo_surface_t *surface);
  94
  95 /* XXX map/unmap, general surface layer? */
  96
  97 /* Rough outline, culled from a conversation on IRC:
  98  *   map() returns an image-surface representation of the drm-surface,
  99  *   which you unmap() when you are finished, i.e. map() pulls the buffer back
 100  *   from the GPU, maps it into the CPU domain and gives you direct access to
 101  *   the pixels.  With the unmap(), the buffer is ready to be used again by the
 102  *   GPU and *until* the unmap(), all operations will be done in software.
 103  *
 104  *  (Technically calling cairo_surface_flush() on the underlying drm-surface
 105  *  will also disassociate the mapping.)
 106 */
 107 cairo_public cairo_surface_t *
 108 cairo_drm_surface_map_to_image (cairo_surface_t *surface);
 109
 110 cairo_public void
 111 cairo_drm_surface_unmap (cairo_surface_t *drm_surface,
 112                          cairo_surface_t *image_surface);
 113
 114 CAIRO_END_DECLS
 115
 116 #else  /* CAIRO_HAS_DRM_SURFACE */
 117 # error Cairo was not compiled with support for the DRM backend
 118 #endif /* CAIRO_HAS_DRM_SURFACE */
 119
 120 #endif /* CAIRO_DRM_H */