'\" t
.\"     Title: waffle_native
.\"    Author: Chad Versace <chad.versace@linux.intel.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 10/21/2023
.\"    Manual: Waffle Manual
.\"    Source: waffle
.\"  Language: English
.\"
.TH "WAFFLE_NATIVE" "3" "10/21/2023" "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_native, waffle_native_display, waffle_native_config, waffle_native_context, waffle_native_window \- Containers for underlying native objects
.SH "SYNOPSIS"
.sp
.nf
#include <waffle\&.h>

union waffle_native_display {
    struct waffle_gbm_display *gbm;
    struct waffle_glx_display *glx;
    struct waffle_wayland_display *wayland;
    struct waffle_x11_egl_display *x11_egl;
};

union waffle_native_config {
    struct waffle_gbm_config *gbm;
    struct waffle_glx_config *glx;
    struct waffle_wayland_config *wayland;
    struct waffle_x11_egl_config *x11_egl;
};

union waffle_native_context {
    struct waffle_gbm_context *gbm;
    struct waffle_glx_context *glx;
    struct waffle_wayland_context *wayland;
    struct waffle_x11_egl_context *x11_egl;
};

union waffle_native_window {
    struct waffle_gbm_window *gbm;
    struct waffle_glx_window *glx;
    struct waffle_wayland_window *wayland;
    struct waffle_x11_egl_window *x11_egl;
};
    
.fi
.SH "DESCRIPTION"
.PP
Each of the
\fBwaffle_${obj}_get_native()\fR
functions returns a correspondingly named
\fBunion waffle_native_${obj}*\fR\&. For example,
\fBwaffle_window_get_native()\fR
returns
\fBunion waffle_native_window*\fR
.PP
For each platform, the header
<waffle_${platform}\&.h>
defines the native container structs\&. For example,
<waffle_glx\&.h>
defines the structs
\fBwaffle_glx_${obj}\fR\&.
.PP
Observerve that native container structs are not defined for all platforms that waffle supports\&. In particular, waffle supports Android (\fBWAFFLE_PLATFORM_ANDROID\fR) and MacOS via CGL (\fBWAFFLE_PLATFORM_CGL\fR), but no container structs are defined for those platforms\&. Presently, waffle does not expose the native objects for those platforms due to implementation difficulties\&.
.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),
\fBwaffle_gbm\fR(3),
\fBwaffle_glx\fR(3),
\fBwaffle_wayland\fR(3),
\fBwaffle_x11_egl\fR(3)
.SH "AUTHOR"
.PP
\fBChad Versace\fR <\&chad\&.versace@linux\&.intel\&.com\&>
.RS 4
Former 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