GlUtil

const val HOMOGENEOUS_COORDINATE_VECTOR_SIZE = 4: Int

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

const val LENGTH_NDC = 2.0f: Float

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

java-static fun awaitSyncObject(syncObject: Long): Unit

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.

java-static fun bindTexture(textureTarget: Int, texId: Int, sampleFilter: Int): Unit

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

java-static fun blitFrameBuffer(
    readFboId: Int,
    readRect: GlRect!,
    drawFboId: Int,
    drawRect: GlRect!
): Unit

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.

java-static fun checkGlError(): Unit

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

java-static fun checkGlException(expression: Boolean, errorMessage: String!): Unit

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

java-static fun clearFocusedBuffers(): Unit

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.

java-static fun create4x4IdentityMatrix(): FloatArray<Float>!

Creates a 4x4 identity matrix.

java-static fun createBuffer(data: FloatArray!): FloatBuffer!

Allocates a FloatBuffer with the given data.

java-static fun createEglContext(eglDisplay: EGLDisplay!): EGLContext!

Creates a new EGLContext for the specified EGLDisplay.

Configures the EGLContext with EGL_CONFIG_ATTRIBUTES_RGBA_8888 and OpenGL ES 2.0.

java-static fun createEglContext(
    sharedContext: EGLContext!,
    eglDisplay: EGLDisplay!,
    openGlVersion: @IntRange(from = 2, to = 3) Int,
    configAttributes: IntArray!
): EGLContext!

Creates a new EGLContext for the specified EGLDisplay.

java-static fun createEglSurface(
    eglDisplay: EGLDisplay!,
    surface: Any!,
    @C.ColorTransfer colorTransfer: Int,
    isEncoderInputSurface: Boolean
): EGLSurface!

Creates a new EGLSurface wrapping the specified surface.

The EGLSurface will configure with OpenGL ES 2.0.

java-static fun createExternalTexture(): Int

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

java-static fun createFboForTexture(texId: Int): Int

Returns a new framebuffer for the texture.

java-static fun createFocusedPlaceholderEglSurface(
    eglContext: EGLContext!,
    eglDisplay: EGLDisplay!
): EGLSurface!

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.

java-static fun createGlSyncFence(): Long

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.

java-static fun createPixelBufferObject(size: Int): Int

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.

java-static fun createRgb10A2Texture(width: Int, height: Int): Int

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.

java-static fun createTexture(bitmap: Bitmap!): Int

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

java-static fun createTexture(
    width: Int,
    height: Int,
    useHighPrecisionColorComponents: Boolean
): Int

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.

java-static fun createVertexBuffer(vertexList: (Mutable)List<FloatArray!>!): FloatArray<Float>!

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

java-static fun deleteBuffer(bufferId: Int): Unit

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

java-static fun deleteFbo(fboId: Int): Unit

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

java-static fun deleteRbo(rboId: Int): Unit

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

java-static fun deleteSyncObject(syncObject: Long): Unit

Deletes the underlying native object.

The syncObject must not be used after deletion.

java-static fun deleteSyncObjectQuietly(syncObject: Long): Unit

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

java-static fun deleteTexture(textureId: Int): Unit

Deletes a GL texture.

java-static fun destroyEglContext(eglDisplay: EGLDisplay?, eglContext: EGLContext?): Unit

Destroys the EGLContext identified by the provided EGLDisplay and EGLContext.

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

java-static fun destroyEglSurface(eglDisplay: EGLDisplay?, eglSurface: EGLSurface?): Unit

Destroys the EGLSurface identified by the provided EGLDisplay and EGLSurface.

java-static fun focusEglSurface(
    eglDisplay: EGLDisplay!,
    eglContext: EGLContext!,
    eglSurface: EGLSurface!,
    width: Int,
    height: Int
): Unit

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

java-static fun focusFramebuffer(
    eglDisplay: EGLDisplay!,
    eglContext: EGLContext!,
    eglSurface: EGLSurface!,
    framebuffer: Int,
    width: Int,
    height: Int
): Unit

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

java-static fun focusFramebufferUsingCurrentContext(
    framebuffer: Int,
    width: Int,
    height: Int
): Unit

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.

java-static fun generateTexture(): Int

Returns a new, unbound GL texture identifier.

java-static fun getContextMajorVersion(): Long

Returns the EGL_CONTEXT_CLIENT_VERSION of the current context.

Returns 0 if no EGLContextis focused.

java-static fun getCurrentContext(): EGLContext!

Gets the current context.

java-static fun getDefaultEglDisplay(): EGLDisplay!

Returns an initialized default EGLDisplay.

java-static fun getNormalizedCoordinateBounds(): FloatArray<Float>!

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

java-static fun getTextureCoordinateBounds(): FloatArray<Float>!

Typical bounds used for sampling from textures.

java-static fun isBt2020HlgExtensionSupported(): Boolean

Returns whether EXTENSION_COLORSPACE_BT2020_HLG is supported.

java-static fun isBt2020PqExtensionSupported(): Boolean

Returns whether EXTENSION_COLORSPACE_BT2020_PQ is supported.

java-static fun isColorTransferSupported(@C.ColorTransfer colorTransfer: Int): Boolean

Returns whether the given C.ColorTransfer is supported.

java-static fun isProtectedContentExtensionSupported(context: Context!): Boolean

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.

java-static fun isSurfacelessContextExtensionSupported(): Boolean

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.

java-static fun isYuvTargetExtensionSupported(): Boolean

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)
java-static fun mapPixelBufferObject(bufferId: Int, size: Int): ByteBuffer!

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)
java-static fun schedulePixelBufferRead(
    readFboId: Int,
    width: Int,
    height: Int,
    bufferId: Int
): Unit

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.

java-static fun setTexture(texId: Int, bitmap: Bitmap!): Unit

Sets the texId to contain the bitmap data and size.

java-static fun setToIdentity(matrix: FloatArray!): Unit

Sets the input matrix to an identity matrix.

java-static fun terminate(eglDisplay: EGLDisplay!): Unit

Terminates the EGLDisplay connection.

@RequiresApi(value = 24)
java-static fun unmapPixelBufferObject(bufferId: Int): Unit

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.