GlUtil

public static final int HOMOGENEOUS_COORDINATE_VECTOR_SIZE = 4

Number of elements in a 3d homogeneous coordinate vector describing a vertex.

public static final float LENGTH_NDC = 2.0f

Length of the normalized device coordinate (NDC) space, which spans from -1 to 1.

public static void awaitSyncObject(long syncObject)

Ensures that following commands on the current OpenGL context will not be executed until the sync point has been reached. If syncObject equals 0, this does not block the CPU, and only affects the current OpenGL context. Otherwise, this will block the CPU.

public static void bindTexture(int textureTarget, int texId, int sampleFilter)

Binds the texture of the given type with the specified MIN and MAG sampling filter and GL_CLAMP_TO_EDGE wrapping.

public static void blitFrameBuffer(
    int readFboId,
    GlRect readRect,
    int drawFboId,
    GlRect drawRect
)

Copies the pixels from readFboId into drawFboId. Requires OpenGL ES 3.0.

When the input pixel region (given by readRect) doesn't have the same size as the output region (given by drawRect), this method uses GL_LINEAR filtering to scale the image contents.

public static void checkGlError()

Collects all OpenGL errors that occurred since this method was last called and throws a GlException with the combined error message.

public static void checkGlException(boolean expression, String errorMessage)

Throws a GlException with the given message if expression evaluates to false.

public static void clearFocusedBuffers()

Fills the pixels in the current output render target buffers with (r=0, g=0, b=0, a=0).

Buffers can be focused using focusEglSurface and focusFramebufferUsingCurrentContext, focusFramebuffer, and createFocusedPlaceholderEglSurface.

public static float[] create4x4IdentityMatrix()

Creates a 4x4 identity matrix.

public static FloatBuffer createBuffer(float[] data)

Allocates a FloatBuffer with the given data.

public static EGLContext createEglContext(EGLDisplay eglDisplay)

Creates a new EGLContext for the specified EGLDisplay.

Configures the EGLContext with EGL_CONFIG_ATTRIBUTES_RGBA_8888 and OpenGL ES 2.0.

public static EGLContext createEglContext(
    EGLContext sharedContext,
    EGLDisplay eglDisplay,
    @IntRange(from = 2, to = 3) int openGlVersion,
    int[] configAttributes
)

Creates a new EGLContext for the specified EGLDisplay.

public static EGLSurface createEglSurface(
    EGLDisplay eglDisplay,
    Object surface,
    @C.ColorTransfer int colorTransfer,
    boolean isEncoderInputSurface
)

Creates a new EGLSurface wrapping the specified surface.

The EGLSurface will configure with OpenGL ES 2.0.

public static int createExternalTexture()

Creates a GL_TEXTURE_EXTERNAL_OES with default configuration of GL_LINEAR filtering and GL_CLAMP_TO_EDGE wrapping.

public static int createFboForTexture(int texId)

Returns a new framebuffer for the texture.

public static EGLSurface createFocusedPlaceholderEglSurface(
    EGLContext eglContext,
    EGLDisplay eglDisplay
)

Creates and focuses a placeholder EGLSurface.

This makes a EGLContext current when reading and writing to a surface is not required, configured with EGL_CONFIG_ATTRIBUTES_RGBA_8888.

public static long createGlSyncFence()

Returns a newly created sync object and inserts it into the GL command stream.

Returns 0 if the operation failed, no EGLContext is focused, or the focused EGLContext version is less than 3.0.

public static int createPixelBufferObject(int size)

Creates a pixel buffer object with a data store of the given size and usage GL_DYNAMIC_READ.

The buffer is suitable for repeated modification by OpenGL and reads by the application.

public static int createRgb10A2Texture(int width, int height)

Allocates a new normalized integerGL_RGB10_A2 texture with the specified dimensions.

Normalized integers in textures are automatically converted for floating point numbers https://www.khronos.org/opengl/wiki/Normalized_Integer

The only supported pixel data type for the GL_RGB10_A2 sized internal format is GL_UNSIGNED_INT_2_10_10_10_REV. See https://registry.khronos.org/OpenGL-Refpages/es3.0/html/glTexImage2D.xhtml

The created texture is not zero-initialized. To clear the texture, focus on the texture and clear its content.

public static int createTexture(Bitmap bitmap)

Allocates a new texture, initialized with the bitmap data and size.

public static int createTexture(
    int width,
    int height,
    boolean useHighPrecisionColorComponents
)

Allocates a new RGBA texture with the specified dimensions and color component precision.

The created texture is not zero-initialized. To clear the texture, focus on the texture and clear its content.

public static float[] createVertexBuffer(List<float[]> vertexList)

Flattens the list of 4 element NDC coordinate vectors into a buffer.

public static void deleteBuffer(int bufferId)

Deletes a buffer object, or silently ignores the method call if bufferId is unused.

public static void deleteFbo(int fboId)

Deletes a framebuffer, or silently ignores the method call if fboId is unused.

public static void deleteRbo(int rboId)

Deletes a renderbuffer, or silently ignores the method call if rboId is unused.

public static void deleteSyncObject(long syncObject)

Deletes the underlying native object.

The syncObject must not be used after deletion.

public static void deleteSyncObjectQuietly(long syncObject)

Releases the GL sync object if set, suppressing any error.

public static void deleteTexture(int textureId)

Deletes a GL texture.

public static void destroyEglContext(
    @Nullable EGLDisplay eglDisplay,
    @Nullable EGLContext eglContext
)

Destroys the EGLContext identified by the provided EGLDisplay and EGLContext.

This is a no-op if called on already-destroyed EGLDisplay and EGLContext instances.

public static void destroyEglSurface(
    @Nullable EGLDisplay eglDisplay,
    @Nullable EGLSurface eglSurface
)

Destroys the EGLSurface identified by the provided EGLDisplay and EGLSurface.

public static void focusEglSurface(
    EGLDisplay eglDisplay,
    EGLContext eglContext,
    EGLSurface eglSurface,
    int width,
    int height
)

Makes the specified eglSurface the render target, using a viewport of width by height pixels.

public static void focusFramebuffer(
    EGLDisplay eglDisplay,
    EGLContext eglContext,
    EGLSurface eglSurface,
    int framebuffer,
    int width,
    int height
)

Makes the specified framebuffer the render target, using a viewport of width by height pixels.

public static void focusFramebufferUsingCurrentContext(
    int framebuffer,
    int width,
    int height
)

Makes the specified framebuffer the render target, using a viewport of width by height pixels.

The caller must ensure that there is a current OpenGL context before calling this method.

public static int generateTexture()

Returns a new, unbound GL texture identifier.

public static long getContextMajorVersion()

Returns the EGL_CONTEXT_CLIENT_VERSION of the current context.

Returns 0 if no EGLContextis focused.

public static EGLContext getCurrentContext()

Gets the current context.

public static EGLDisplay getDefaultEglDisplay()

Returns an initialized default EGLDisplay.

public static float[] getNormalizedCoordinateBounds()

Bounds of normalized device coordinates, commonly used for defining viewport boundaries.

public static float[] getTextureCoordinateBounds()

Typical bounds used for sampling from textures.

public static boolean isBt2020HlgExtensionSupported()

Returns whether EXTENSION_COLORSPACE_BT2020_HLG is supported.

public static boolean isBt2020PqExtensionSupported()

Returns whether EXTENSION_COLORSPACE_BT2020_PQ is supported.

public static boolean isColorTransferSupported(@C.ColorTransfer int colorTransfer)

Returns whether the given C.ColorTransfer is supported.

public static boolean isProtectedContentExtensionSupported(Context context)

Returns whether creating a GL context with EXTENSION_PROTECTED_CONTENT is possible.

If true, the device supports a protected output path for DRM content when using GL.

public static boolean isSurfacelessContextExtensionSupported()

Returns whether the EXTENSION_SURFACELESS_CONTEXT extension is supported.

This extension allows passing EGL_NO_SURFACE for both the write and read surfaces in a call to eglMakeCurrent.

public static boolean isYuvTargetExtensionSupported()

Returns whether the EXTENSION_YUV_TARGET extension is supported.

This extension allows sampling raw YUV values from an external texture, which is required for HDR input.

@RequiresApi(value = 24)
public static ByteBuffer mapPixelBufferObject(int bufferId, int size)

Maps the pixel buffer object's data store of a given size and returns a ByteBuffer of OpenGL managed memory.

The application must not write into the returned ByteBuffer.

The pixel buffer object should have a previously scheduled pixel buffer read.

When the application no longer needs to access the returned buffer, call unmapPixelBufferObject.

This call blocks until the pixel buffer data from the last schedulePixelBufferRead call is available.

Requires API 24: see schedulePixelBufferRead.

@RequiresApi(value = 24)
public static void schedulePixelBufferRead(
    int readFboId,
    int width,
    int height,
    int bufferId
)

Reads pixel data from the GL_COLOR_ATTACHMENT0 attachment of a framebuffer into the data store of a pixel buffer object.

The texture backing the color attachment of readFboId and the buffer store of bufferId must hold an image of the given width and height with format GL_RGBA and type GL_UNSIGNED_BYTE.

This a non-blocking call which reads the data asynchronously.

Requires API 24: This method must call the version of glReadPixels which accepts an integer offset as the last parameter. This version of glReadPixels is not available in the Java GLES30 wrapper until API 24.

HDR support is not yet implemented.

public static void setTexture(int texId, Bitmap bitmap)

Sets the texId to contain the bitmap data and size.

public static void setToIdentity(float[] matrix)

Sets the input matrix to an identity matrix.

public static void terminate(EGLDisplay eglDisplay)

Terminates the EGLDisplay connection.

@RequiresApi(value = 24)
public static void unmapPixelBufferObject(int bufferId)

Unmaps the pixel buffer object bufferId's data store.

The pixel buffer object should be previously mapped.

After this method returns, accessing data inside a previously mappedByteBuffer results in undefined behaviour.

When this method returns, the pixel buffer object bufferId can be reused by schedulePixelBufferRead.

Requires API 24: see schedulePixelBufferRead.