diff options
| author | Chad Versace <chad.versace@linux.intel.com> | 2013-09-16 15:29:54 -0700 |
|---|---|---|
| committer | Chad Versace <chad.versace@linux.intel.com> | 2013-09-16 21:11:36 -0700 |
| commit | 11eebf6538605380b1ee9a7ea196d80ce7c5b213 (patch) | |
| tree | e96406891a278893d8061db2c62dee67592c6b8c /man | |
| parent | ba06cdaae06e0fcd9ee0c1b0b587355e05525b81 (diff) | |
man: Document new attrib WAFFLE_CONTEXT_FORWARD_COMPATIBLE
The new attribute isn't implemented yet, but I like to commit
documentations before implementation. This attribute selects
a foward-compatible context.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/waffle_config.3.xml | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/man/waffle_config.3.xml b/man/waffle_config.3.xml index 082ed92..42a92bc 100644 --- a/man/waffle_config.3.xml +++ b/man/waffle_config.3.xml @@ -344,6 +344,38 @@ struct waffle_config; </varlistentry> <varlistentry> + <term><constant>WAFFLE_CONTEXT_FORWARD_COMPATIBLE</constant></term> + <listitem> + <para> + This attribute, if true, instructs + <citerefentry><refentrytitle><function>waffle_context_create</function></refentrytitle><manvolnum>3</manvolnum></citerefentry> + to create a forward-compatible context. + + However, even if <function>waffle_config_choose()</function> + successfully returns a config for a forward-compatible context, the + native platform may later reject it when + <citerefentry><refentrytitle><function>waffle_context_create</function></refentrytitle><manvolnum>3</manvolnum></citerefentry> + is called. + </para> + <para> + Forward-compatible contexts do not support functionality marked as + deprecated by that version of the API. A non-forward-compatible + context supports all functionality in that version, deprecated or + not. + </para> + <para> + This attribute is optional and its default value is false(0). + + Valid values are true(1), false(0), and <constant>WAFFLE_DONT_CARE</constant>. + + However, true(1) is valid only if + the requested context API is <constant>WAFFLE_CONTEXT_OPENGL</constant> + and its version is at least 3.0. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><constant>WAFFLE_RED_SIZE</constant></term> <term><constant>WAFFLE_GREEN_SIZE</constant></term> <term><constant>WAFFLE_BLUE_SIZE</constant></term> |