File: waffle_window.3.xml

package info (click to toggle)
waffle 1.6.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,092 kB
  • sloc: ansic: 19,173; xml: 2,906; cpp: 489; objc: 465; sh: 100; makefile: 20
file content (212 lines) | stat: -rw-r--r-- 7,462 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd">

<!--
  Copyright Intel 2012

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

<refentry
    id="waffle_window"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->

  <refmeta>
    <refentrytitle>waffle_window</refentrytitle>
    <manvolnum>3</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>waffle_window</refname>
    <refname>waffle_window_create</refname>
    <refname>waffle_window_destroy</refname>
    <refname>waffle_window_show</refname>
    <refname>waffle_window_swap_buffers</refname>
    <refname>waffle_window_get_native</refname>
    <refpurpose>class <classname>waffle_window</classname></refpurpose>
  </refnamediv>

  <refentryinfo>
    <title>Waffle Manual</title>
    <productname>waffle</productname>
    <xi:include href="common/author-chad.versace.xml"/>
    <xi:include href="common/copyright.xml"/>
    <xi:include href="common/legalnotice.xml"/>
  </refentryinfo>

  <refsynopsisdiv>

    <funcsynopsis language="C">

      <funcsynopsisinfo>
#include &lt;waffle.h&gt;

struct waffle_window;
      </funcsynopsisinfo>

      <funcprototype>
        <funcdef>struct waffle_window* <function>waffle_window_create</function></funcdef>
        <paramdef>struct waffle_window *<parameter>config</parameter></paramdef>
        <paramdef>int32_t <parameter>width</parameter></paramdef>
        <paramdef>int32_t <parameter>height</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>struct waffle_window* <function>waffle_window_create2</function></funcdef>
        <paramdef>struct waffle_window *<parameter>config</parameter></paramdef>
        <paramdef>const intptr_t <parameter>attrib_list</parameter>[]</paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>bool <function>waffle_window_destroy</function></funcdef>
        <paramdef>struct waffle_window *<parameter>self</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>bool <function>waffle_window_show</function></funcdef>
        <paramdef>struct waffle_window *<parameter>self</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>bool <function>waffle_window_swap_buffers</function></funcdef>
        <paramdef>struct waffle_window *<parameter>self</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>union waffle_native_window* <function>waffle_window_get_native</function></funcdef>
        <paramdef>struct waffle_window *<parameter>self</parameter></paramdef>
      </funcprototype>

    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <variablelist>

      <varlistentry>
        <term><type>struct waffle_window</type></term><listitem><para>
            An opaque type.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><function>waffle_window_create()</function></term>
        <listitem>
          <para>
            Create a window with the properties specified by <parameter>config</parameter>.
          </para>
          <para>
            If the platform allows, the window is not displayed onto the screen after creation. To display the window,
            call <function>waffle_window_show()</function>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><function>waffle_window_create2()</function></term>
        <listitem>
          <para>
            Feature test macro: <code>WAFFLE_API_VERSION >= 0x0106</code>.
            (See <citerefentry><refentrytitle>waffle_feature_test_macros</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
          </para>
          <para>
            Create a window with the properties specified by
            <parameter>config</parameter> and
            <parameter>attrib_list</parameter>.

            <parameter>attrib_list</parameter> must specify the window size
            either with the attributes
            <constant>WAFFLE_WINDOW_WIDTH</constant> and
            <constant>WAFFLE_WINDOW_HEIGHT</constant> having positive values
            &lt;= <constant>INT32_MAX</constant>,
            or with the attribute
            <constant>WAFFLE_WINDOW_FULLSCREEN</constant> equal to true(1).
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><function>waffle_window_destroy()</function></term>
        <listitem>
          <para>
            Destroy the window and release its memory.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><function>waffle_window_show()</function></term>
        <listitem>
          <para>
            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.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><function>waffle_window_swap_buffers()</function></term>
        <listitem>
          <para>
            If the window is double-buffered, then implicitly call <function>glFlush()</function> 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 <ulink url="http://www.opengl.org/registry/doc/glx1.4.pdf">GLX 1.4 Specification</ulink>,
            the <ulink url="http://www.khronos.org/registry/egl/specs/eglspec.1.4.20110406.pdf">EGL 1.4 Specification</ulink>,
            or the <ulink url="https://developer.apple.com/library/mac/#documentation/graphicsimaging/reference/CGL_OpenGL/Reference/reference.html">CGL Reference</ulink>.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><function>waffle_window_get_native()</function></term>
        <listitem>
          <para>
            Get the window's underlying native objects. Use
            <citerefentry><refentrytitle><function>free</function></refentrytitle><manvolnum>3</manvolnum></citerefentry> to deallocate the
            returned pointer.
            See <citerefentry><refentrytitle><function>waffle_native</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>
            for the definition of <type>union waffle_native_window</type>.
          </para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Return Value</title>
    <xi:include href="common/return-value.xml"/>
  </refsect1>

  <refsect1>
    <title>Errors</title>

    <xi:include href="common/error-codes.xml"/>

    <para>
      No errors are specific to the <type>waffle_window</type> functions.
    </para>
  </refsect1>

  <xi:include href="common/issues.xml"/>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>

<!--
vim:tw=120 et ts=2 sw=2:
-->