st/egl: Add native_display_buffer interface.
[mesa.git] / src / gallium / state_trackers / egl / common / native_buffer.h
1 /*
2 * Mesa 3-D graphics library
3 * Version: 7.9
4 *
5 * Copyright (C) 2010 LunarG Inc.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23 * DEALINGS IN THE SOFTWARE.
24 *
25 * Authors:
26 * Chia-I Wu <olv@lunarg.com>
27 */
28
29 #ifndef _NATIVE_BUFFER_H_
30 #define _NATIVE_BUFFER_H_
31
32 #include "pipe/p_compiler.h"
33
34 struct native_display;
35 struct pipe_resource;
36
37 /**
38 * Buffer interface of the native display. It allows native buffers to be
39 * imported and exported.
40 *
41 * Just like a native window or a native pixmap, a native buffer is another
42 * native type. Its definition depends on the native display.
43 *
44 * For DRM platform, the type of a native buffer is struct winsys_handle.
45 */
46 struct native_display_buffer {
47 struct pipe_resource *(*import_buffer)(struct native_display *ndpy,
48 const struct pipe_resource *templ,
49 void *buf);
50
51 /**
52 * The resource must be creatred with PIPE_BIND_SHARED.
53 */
54 boolean (*export_buffer)(struct native_display *ndpy,
55 struct pipe_resource *res,
56 void *buf);
57 };
58
59 #endif /* _NATIVE_BUFFER_H_ */