1WAFFLE_WINDOW(3)                 Waffle Manual                WAFFLE_WINDOW(3)
2
3
4

NAME

6       waffle_window, waffle_window_create, waffle_window_destroy,
7       waffle_window_show, waffle_window_swap_buffers,
8       waffle_window_get_native - class waffle_window
9

SYNOPSIS

11       #include <waffle.h>
12
13       struct waffle_window;
14
15
16       struct waffle_window*
17                                                  waffle_window_create(struct waffle_window *config,
18                                                  int32_t width,
19                                                  int32_t height);
20
21       struct waffle_window*
22                                                   waffle_window_create2(struct waffle_window *config,
23                                                   const intptr_t attrib_list[]);
24
25       bool waffle_window_destroy(struct waffle_window *self);
26
27       bool waffle_window_show(struct waffle_window *self);
28
29       bool waffle_window_swap_buffers(struct waffle_window *self);
30
31       union waffle_native_window*
32                                                            waffle_window_get_native(struct waffle_window *self);
33

DESCRIPTION

35       struct waffle_window
36           An opaque type.
37
38       waffle_window_create()
39           Create a window with the properties specified by config.
40
41           If the platform allows, the window is not displayed onto the screen
42           after creation. To display the window, call waffle_window_show().
43
44       waffle_window_create2()
45           Feature test macro: WAFFLE_API_VERSION >= 0x0106. (See
46           waffle_feature_test_macros(7)).
47
48           Create a window with the properties specified by config and
49           attrib_list.  attrib_list must specify the window size either with
50           the attributes WAFFLE_WINDOW_WIDTH and WAFFLE_WINDOW_HEIGHT having
51           positive values <= INT32_MAX, or with the attribute
52           WAFFLE_WINDOW_FULLSCREEN equal to true(1).
53
54       waffle_window_destroy()
55           Destroy the window and release its memory.
56
57       waffle_window_show()
58           Show the window on the display. If the window is already shown, or
59           if the native platform does not support showing windows (such as
60           GBM), then do nothing and returns true.
61
62       waffle_window_swap_buffers()
63           If the window is double-buffered, then implicitly call glFlush()
64           and post the contents of the back buffer to the front buffer. If
65           the window is front-buffered, then do nothing. For
66           platform-specific details of swap semantics, see the specification
67           for the relevant native platform: the GLX 1.4 Specification[1], the
68           EGL 1.4 Specification[2], or the CGL Reference[3].
69
70       waffle_window_get_native()
71           Get the window's underlying native objects. Use free(3) to
72           deallocate the returned pointer. See waffle_native(3) for the
73           definition of union waffle_native_window.
74

RETURN VALUE

76       Functions whose return type is bool return true on success and false on
77       failure. Functions whose return type is a pointer return NULL on
78       failure. Use waffle_error_get_info(3) to get information about any
79       errors.
80

ERRORS

82       See waffle_error(3) for the complete list of waffle's error codes.
83
84       No errors are specific to the waffle_window functions.
85

ISSUES

87       Please report bugs or and feature requests to
88       https://gitlab.freedesktop.org/mesa/waffle/issues.
89

SEE ALSO

91       waffle(7)
92

AUTHOR

94       Chad Versace <chad.versace@linux.intel.com>
95           Maintainer
96

98       Copyright © 2013 Intel
99
100       This manual page is licensed under the Creative Commons
101       Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0). To
102       view a copy of this license, visit
103       http://creativecommons.org.license/by-sa/3.0/us.
104
105

NOTES

107        1. GLX 1.4 Specification
108           http://www.opengl.org/registry/doc/glx1.4.pdf
109
110        2. EGL 1.4 Specification
111           http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf
112
113        3. CGL Reference
114           https://developer.apple.com/library/mac/#documentation/graphicsimaging/reference/CGL_OpenGL/Reference/reference.html
115
116
117
118waffle                            07/22/2023                  WAFFLE_WINDOW(3)
Impressum