home | help 
WAFFLE_DISPLAY(3)		  Waffle Manual 	       WAFFLE_DISPLAY(3)

NAME
     waffle_display,   waffle_display_connect,	waffle_display_disconnect,  waf-
     fle_display_supports_context_api, waffle_display_get_native  -  class  waf-
     fle_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_dis-
							    play *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  vari-
	 able 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  WAF-
	 FLE_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  point-
	 ers  to  waffle  objects  that were created with the display become in-
	 valid.

     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 (C) 2013 Intel

     This  manual page is licensed under the Creative Commons Attribution-Share-
     Alike 3.0 United States License (CC BY-SA 3.0). To view a copy of this  li-
     cense, visit http://creativecommons.org.license/by-sa/3.0/us.

waffle				   08/27/2026		       WAFFLE_DISPLAY(3)
home | help