1 /* Cairo - a vector graphics library with display and print output
3 * Copyright © 2009 Chris Wilson
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.
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
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/
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.
28 * The Original Code is the cairo graphics library.
30 * The Initial Developer of the Original Code is Chris Wilson.
38 #if CAIRO_HAS_DRM_SURFACE
44 cairo_public cairo_device_t
*
45 cairo_drm_device_get (struct udev_device
*device
);
47 cairo_public cairo_device_t
*
48 cairo_drm_device_get_for_fd (int fd
);
50 cairo_public cairo_device_t
*
51 cairo_drm_device_default (void);
54 cairo_drm_device_get_fd (cairo_device_t
*device
);
57 cairo_drm_device_throttle (cairo_device_t
*device
);
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
);
64 cairo_public cairo_surface_t
*
65 cairo_drm_surface_create_for_name (cairo_device_t
*device
,
67 cairo_format_t format
,
68 int width
, int height
, int stride
);
70 cairo_public cairo_surface_t
*
71 cairo_drm_surface_create_from_cacheable_image (cairo_device_t
*device
,
72 cairo_surface_t
*surface
);
74 cairo_public cairo_status_t
75 cairo_drm_surface_enable_scan_out (cairo_surface_t
*surface
);
77 cairo_public
unsigned int
78 cairo_drm_surface_get_handle (cairo_surface_t
*surface
);
80 cairo_public
unsigned int
81 cairo_drm_surface_get_name (cairo_surface_t
*surface
);
83 cairo_public cairo_format_t
84 cairo_drm_surface_get_format (cairo_surface_t
*surface
);
87 cairo_drm_surface_get_width (cairo_surface_t
*surface
);
90 cairo_drm_surface_get_height (cairo_surface_t
*surface
);
93 cairo_drm_surface_get_stride (cairo_surface_t
*surface
);
95 /* XXX map/unmap, general surface layer? */
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.
104 * (Technically calling cairo_surface_flush() on the underlying drm-surface
105 * will also disassociate the mapping.)
107 cairo_public cairo_surface_t
*
108 cairo_drm_surface_map_to_image (cairo_surface_t
*surface
);
111 cairo_drm_surface_unmap (cairo_surface_t
*drm_surface
,
112 cairo_surface_t
*image_surface
);
116 #else /* CAIRO_HAS_DRM_SURFACE */
117 # error Cairo was not compiled with support for the DRM backend
118 #endif /* CAIRO_HAS_DRM_SURFACE */
120 #endif /* CAIRO_DRM_H */