summaryrefslogtreecommitdiff
path: root/src/cairo-drm.h
blob: 907610dcde87bdf912d0c3cddf881a7bfc29eb40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/* Cairo - a vector graphics library with display and print output
 *
 * Copyright © 2009 Chris Wilson
 *
 * This library is free software; you can redistribute it and/or
 * modify it either under the terms of the GNU Lesser General Public
 * License version 2.1 as published by the Free Software Foundation
 * (the "LGPL") or, at your option, under the terms of the Mozilla
 * Public License Version 1.1 (the "MPL"). If you do not alter this
 * notice, a recipient may use your version of this file under either
 * the MPL or the LGPL.
 *
 * You should have received a copy of the LGPL along with this library
 * in the file COPYING-LGPL-2.1; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
 * You should have received a copy of the MPL along with this library
 * in the file COPYING-MPL-1.1
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
 * OF ANY KIND, either express or implied. See the LGPL or the MPL for
 * the specific language governing rights and limitations.
 *
 * The Original Code is the cairo graphics library.
 *
 * The Initial Developer of the Original Code is Chris Wilson.
 */

#ifndef CAIRO_DRM_H
#define CAIRO_DRM_H

#include "cairo.h"

#if CAIRO_HAS_DRM_SURFACE

CAIRO_BEGIN_DECLS

struct udev_device;

cairo_public cairo_device_t *
cairo_drm_device_get (struct udev_device *device);

cairo_public cairo_device_t *
cairo_drm_device_get_for_fd (int fd);

cairo_public cairo_device_t *
cairo_drm_device_default (void);

cairo_public int
cairo_drm_device_get_fd (cairo_device_t *device);

cairo_public void
cairo_drm_device_throttle (cairo_device_t *device);

cairo_public cairo_surface_t *
cairo_drm_surface_create (cairo_device_t *device,
			  cairo_format_t format,
			  int width, int height);

cairo_public cairo_surface_t *
cairo_drm_surface_create_for_name (cairo_device_t *device,
				   unsigned int name,
	                           cairo_format_t format,
				   int width, int height, int stride);

cairo_public cairo_surface_t *
cairo_drm_surface_create_from_cacheable_image (cairo_device_t *device,
	                                       cairo_surface_t *surface);

cairo_public cairo_status_t
cairo_drm_surface_enable_scan_out (cairo_surface_t *surface);

cairo_public unsigned int
cairo_drm_surface_get_handle (cairo_surface_t *surface);

cairo_public unsigned int
cairo_drm_surface_get_name (cairo_surface_t *surface);

cairo_public cairo_format_t
cairo_drm_surface_get_format (cairo_surface_t *surface);

cairo_public int
cairo_drm_surface_get_width (cairo_surface_t *surface);

cairo_public int
cairo_drm_surface_get_height (cairo_surface_t *surface);

cairo_public int
cairo_drm_surface_get_stride (cairo_surface_t *surface);

/* XXX map/unmap, general surface layer? */

/* Rough outline, culled from a conversation on IRC:
 *   map() returns an image-surface representation of the drm-surface,
 *   which you unmap() when you are finished, i.e. map() pulls the buffer back
 *   from the GPU, maps it into the CPU domain and gives you direct access to
 *   the pixels.  With the unmap(), the buffer is ready to be used again by the
 *   GPU and *until* the unmap(), all operations will be done in software.
 *
 *  (Technically calling cairo_surface_flush() on the underlying drm-surface
 *  will also disassociate the mapping.)
*/
cairo_public cairo_surface_t *
cairo_drm_surface_map_to_image (cairo_surface_t *surface);

cairo_public void
cairo_drm_surface_unmap (cairo_surface_t *drm_surface,
	                 cairo_surface_t *image_surface);

CAIRO_END_DECLS

#else  /* CAIRO_HAS_DRM_SURFACE */
# error Cairo was not compiled with support for the DRM backend
#endif /* CAIRO_HAS_DRM_SURFACE */

#endif /* CAIRO_DRM_H */