jammy (3) waffle_get_current_window.3.gz

Provided by: libwaffle-doc_1.7.0-2_all bug

NAME
       waffle_make_current, waffle_get_current_display, waffle_get_current_window, waffle_get_current_context -
       set and get resources current to the thread


SYNOPSIS
       #include <waffle.h>

       bool waffle_make_current(struct waffle_display *display, struct waffle_window *window,
                                struct waffle_context *context);

       struct waffle_display *waffle_get_current_display(void);

       struct waffle_window *waffle_get_current_window(void);

       struct waffle_context *waffle_get_current_context(void);


DESCRIPTION
       waffle_make_current()
           Bind the given window and context for rendering on the current thread.  window and context must both
           have been created on the given display. To unbind the current context without binding a new one, set
           window and context to NULL.

           This function is analogous to glXMakeCurrent(3), eglMakeCurrent(3), and [NSOpenGLContext
           makeCurrentContext].

       waffle_get_current_display()
           Get the display bound to the current thread, as previously bound by waffle_make_current(). If no
           display is bound, then return NULL.

           This function is analogous to glXGetCurrentDisplay(3) and eglGetCurrentDisplay(3).

       waffle_get_current_window()
           Get the window bound to the current thread, as previously bound by waffle_make_current(). If no
           window is bound, then return NULL.

           This function is analogous to glXGetCurrentDrawable(3) and eglGetCurrentSurface(3).

       waffle_get_current_context()
           Get the context bound to the current thread, as previously bound by waffle_make_current(). If no
           context is bound, then return NULL.

           This function is analogous to glXGetCurrentContext(3) and eglGetCurrentContext(3).


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 functions listed in this manual page.


BUGS
       Mixing calls to waffle_make_current() and the native platform's MakeCurrent() on the same thread do not
       interact well. After calling the native platform's MakeCurrent(), future Waffle function calls on the
       same thread are likely to behave incorrectly.


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 © 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.