mirror of
https://github.com/openharmony/third_party_egl.git
synced 2026-07-01 22:54:28 -04:00
lizheng
101 lines
4.1 KiB
XML
Executable File
101 lines
4.1 KiB
XML
Executable File
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:base="" xml:id="eglInitialize">
|
|
<info>
|
|
<copyright>
|
|
<year>2003-2014</year>
|
|
<holder>The Khronos Group Inc.</holder>
|
|
</copyright>
|
|
</info>
|
|
<refmeta>
|
|
<refentrytitle>eglInitialize</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>eglInitialize</refname>
|
|
<refpurpose>
|
|
initialize an <acronym>EGL</acronym> display connection
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>EGLBoolean <function>eglInitialize</function></funcdef>
|
|
<paramdef>EGLDisplay <parameter>display</parameter></paramdef>
|
|
<paramdef>EGLint * <parameter>major</parameter></paramdef>
|
|
<paramdef>EGLint * <parameter>minor</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 xml:id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>display</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the EGL display connection to initialize.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>major</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Returns the major version number of the EGL implementation.
|
|
May be <constant>NULL</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>minor</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Returns the minor version number of the EGL implementation.
|
|
May be <constant>NULL</constant>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 xml:id="description"><title>Description</title>
|
|
<para>
|
|
<function>eglInitialize</function> initialized the EGL display
|
|
connection obtained with
|
|
<citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>.
|
|
Initializing an already initialized EGL display connection has no
|
|
effect besides returning the version numbers.
|
|
</para>
|
|
<para>
|
|
<parameter>major</parameter> and <parameter>minor</parameter>
|
|
do not return values if they are specified as <constant>NULL</constant>.
|
|
</para>
|
|
<para>
|
|
Use <citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>
|
|
to release resources associated with an EGL display connection.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>EGL_FALSE</constant> is returned if
|
|
<function>eglInitialize</function> fails,
|
|
<constant>EGL_TRUE</constant> otherwise.
|
|
<parameter>major</parameter> and <parameter>minor</parameter> are not
|
|
modified when <constant>EGL_FALSE</constant> is returned.
|
|
</para>
|
|
<para>
|
|
<constant>EGL_BAD_DISPLAY</constant> is generated if
|
|
<parameter>display</parameter> is not an EGL display connection.
|
|
</para>
|
|
<para>
|
|
<constant>EGL_NOT_INITIALIZED</constant> is generated if
|
|
<parameter>display</parameter> cannot be initialized.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 xml:id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>eglGetDisplay</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>eglTerminate</refentrytitle></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/>
|
|
</refentry>
|