Skip to content

Document EGL lifecycle APIs #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 3 commits into
base: main
Choose a base branch
from
+104 −20
Open

Document EGL lifecycle APIs #521

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82c60ed
Document EGL lifecycle APIs
jonathanpeppers Aug 15, 2026
2cb6dad
Clarify EGL lifecycle documentation
jonathanpeppers Aug 15, 2026
02bcbd5
Document Android EGL argument contracts
jonathanpeppers Aug 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 104 additions & 20 deletions docs/xml/Javax.Microedition.Khronos.Egl/IEGL10.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1134,8 +1134,13 @@
<Parameters />
<Docs>
<summary>
Gets the EGL rendering context current to the calling thread.
</summary>
<returns>To be added.</returns>
<returns>
The current rendering context, or
<see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoContext" />
if no context is current.
</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -1164,8 +1169,13 @@
<Parameters />
<Docs>
<summary>
Gets the EGL display connection for the current rendering context.
</summary>
<returns>To be added.</returns>
<returns>
The current display connection, or
<see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoDisplay" />
if no context is current.
</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -1195,10 +1205,24 @@
<Parameter Name="readdraw" Type="System.Int32" />
</Parameters>
<Docs>
<param name="readdraw">To be added.</param>
<param name="readdraw">
Specifies whether to retrieve the read
(<see cref="F:Javax.Microedition.Khronos.Egl.IEGL10.EglRead" />) or draw
(<see cref="F:Javax.Microedition.Khronos.Egl.IEGL10.EglDraw" />) surface.
</param>
<summary>
Gets the requested surface of the current EGL rendering context.
</summary>
<returns>To be added.</returns>
<returns>
The requested current surface, or
<see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoSurface" />
if no context is current.
</returns>
<exception cref="T:Java.Lang.IllegalArgumentException">
<paramref name="readdraw" /> is neither
<see cref="F:Javax.Microedition.Khronos.Egl.IEGL10.EglRead" /> nor
<see cref="F:Javax.Microedition.Khronos.Egl.IEGL10.EglDraw" />.
</exception>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -1228,11 +1252,19 @@
<Parameter Name="native_display" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="native_display">To be added.</param>
<param name="native_display">
Ignored by Android's EGL binding.
</param>
<summary>
Gets Android's default EGL display connection.
</summary>
<returns>To be added.</returns>
<returns>
The default EGL display connection, or
<see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoDisplay" />
if no display connection is available.
</returns>
<remarks>
<para>Android's <format type="text/html"><a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/jni/com_google_android_gles_jni_EGLImpl.cpp" title="Android Open Source Project EGL binding">AOSP EGL binding</a></format> always obtains <see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglDefaultDisplay" />.</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -1260,8 +1292,12 @@
<Parameters />
<Docs>
<summary>
Gets and clears the error from the last EGL function invoked on the current thread.
</summary>
<returns>To be added.</returns>
<returns>
The EGL error code. Calling this method resets the error to
<see cref="F:Javax.Microedition.Khronos.Egl.IEGL10.EglSuccess" />.
</returns>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -1367,12 +1403,24 @@
<Parameter Name="major_minor" Type="System.Int32[]" />
</Parameters>
<Docs>
<param name="display">To be added.</param>
<param name="major_minor">To be added.</param>
<param name="display">The EGL display connection to initialize.</param>
<param name="major_minor">
May be <see langword="null" />. Otherwise, it must contain at least two elements and
receives the EGL major and minor version numbers at indices 0 and 1.
</param>
<summary>
Initializes an EGL display connection.
</summary>
<returns>To be added.</returns>
<returns>
<see langword="true" /> if the display connection was initialized; otherwise,
<see langword="false" />.
</returns>
<exception cref="T:Java.Lang.IllegalArgumentException">
<paramref name="display" /> is <see langword="null" />, or
<paramref name="major_minor" /> is non-null and has fewer than two elements.
</exception>
<remarks>
<para>Android's <format type="text/html"><a href="https://android.googlesource.com/platform/frameworks/base/+/refs/heads/main/core/jni/com_google_android_gles_jni_EGLImpl.cpp" title="Android Open Source Project EGL binding">AOSP EGL binding</a></format> exposes EGL 1.0 through <paramref name="major_minor" />.</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -1504,13 +1552,32 @@
<Parameter Name="context" Type="Javax.Microedition.Khronos.Egl.EGLContext" />
</Parameters>
<Docs>
<param name="display">To be added.</param>
<param name="draw">To be added.</param>
<param name="read">To be added.</param>
<param name="context">To be added.</param>
<param name="display">The EGL display connection.</param>
<param name="draw">
The draw surface, or <see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoSurface" />
when releasing the current context.
</param>
<param name="read">
The read surface, or <see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoSurface" />
when releasing the current context.
</param>
<param name="context">
The rendering context to attach to the surfaces. Pass
<see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoContext" /> with both surfaces
set to <see cref="P:Javax.Microedition.Khronos.Egl.IEGL10.EglNoSurface" /> to release
the current context.
</param>
<summary>
Binds a rendering context to the calling thread and to its draw and read surfaces.
</summary>
<returns>To be added.</returns>
<returns>
<see langword="true" /> if the context was made current; otherwise,
<see langword="false" />.
</returns>
<exception cref="T:Java.Lang.IllegalArgumentException">
<paramref name="display" />, <paramref name="draw" />, <paramref name="read" />, or
<paramref name="context" /> is <see langword="null" />.
</exception>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -2329,12 +2396,21 @@
<Parameter Name="surface" Type="Javax.Microedition.Khronos.Egl.EGLSurface" />
</Parameters>
<Docs>
<param name="display">To be added.</param>
<param name="surface">To be added.</param>
<param name="display">The EGL display connection.</param>
<param name="surface">The drawing surface whose buffers are swapped.</param>
<summary>
Swaps the color buffers of an EGL drawing surface.
</summary>
<returns>To be added.</returns>
<returns>
<see langword="true" /> if the buffers were swapped; otherwise,
<see langword="false" />.
</returns>
<exception cref="T:Java.Lang.IllegalArgumentException">
<paramref name="display" /> or <paramref name="surface" /> is
<see langword="null" />.
</exception>
<remarks>
<para>For a back-buffered window surface, this posts the color buffer to its native window. It has no effect on a single-buffered window, pixmap, or pixel-buffer surface.</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down Expand Up @@ -2363,11 +2439,19 @@
<Parameter Name="display" Type="Javax.Microedition.Khronos.Egl.EGLDisplay" />
</Parameters>
<Docs>
<param name="display">To be added.</param>
<param name="display">The EGL display connection to terminate.</param>
<summary>
Releases resources associated with an EGL display connection.
</summary>
<returns>To be added.</returns>
<returns>
<see langword="true" /> if the display connection was terminated; otherwise,
<see langword="false" />.
</returns>
<exception cref="T:Java.Lang.IllegalArgumentException">
<paramref name="display" /> is <see langword="null" />.
</exception>
<remarks>
<para>Resources associated with contexts or surfaces that are current remain until they are no longer current.</para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
<since version="Added in API level 1" />
Expand Down