waffle_window 3
waffle_window waffle_window_create waffle_window_destroy waffle_window_show waffle_window_swap_buffers waffle_window_get_native class waffle_window

Waffle Manual

waffle

    #include <waffle.h>

    struct waffle_window;

struct waffle_window* `waffle_window_create` struct waffle_window *config int32_t width int32_t height struct waffle_window* `waffle_window_create2` struct waffle_window *config const intptr_t attrib_list[] bool `waffle_window_destroy` struct waffle_window *self bool `waffle_window_show` struct waffle_window *self bool `waffle_window_swap_buffers` struct waffle_window *self union waffle_native_window* `waffle_window_get_native` struct waffle_window *self

## Description

struct waffle_window

  An opaque type.

`waffle_window_create()`

  Create a window with the properties specified by config.

  If the platform allows, the window is not displayed onto the screen after creation. To display the window, call `waffle_window_show()`.

`waffle_window_create2()`

  Feature test macro: `WAFFLE_API_VERSION >= 0x0106`. (See waffle_feature_test_macros 7).

  Create a window with the properties specified by config and attrib_list. attrib_list must specify the window size either with the attributes `WAFFLE_WINDOW_WIDTH` and `WAFFLE_WINDOW_HEIGHT` having positive values <= `INT32_MAX`, or with the attribute `WAFFLE_WINDOW_FULLSCREEN` equal to true(1).

`waffle_window_destroy()`

  Destroy the window and release its memory.

`waffle_window_show()`

  Show the window on the display. If the window is already shown, or if the native platform does not support showing windows (such as GBM), then do nothing and returns true.

`waffle_window_swap_buffers()`

  If the window is double-buffered, then implicitly call `glFlush()` and post the contents of the back buffer to the front buffer. If the window is front-buffered, then do nothing. For platform-specific details of swap semantics, see the specification for the relevant native platform: the GLX 1.4 Specification, the EGL 1.4 Specification, or the CGL Reference.

`waffle_window_get_native()`

  Get the window's underlying native objects. Use `free` 3 to deallocate the returned pointer. See `waffle_native` 3 for the definition of union waffle_native_window.

## Return Value

## Errors

No errors are specific to the waffle_window functions.

## See Also

waffle 7