'\" t .\" Title: waffle_window .\" Author: Chad Versace .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 03/25/2021 .\" Manual: Waffle Manual .\" Source: waffle .\" Language: English .\" .TH "WAFFLE_WINDOW" "3" "03/25/2021" "waffle" "Waffle Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" waffle_window, waffle_window_create, waffle_window_destroy, waffle_window_show, waffle_window_swap_buffers, waffle_window_get_native \- class waffle_window .SH "SYNOPSIS" .sp .ft B .nf #include struct waffle_window; .fi .ft .HP \w'struct\ waffle_window*\ waffle_window_create('u .BI "struct waffle_window* waffle_window_create(struct\ waffle_window\ *" "config" ", int32_t\ " "width" ", int32_t\ " "height" ");" .HP \w'struct\ waffle_window*\ waffle_window_create2('u .BI "struct waffle_window* waffle_window_create2(struct\ waffle_window\ *" "config" ", const\ intptr_t\ " "attrib_list" "[]);" .HP \w'bool\ waffle_window_destroy('u .BI "bool waffle_window_destroy(struct\ waffle_window\ *" "self" ");" .HP \w'bool\ waffle_window_show('u .BI "bool waffle_window_show(struct\ waffle_window\ *" "self" ");" .HP \w'bool\ waffle_window_swap_buffers('u .BI "bool waffle_window_swap_buffers(struct\ waffle_window\ *" "self" ");" .HP \w'union\ waffle_native_window*\ waffle_window_get_native('u .BI "union waffle_native_window* waffle_window_get_native(struct\ waffle_window\ *" "self" ");" .SH "DESCRIPTION" .PP \fBstruct waffle_window\fR .RS 4 An opaque type\&. .RE .PP \fBwaffle_window_create()\fR .RS 4 Create a window with the properties specified by \fIconfig\fR\&. .sp If the platform allows, the window is not displayed onto the screen after creation\&. To display the window, call \fBwaffle_window_show()\fR\&. .RE .PP \fBwaffle_window_create2()\fR .RS 4 Feature test macro: WAFFLE_API_VERSION >= 0x0106\&. (See \fBwaffle_feature_test_macros\fR(7))\&. .sp Create a window with the properties specified by \fIconfig\fR and \fIattrib_list\fR\&. \fIattrib_list\fR must specify the window size either with the attributes \fBWAFFLE_WINDOW_WIDTH\fR and \fBWAFFLE_WINDOW_HEIGHT\fR having positive values <= \fBINT32_MAX\fR, or with the attribute \fBWAFFLE_WINDOW_FULLSCREEN\fR equal to true(1)\&. .RE .PP \fBwaffle_window_destroy()\fR .RS 4 Destroy the window and release its memory\&. .RE .PP \fBwaffle_window_show()\fR .RS 4 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\&. .RE .PP \fBwaffle_window_swap_buffers()\fR .RS 4 If the window is double\-buffered, then implicitly call \fBglFlush()\fR 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 \m[blue]\fBGLX 1\&.4 Specification\fR\m[]\&\s-2\u[1]\d\s+2, the \m[blue]\fBEGL 1\&.4 Specification\fR\m[]\&\s-2\u[2]\d\s+2, or the \m[blue]\fBCGL Reference\fR\m[]\&\s-2\u[3]\d\s+2\&. .RE .PP \fBwaffle_window_get_native()\fR .RS 4 Get the window\*(Aqs underlying native objects\&. Use \fBfree\fR(3) to deallocate the returned pointer\&. See \fBwaffle_native\fR(3) for the definition of \fBunion waffle_native_window\fR\&. .RE .SH "RETURN VALUE" .PP Functions whose return type is \fBbool\fR return true on success and false on failure\&. Functions whose return type is a pointer return \fBNULL\fR on failure\&. Use \fBwaffle_error_get_info\fR(3) to get information about any errors\&. .SH "ERRORS" .PP See \fBwaffle_error\fR(3) for the complete list of waffle\*(Aqs error codes\&. .PP No errors are specific to the \fBwaffle_window\fR functions\&. .SH "ISSUES" .PP Please report bugs or and feature requests to \m[blue]\fB\%https://gitlab.freedesktop.org/mesa/waffle/issues\fR\m[]\&. .SH "SEE ALSO" .PP \fBwaffle\fR(7) .SH "AUTHOR" .PP \fBChad Versace\fR <\&chad\&.versace@linux\&.intel\&.com\&> .RS 4 Maintainer .RE .SH "COPYRIGHT" .br Copyright \(co 2013 Intel .br .PP 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 \m[blue]\fB\%http://creativecommons.org.license/by-sa/3.0/us\fR\m[]\&. .sp .SH "NOTES" .IP " 1." 4 GLX 1.4 Specification .RS 4 \%http://www.opengl.org/registry/doc/glx1.4.pdf .RE .IP " 2." 4 EGL 1.4 Specification .RS 4 \%http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf .RE .IP " 3." 4 CGL Reference .RS 4 \%https://developer.apple.com/library/mac/#documentation/graphicsimaging/reference/CGL_OpenGL/Reference/reference.html .RE