A library that provides GLView that acts as an OpenGL ES render target and provides GLContext. Useful for rendering 2D and 3D graphics.
GitHub
npm
expo-gl
provides a View
that acts as an OpenGL ES render target, useful for rendering 2D and 3D graphics. On mounting, an OpenGL ES context is created. Its drawing buffer is presented as the contents of the View
every frame.
-
npx expo install expo-gl
If you are installing this in an existing React Native app, start by installing expo
in your project. Then, follow the additional instructions as mentioned by the library's README under "Installation in bare React Native projects" section.
import React from 'react';
import { View } from 'react-native';
import { GLView } from 'expo-gl';
export default function App() {
return (
<View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
<GLView style={{ width: 300, height: 300 }} onContextCreate={onContextCreate} />
</View>
);
}
function onContextCreate(gl) {
gl.viewport(0, 0, gl.drawingBufferWidth, gl.drawingBufferHeight);
gl.clearColor(0, 1, 1, 1);
// Create vertex shader (shape & position)
const vert = gl.createShader(gl.VERTEX_SHADER);
gl.shaderSource(
vert,
`
void main(void) {
gl_Position = vec4(0.0, 0.0, 0.0, 1.0);
gl_PointSize = 150.0;
}
`
);
gl.compileShader(vert);
// Create fragment shader (color)
const frag = gl.createShader(gl.FRAGMENT_SHADER);
gl.shaderSource(
frag,
`
void main(void) {
gl_FragColor = vec4(0.0, 0.0, 0.0, 1.0);
}
`
);
gl.compileShader(frag);
// Link together into a program
const program = gl.createProgram();
gl.attachShader(program, vert);
gl.attachShader(program, frag);
gl.linkProgram(program);
gl.useProgram(program);
gl.clear(gl.COLOR_BUFFER_BIT);
gl.drawArrays(gl.POINTS, 0, 1);
gl.flush();
gl.endFrameEXP();
}
Since the WebGL API is quite low-level, it can be helpful to use higher-level graphics APIs rendering through a GLView
underneath. The following libraries integrate popular graphics APIs:
Any WebGL-supporting library that expects a WebGLRenderingContext could be used. Some times such libraries assume a web JavaScript context (such as assuming document
). Usually this is for resource loading or event handling, with the main rendering logic still only using pure WebGL. So these libraries can usually still be used with a couple workarounds. The Expo-specific integrations above include workarounds for some popular libraries.
To use this API inside Reanimated worklet, you need to pass the GL context ID to the worklet and recreate the GL object like in the example below.
import React from 'react';
import { View } from 'react-native';
import { runOnUI } from 'react-native-reanimated';
import { GLView } from 'expo-gl';
function render(gl) {
'worklet';
// add your WebGL code here
}
function onContextCreate(gl) {
runOnUI((contextId: number) => {
'worklet';
const gl = GLView.getWorkletContext(contextId);
render(gl);
})(gl.contextId);
}
export default function App() {
return (
<View style={{ flex: 1, justifyContent: 'center', alignItems: 'center' }}>
<GLView
style={{ width: 300, height: 300 }}
enableExperimentalWorkletSupport
onContextCreate={onContextCreate}
/>
</View>
);
}
For more in-depth example on how to use expo-gl
with Reanimated and Gesture Handler you can check this example.
Worklet runtime is imposing some limitations on the code that runs inside it, so if you have existing WebGL code, it'll likely require some modifications to run inside a worklet thread.
'worklet'
added at the start.expo-assets
you can just pass asset object returned by Asset.fromModule
or from hook useAssets
to the runOnUI
function.requestAnimationFrame
, APIs like setTimeout
are not supported.Check Reanimated documentation to learn more.
This API does not function as intended with remote debugging enabled. The React Native debugger runs JavaScript on your computer, not the mobile device. GLView requires synchronous native calls that are not supported in Chrome.
import { GLView } from 'expo-gl';
GLView
Type: React.Component<GLViewProps>
A View that acts as an OpenGL ES render target. On mounting, an OpenGL ES context is created. Its drawing buffer is presented as the contents of the View every frame.
enableExperimentalWorkletSupport
Type: boolean
• Default: false
Enables support for interacting with a gl
object from code running on the Reanimated worklet thread.
msaaSamples
Type: number
• Default: 4
GLView
can enable iOS's built-in multisampling.
This prop specifies the number of samples to use. Setting this to 0
turns off multisampling.
onContextCreate
Type: (gl: ExpoWebGLRenderingContext) => void
A function that will be called when the OpenGL ES context is created.
The function is passed a single argument gl
that extends a WebGLRenderingContext interface.
createContextAsync()
Imperative API that creates headless context which is devoid of underlying view. It's useful for headless rendering or in case you want to keep just one context per application and share it between multiple components. It is slightly faster than usual context as it doesn't swap framebuffers and doesn't present them on the canvas, however it may require you to take a snapshot in order to present its results. Also, keep in mind that you need to set up a viewport and create your own framebuffer and texture that you will be drawing to, before you take a snapshot.
A promise that resolves to WebGL context object. See WebGL API for more details.
destroyContextAsync(exgl)
Parameter | Type | Description |
---|---|---|
exgl (optional) | number | ExpoWebGLRenderingContext | WebGL context to destroy. |
Destroys given context.
Promise<boolean>
A promise that resolves to boolean value that is true
if given context existed and has been destroyed successfully.
takeSnapshotAsync(exgl, options)
Parameter | Type | Description |
---|---|---|
exgl (optional) | number | ExpoWebGLRenderingContext | WebGL context to take a snapshot from. |
options (optional) | SnapshotOptions | - |
Takes a snapshot of the framebuffer and saves it as a file to app's cache directory.
A promise that resolves to GLSnapshot
object.
startARSessionAsync()
Promise<any>
takeSnapshotAsync(options)
Parameter | Type |
---|---|
options (optional) | SnapshotOptions |
Same as static takeSnapshotAsync()
,
but uses WebGL context that is associated with the view on which the method is called.
GLView.getWorkletContext(contextId)
Parameter | Type |
---|---|
contextId | number |
ExpoWebGLRenderingContext | undefined
ExpoWebGLRenderingContext
Extends: WebGL2RenderingContext
ExpoWebGLRenderingContext Methods
endFrameEXP()
void
flushEXP()
void
ExpoWebGLRenderingContext Properties
Name | Type | Description |
---|---|---|
contextId | number | - |
ComponentOrHandle
Literal Type: multiple types
Acceptable values are: null
| number
| Component<any, any>
| ComponentClass<any>
GLSnapshot
Name | Type | Description |
---|---|---|
height | number | Height of the snapshot. |
localUri | string | Synonym for |
uri | string | Blob | null | URI to the snapshot. |
width | number | Width of the snapshot. |
SnapshotOptions
Name | Type | Description |
---|---|---|
compress (optional) | number | A value in range Default: 1.0 |
flip (optional) | boolean | Whether to flip the snapshot vertically. Default: false |
format (optional) | 'jpeg' | 'png' | 'webp' | Specifies what type of compression should be used and what is the result file extension. PNG compression is lossless but slower, JPEG is faster but the image has visible artifacts.
Default: 'jpeg' |
framebuffer (optional) | WebGLFramebuffer | Specify the framebuffer that we will be reading from. Defaults to underlying framebuffer that is presented in the view or the current framebuffer if context is headless. |
rect (optional) | {
height: number,
width: number,
x: number,
y: number
} | Rect to crop the snapshot. It's passed directly to |
SurfaceCreateEvent
Name | Type | Description |
---|---|---|
nativeEvent | {
exglCtxId: number
} | - |
WebGLObject
Name | Type | Description |
---|---|---|
id | number | - |
GLLoggingOption
GLLoggingOption Values
GET_ERRORS
GLLoggingOption.GET_ERRORS = 2
Calls gl.getError()
after each other method call and prints an error if any is returned.
This option has a significant impact on the performance as this method is blocking.
RESOLVE_CONSTANTS
GLLoggingOption.RESOLVE_CONSTANTS = 4
Resolves parameters of type number
to their constant names.
TRUNCATE_STRINGS
GLLoggingOption.TRUNCATE_STRINGS = 8
When this option is enabled, long strings will be truncated. It's useful if your shaders are really big and logging them significantly reduces performance.
ALL
GLLoggingOption.ALL = 15
Enables all other options. It implies GET_ERRORS
so be aware of the slowdown.
Once the component is mounted and the OpenGL ES context has been created, the gl
object received through the onContextCreate
prop becomes the interface to the OpenGL ES context, providing a WebGL API. It resembles a WebGL2RenderingContext in the WebGL 2 spec.
Some older Android devices may not support WebGL2 features. To check whether the device supports WebGL2 it's recommended to use gl instanceof WebGL2RenderingContext
.
An additional method gl.endFrameEXP()
is present, which notifies the context that the current frame is ready to present. This is similar to a 'swap buffers' API call in other OpenGL platforms.
The following WebGL2RenderingContext methods are currently unimplemented:
getFramebufferAttachmentParameter()
getRenderbufferParameter()
compressedTexImage2D()
compressedTexSubImage2D()
getTexParameter()
getUniform()
getVertexAttrib()
getVertexAttribOffset()
getBufferSubData()
getInternalformatParameter()
renderbufferStorageMultisample()
compressedTexImage3D()
compressedTexSubImage3D()
fenceSync()
isSync()
deleteSync()
clientWaitSync()
waitSync()
getSyncParameter()
getActiveUniformBlockParameter()
The pixels
argument of texImage2D()
must be null
, an ArrayBuffer
with pixel data, or an object of the form { localUri }
where localUri
is the file://
URI of an image in the device's file system. Thus, an Asset
object is used once .downloadAsync()
has been called on it (and completed) to fetch the resource.
For efficiency reasons, the current implementations of the methods don't perform type or bounds checking on their arguments. So, passing invalid arguments may cause a native crash. There are plans to update the API to perform argument checking in upcoming SDK versions.
Currently, the priority for error checking is low since engines generally don't rely on the OpenGL API to perform argument checking; otherwise, checks performed by the underlying OpenGL ES implementation are often sufficient.