OH_NativeImage
Overview
Provides the capabilities of NativeImage. Functioning as a data consumer, it is used to associate data with the OpenGL texture. It is used in the OpenGL environment.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Summary
Files
| Name | Description |
|---|---|
| native_image.h | Defines the functions for obtaining and using NativeImage. |
Structs
| Name | Description |
|---|---|
| OH_OnFrameAvailableListener | Defines an OH_NativeImage listener, which is registered through OH_NativeImage_SetOnFrameAvailableListener. The listener triggers a callback when a frame is available. |
Types
| Name | Description |
|---|---|
| OH_NativeImage | Provides the declaration of an OH_NativeImage struct. |
| OHNativeWindow | typedef struct NativeWindow Provides the declaration of a NativeWindow struct. |
| OH_OnFrameAvailable | Defines the callback function triggered when a frame is available. |
| OH_OnFrameAvailableListener | Defines an OH_NativeImage listener, which is registered through OH_NativeImage_SetOnFrameAvailableListener. The listener triggers a callback when a frame is available. |
Functions
| Name | Description |
|---|---|
| OH_NativeImage_Create (uint32_t textureId, uint32_t textureTarget) | Creates an OH_NativeImage instance to be associated with the OpenGL ES texture ID and target. |
| OH_NativeImage_AcquireNativeWindow (OH_NativeImage *image) | Obtains an OHNativeWindow instance associated with an OH_NativeImage instance. You need to call OH_NativeWindow_DestroyNativeWindow to release the OHNativeWindow instance when it is no longer required. * |
| OH_NativeImage_AttachContext (OH_NativeImage *image, uint32_t textureId) | Attaches an OH_NativeImage instance to the current OpenGL ES context. The OpenGL ES texture will be bound to an GL_TEXTURE_EXTERNAL_OES instance and updated through the OH_NativeImage instance. |
| OH_NativeImage_DetachContext (OH_NativeImage *image) | Detaches an OH_NativeImage instance from the current OpenGL ES context. |
| OH_NativeImage_UpdateSurfaceImage (OH_NativeImage *image) | Updates the OpenGL ES texture associated with the latest frame through an OH_NativeImage instance. |
| OH_NativeImage_GetTimestamp (OH_NativeImage *image) | Obtains the timestamp of the texture image that recently called the OH_NativeImage_UpdateSurfaceImage function. |
| OH_NativeImage_GetTransformMatrix (OH_NativeImage *image, float matrix[16]) | Obtains the transformation matrix of the texture image that recently called the OH_NativeImage_UpdateSurfaceImage function. |
| OH_NativeImage_GetSurfaceId (OH_NativeImage *image, uint64_t *surfaceId) | Obtains the surface ID of an OH_NativeImage instance. |
| OH_NativeImage_SetOnFrameAvailableListener (OH_NativeImage *image, OH_OnFrameAvailableListener listener) | Registers a listener to listen for frame availability events. |
| OH_NativeImage_UnsetOnFrameAvailableListener (OH_NativeImage *image) | Deregisters the listener used to listen for frame availability events. |
| OH_NativeImage_Destroy (OH_NativeImage **image) | Destroys an OH_NativeImage instance created by calling OH_NativeImage_Create. After the instance is destroyed, the pointer to the OH_NativeImage instance is assigned NULL. |
Type Description
OH_NativeImage
typedef struct OH_NativeImageOH_NativeImage
Description
Provides the declaration of an OH_NativeImage struct.
Since: 9
OH_OnFrameAvailable
typedef void(* OH_OnFrameAvailable) (void *context)
Description
Defines the callback function triggered when a frame is available.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 11
Parameters
| Name | Description |
|---|---|
| context | User-defined context information, which is returned when the callback is triggered. |
OH_OnFrameAvailableListener
typedef struct OH_OnFrameAvailableListener OH_OnFrameAvailableListener
Description
Defines an OH_NativeImage listener, which is registered through OH_NativeImage_SetOnFrameAvailableListener. The listener triggers a callback when a frame is available.
Since: 11
OHNativeWindow
typedef struct NativeWindow OHNativeWindow
Description
Provides the capability of accessing the NativeWindow.
Since: 9
Function Description
OH_NativeImage_AcquireNativeWindow()
OHNativeWindow* OH_NativeImage_AcquireNativeWindow (OH_NativeImage * image)
Description
Obtains an OHNativeWindow instance associated with an OH_NativeImage instance. You need to call OH_NativeWindow_DestroyNativeWindow to release the OHNativeWindow instance when it is no longer required.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
Returns
Returns a pointer to the OHNativeWindow instance if the operation is successful; returns NULL otherwise.
OH_NativeImage_AttachContext()
int32_t OH_NativeImage_AttachContext (OH_NativeImage * image, uint32_t textureId )
Description
Attaches an OH_NativeImage instance to the current OpenGL ES context.
The OpenGL ES texture will be bound to an GL_TEXTURE_EXTERNAL_OES instance and updated through the OH_NativeImage instance.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
| textureId | ID of the OpenGL ES texture to which the OH_NativeImage instance is to be attached. |
Returns
Returns 0 if the operation is successful.
OH_NativeImage_Create()
OH_NativeImage* OH_NativeImage_Create (uint32_t textureId, uint32_t textureTarget )
Description
Creates an OH_NativeImage instance to be associated with the OpenGL ES texture ID and target.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| textureId | OpenGL ES texture ID. |
| textureTarget | OpenGL ES texture target. |
Returns
Returns a pointer to the OH_NativeImage instance if the operation is successful; returns NULL otherwise.
OH_NativeImage_Destroy()
void OH_NativeImage_Destroy (OH_NativeImage ** image)
Description
Destroys an OH_NativeImage instance created by calling OH_NativeImage_Create. After the instance is destroyed,
the pointer to the OH_NativeImage instance is assigned NULL.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
OH_NativeImage_DetachContext()
int32_t OH_NativeImage_DetachContext (OH_NativeImage * image)
Description
Detaches an OH_NativeImage instance from the current OpenGL ES context.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
Returns
Returns 0 if the operation is successful.
OH_NativeImage_GetSurfaceId()
int32_t OH_NativeImage_GetSurfaceId (OH_NativeImage * image, uint64_t * surfaceId )
Description
Obtains the surface ID of an OH_NativeImage instance.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 11
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
| surfaceId | Pointer to the surface ID. |
Returns
Returns 0 if the operation is successful.
OH_NativeImage_GetTimestamp()
int64_t OH_NativeImage_GetTimestamp (OH_NativeImage * image)
Description
Obtains the timestamp of the texture image that recently called the OH_NativeImage_UpdateSurfaceImage function.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
Returns
Returns the timestamp of the texture image.
OH_NativeImage_GetTransformMatrix()
int32_t OH_NativeImage_GetTransformMatrix (OH_NativeImage * image, float matrix[16] )
Description
Obtains the transformation matrix of the texture image that recently called the OH_NativeImage_UpdateSurfaceImage function.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
| matrix | Buffer used to store the 4 * 4 transform matrix obtained. |
Returns
Returns 0 if the operation is successful.
OH_NativeImage_SetOnFrameAvailableListener()
int32_t OH_NativeImage_SetOnFrameAvailableListener (OH_NativeImage * image, OH_OnFrameAvailableListener listener )
Description
Registers a listener to listen for frame availability events.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 11
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
| listener | Listener to register. |
Returns
Returns 0 if the operation is successful.
OH_NativeImage_UnsetOnFrameAvailableListener()
int32_t OH_NativeImage_UnsetOnFrameAvailableListener (OH_NativeImage * image)
Description
Deregisters the listener used to listen for frame availability events.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 11
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
Returns
Returns 0 if the operation is successful.
OH_NativeImage_UpdateSurfaceImage()
int32_t OH_NativeImage_UpdateSurfaceImage (OH_NativeImage * image)
Description
Updates the OpenGL ES texture associated with the latest frame through an OH_NativeImage instance.
System capability: SystemCapability.Graphic.Graphic2D.NativeImage
Since: 9
Parameters
| Name | Description |
|---|---|
| image | Pointer to an OH_NativeImage instance. |
Returns
Returns 0 if the operation is successful.