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       bool waffle_window_destroy(struct waffle_window *self);
22
23       bool waffle_window_show(struct waffle_window *self);
24
25       bool waffle_window_swap_buffers(struct waffle_window *self);
26
27       union waffle_native_window*
28                                                            waffle_window_get_native(struct waffle_window *self);
29

DESCRIPTION

31       struct waffle_window
32           An opaque type.
33
34       waffle_window_create()
35           Create a window with the properties specified by config.
36
37           If the platform allows, the window is not displayed onto the screen
38           after creation. To display the window, call waffle_window_show().
39
40       waffle_window_destroy()
41           Destroy the window and release its memory.
42
43       waffle_window_show()
44           Show the window on the display. If the window is already shown, or
45           if the native platform does not support showing windows (such as
46           GBM), then do nothing and returns true.
47
48       waffle_window_swap_buffers()
49           If the window is double-buffered, then implicitly call glFlush()
50           and post the contents of the back buffer to the front buffer. If
51           the window is front-buffered, then do nothing. For
52           platform-specific details of swap semantics, see the specification
53           for the relevant native platform: the GLX 1.4 Specification[1], the
54           EGL 1.4 Specification[2], or the CGL Reference[3].
55
56       waffle_window_get_native()
57           Get the window's underlying native objects. Use free(3) to
58           deallocate the returned pointer. See waffle_native(3) for the
59           definition of union waffle_native_window.
60

RETURN VALUE

62       Functions whose return type is bool return true on success and false on
63       failure. Functions whose return type is a pointer return NULL on
64       failure. Use waffle_error_get_info(3) to get information about any
65       errors.
66

ERRORS

68       See waffle_error(3) for the complete list of waffle's error codes.
69
70       No errors are specific to the waffle_window functions.
71

ISSUES

73       Please report bugs or and feature requests to
74       https://github.com/waffle-gl/waffle/issues.
75

SEE ALSO

77       waffle(7)
78

AUTHOR

80       Chad Versace <chad.versace@linux.intel.com>
81           Maintainer
82

84       Copyright © 2013 Intel
85
86       This manual page is licensed under the Creative Commons
87       Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0). To
88       view a copy of this license, visit
89       http://creativecommons.org.license/by-sa/3.0/us.
90
91

NOTES

93        1. GLX 1.4 Specification
94           http://www.opengl.org/registry/doc/glx1.4.pdf
95
96        2. EGL 1.4 Specification
97           http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf
98
99        3. CGL Reference
100           https://developer.apple.com/library/mac/#documentation/graphicsimaging/reference/CGL_OpenGL/Reference/reference.html
101
102
103
104waffle                            02/03/2019                  WAFFLE_WINDOW(3)
Impressum