Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

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

NAME
       waffle_window, waffle_window_create, waffle_window_destroy,
       waffle_window_show, waffle_window_swap_buffers,
       waffle_window_get_native	- class	waffle_window

SYNOPSIS
       #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[1], the
	   EGL 1.4 Specification[2], or	the CGL	Reference[3].

       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
       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 the waffle_window 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>
	   Maintainer

COPYRIGHT
       Copyright (C) 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.

NOTES
	1. GLX 1.4 Specification
	   http://www.opengl.org/registry/doc/glx1.4.pdf

	2. EGL 1.4 Specification
	   http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf

	3. CGL Reference
	   https://developer.apple.com/library/mac/#documentation/graphicsimaging/reference/CGL_OpenGL/Reference/reference.html

waffle				  08/30/2020		      WAFFLE_WINDOW(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | ISSUES | SEE ALSO | AUTHOR | COPYRIGHT | NOTES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=waffle_window&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help