Man page - waffle_display(3)
Packages contains this manual
- waffle_teardown(3)
- waffle_dl_sym(3)
- waffle_dl(3)
- waffle_dl_can_open(3)
- waffle_wayland(3)
- waffle_error_to_string(3)
- waffle_get_current_display(3)
- waffle_feature_test_macros(7)
- waffle_glx_context(3)
- waffle_wayland_context(3)
- waffle_native_config(3)
- waffle(7)
- waffle_x11_egl_display(3)
- waffle_attrib_list_update(3)
- waffle_config_destroy(3)
- waffle_attrib_list_length(3)
- waffle_gbm_display(3)
- waffle_glx_display(3)
- waffle_native_window(3)
- waffle_wayland_window(3)
- waffle_wayland_config(3)
- waffle_gbm_config(3)
- waffle_context(3)
- waffle_error(3)
- waffle_glx_window(3)
- waffle_window_destroy(3)
- waffle_wayland_display(3)
- waffle_get_proc_address(3)
- waffle_context_get_native(3)
- waffle_gbm(3)
- waffle_glx(3)
- waffle_x11_egl_context(3)
- waffle_attrib_list(3)
- waffle_gbm_window(3)
- waffle_attrib_list_get(3)
- waffle_window_create(3)
- waffle_display_supports_context_api(3)
- waffle_window_swap_buffers(3)
- waffle_attrib_list_get_with_default(3)
- waffle_x11_egl_config(3)
- waffle_display_connect(3)
- waffle_get_current_window(3)
- waffle_get_current_context(3)
- waffle_native_display(3)
- waffle_x11_egl(3)
- waffle_display(3)
- waffle_glx_config(3)
- waffle_error_get_info(3)
- waffle_make_current(3)
- waffle_config_choose(3)
- waffle_display_disconnect(3)
- waffle_display_get_native(3)
- waffle_error_get_code(3)
- waffle_config_get_native(3)
- waffle_context_create(3)
- waffle_window(3)
- waffle_native_context(3)
- waffle_gbm_context(3)
- waffle_enum(3)
- waffle_enum_to_string(3)
- waffle_native(3)
- waffle_config(3)
- waffle_context_destroy(3)
- waffle_window_show(3)
- waffle_window_get_native(3)
- waffle_init(3)
- waffle_is_extension_in_string(3)
- waffle_x11_egl_window(3)
apt-get install libwaffle-doc
Manual
WAFFLE_DISPLAY
NAMESYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
ISSUES
SEE ALSO
AUTHOR
COPYRIGHT
NAME
waffle_display, waffle_display_connect, waffle_display_disconnect, waffle_display_supports_context_api, waffle_display_get_native - class waffle_display
SYNOPSIS
#include <waffle.h>
struct waffle_display;
|
struct waffle_display* waffle_display_connect(const char* name ); |
|
|
bool waffle_display_disconnect(struct waffle_display * self ); |
|
|
bool waffle_display_supports_context_api(struct waffle_display * self , int32_t context_api ); |
|
|
union waffle_native_display* waffle_display_get_native(struct waffle_display * self ); |
DESCRIPTION
struct waffle_display
An opaque type.
waffle_display_connect()
Connect to a display. The interpretation of name differs according to the platform given to waffle_init (3).
On Android, CGL and WGL name is ignored.
On the X11 platforms, GLX and X11/EGL, the function connects to the X11 display with the given name . If name is null, then it uses the value of the environment variable DISPLAY .
On Wayland, the function connects to the Wayland display with the given name. If name is null, then it uses the value of the environment variable WAYLAND_DISPLAY .
On GBM, the function opens the device at the filepath name . If name is NULL, then the function uses the value of environment variable WAFFLE_GBM_DEVICE . If name is null and WAFFLE_GBM_DEVICE is unset, then the function iterates using libdrm through the set of card devices in the drm subsystem, which are usually located in /dev/dri, and attempts to open each in turn with open(O_RDWR | O_CLOEXEC) until successful.
waffle_display_disconnect()
Disconnect from the waffle_display and release it's memory. All pointers to waffle objects that were created with the display become invalid.
waffle_display_supports_context_api()
Check if the display is capable of creating a waffle_context (3) with the given context_api . See waffle_config (3) for choices of context_api and expectations for each platform.
waffle_display_get_native()
Get the display's underlying native objects. Use free (3) to deallocate the returned pointer. See waffle_native (3) for the definition of union waffle_native_display .
RETURN VALUE
Functions whose return type is bool return true on success and false on failure. Functions whose return type is a pointer return NULL on failure. Use waffle_error_get_info (3) to get information about any errors.
ERRORS
See waffle_error (3) for the complete list of waffle's error codes.
No errors are specific to any of the waffle_display functions.
ISSUES
Please report bugs or and feature requests to https://gitlab.freedesktop.org/mesa/waffle/issues .
SEE ALSO
waffle (7)
AUTHOR
Chad Versace <chad.versace@linux.intel.com>
Former maintainer
COPYRIGHT
Copyright © 2013 Intel
This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us .