GlUtil

const val EGL_CONFIG_ATTRIBUTES_RGBA_1010102: IntArray<Int>!

const val EGL_CONFIG_ATTRIBUTES_RGBA_8888: IntArray<Int>!

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): Unit

Binds the texture of the given type with default configuration of GL_LINEAR filtering and GL_CLAMP_TO_EDGE wrapping.

java-static fun checkGlError(): Unit

Collects all OpenGL errors that occurred since this method was last called and throws a 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.

@RequiresApi(value = 17)
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.

@RequiresApi(value = 17)
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.

@RequiresApi(value = 17)
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.

@RequiresApi(value = 17)
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.

@RequiresApi(value = 17)
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 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 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.

@RequiresApi(value = 17)
java-static fun destroyEglContext(eglDisplay: EGLDisplay?, eglContext: EGLContext?): Unit

Destroys the EGLContext identified by the provided EGLDisplay and .

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

@RequiresApi(value = 17)
java-static fun destroyEglSurface(eglDisplay: EGLDisplay?, eglSurface: EGLSurface?): Unit

Destroys the EGLSurface identified by the provided EGLDisplay and .

@RequiresApi(value = 17)
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.

@RequiresApi(value = 17)
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.

@RequiresApi(value = 17)
java-static fun getContextMajorVersion(): Long

Returns the EGL_CONTEXT_CLIENT_VERSION of the current context.

Returns 0 if no EGLContextis focused.

@RequiresApi(value = 17)
java-static fun getCurrentContext(): EGLContext!

Gets the current context.

@RequiresApi(value = 17)
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 isBt2020PqExtensionSupported(): Boolean

Returns whether EXTENSION_COLORSPACE_BT2020_PQ 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.

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.