鸿蒙OpenHarmony Native API【Native XComponent】

Native XComponent

Overview

Description:
Describes the surface and touch event held by the ArkUI XComponent, which can be used for the EGL/OpenGLES and media data input and displayed on the ArkUI XComponent.
Since:
8
Version:
1.0
Summary

Files

File NameDescription[native_interface_xcomponent.h]Declares APIs for accessing a Native XComponent. Classes

Classe NameDescription[OH_NativeXComponent_TouchPoint][OH_NativeXComponent_TouchEvent][OH_NativeXComponent_Callback]Registers the surface lifecycle and touch event callbacks. Macros

Macro Name and ValueDescriptionOH_NATIVE_XCOMPONENT_OBJ (“NATIVE_XCOMPONENT_OBJ”) Typedefs

Typedef NameDescriptionOH_NativeXComponenttypedef struct OH_NativeXComponent Provides an encapsulated OH_NativeXComponent instance.OH_NativeXComponent_Callbacktypedef struct OH_NativeXComponent_Callback Registers the surface lifecycle and touch event callbacks. Enumerations

Enumeration NameDescription{ OH_NATIVEXCOMPONENT_RESULT_SUCCESS = 0, OH_NATIVEXCOMPONENT_RESULT_FAILED = -1, OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETER = -2 }Enumerates the API access states.OH_NativeXComponent_TouchEventType { OH_NATIVEXCOMPONENT_DOWN = 0, OH_NATIVEXCOMPONENT_UP, OH_NATIVEXCOMPONENT_MOVE, OH_NATIVEXCOMPONENT_CANCEL, OH_NATIVEXCOMPONENT_UNKNOWN } Functions

FunctionDescriptionOH_NativeXComponent_GetXComponentId (OH_NativeXComponent *component, char *id, uint64_t *size)int32_t Obtains the ID of the ArkUI XComponent.OH_NativeXComponent_GetXComponentSize (OH_NativeXComponent *component, const void *window, uint64_t *width, uint64_t *height)int32_t Obtains the size of the surface held by the ArkUI XComponent.OH_NativeXComponent_GetXComponentOffset (OH_NativeXComponent *component, const void *window, double *x, double *y)int32_t Obtains the offset of the surface held by the ArkUI XComponent.OH_NativeXComponent_GetTouchEvent (OH_NativeXComponent *component, const void *window, OH_NativeXComponent_TouchEvent *touchEvent)int32_t Obtains the touch event dispatched by the ArkUI XComponent.OH_NativeXComponent_RegisterCallback (OH_NativeXComponent *component, OH_NativeXComponent_Callback *callback)int32_t Registers a callback for this OH_NativeXComponent instance. Details

Typedef

OH_NativeXComponent

1. typedef struct OH_NativeXComponent OH_NativeXComponent

复制代码

Description:
Provides an encapsulated OH_NativeXComponent instance.
OH_NativeXComponent_Callback

1. typedef struct OH_NativeXComponent_Callback OH_NativeXComponent_Callback

复制代码

Description:
Registers the surface lifecycle and touch event callbacks.
Enumeration Type

anonymous enum

1. anonymous enum

复制代码

Description:
Enumerates the API access states.
EnumeratorDescriptionOH_NATIVEXCOMPONENT_RESULT_SUCCESSSuccess result.OH_NATIVEXCOMPONENT_RESULT_FAILEDFailed result.OH_NATIVEXCOMPONENT_RESULT_BAD_PARAMETERInvalid parameters. OH_NativeXComponent_TouchEventType

1. enum OH_NativeXComponent_TouchEventType

复制代码

EnumeratorDescriptionOH_NATIVEXCOMPONENT_DOWNTrigger a touch event when a finger is pressed.OH_NATIVEXCOMPONENT_UPTrigger a touch event when a finger is lifted.OH_NATIVEXCOMPONENT_MOVETrigger a touch event when a finger moves on the screen in pressed state.OH_NATIVEXCOMPONENT_CANCELTrigger an event when a touch event is canceled.OH_NATIVEXCOMPONENT_UNKNOWNInvalid touch type. Function

OH_NativeXComponent_GetTouchEvent()

1. int32_t OH_NativeXComponent_GetTouchEvent (OH_NativeXComponent * component, const void * window, OH_NativeXComponent_TouchEvent * touchEvent )

复制代码

Description:
Obtains the touch event dispatched by the ArkUI XComponent.
Parameters:
NameDescriptioncomponentIndicates the pointer to this OH_NativeXComponent instance.windowIndicates the native window handler.touchEventIndicates the pointer to the current touch event. Returns:
Returns the status code of the execution.
OH_NativeXComponent_GetXComponentId()

1. int32_t OH_NativeXComponent_GetXComponentId (OH_NativeXComponent * component, char * id, uint64_t * size )

复制代码

Description:
Obtains the ID of the ArkUI XComponent.
Parameters:
NameDescriptioncomponentIndicates the pointer to this OH_NativeXComponent instance.idIndicates the char buffer to keep the ID of this OH_NativeXComponent instance. Note that a null-terminator will be appended to the char buffer, so the size of the char buffer should be at least as large as the size of the real id length plus 1. It is recommended that the size of the char buffer be [OH_XCOMPONENT_ID_LEN_MAX + 1].sizeIndicates the pointer to the length of id, which you can set and receive. Returns:
Returns the status code of the execution.
OH_NativeXComponent_GetXComponentOffset()

1. int32_t OH_NativeXComponent_GetXComponentOffset (OH_NativeXComponent * component, const void * window, double * x, double * y )

复制代码

Description:
Obtains the offset of the surface held by the ArkUI XComponent.
Parameters:
NameDescriptioncomponentIndicates the pointer to this OH_NativeXComponent instance.windowIndicates the native window handler.xIndicates the pointer to the x coordinate of the current surface.yIndicates the pointer to the y coordinate of the current surface. Returns:
Returns the status code of the execution.
OH_NativeXComponent_GetXComponentSize()

1. int32_t OH_NativeXComponent_GetXComponentSize (OH_NativeXComponent * component, const void * window, uint64_t * width, uint64_t * height )

复制代码

Description:
Obtains the size of the surface held by the ArkUI XComponent.
Parameters:
NameDescriptioncomponentIndicates the pointer to this OH_NativeXComponent instance.windowIndicates the native window handler.widthIndicates the pointer to the width of the current surface.heightIndicates the pointer to the height of the current surface. Returns:
Returns the status code of the execution.
OH_NativeXComponent_RegisterCallback()

1. int32_t OH_NativeXComponent_RegisterCallback (OH_NativeXComponent * component, OH_NativeXComponent_Callback * callback )

复制代码

Description:
Registers a callback for this OH_NativeXComponent instance.
Parameters:
NameDescriptioncomponentIndicates the pointer to this OH_NativeXComponent instance.callbackIndicates the pointer to a surface lifecycle and touch event callback. Returns:
Returns the status code of the execution.
Variable

deviceId

1. int64_t OH_NativeXComponent_TouchEvent::deviceId = 0

复制代码

Description:
ID of the device where the current touch event is generated.
DispatchTouchEvent

1. void(* OH_NativeXComponent_Callback::DispatchTouchEvent) (OH_NativeXComponent *component, void *window)

复制代码

Description:
Called when a touch event is triggered.
force [1/2]

1. float OH_NativeXComponent_TouchPoint::force = 0.0

复制代码

Description:
Pressure of the current touch event.
force [2/2]

1. float OH_NativeXComponent_TouchEvent::force = 0.0

复制代码

Description:
Pressure of the current touch event.
id [1/2]

1. int32_t OH_NativeXComponent_TouchPoint::id = 0

复制代码

Description:
Unique identifier of a finger.
id [2/2]

1. int32_t OH_NativeXComponent_TouchEvent::id = 0

复制代码

Description:
Unique identifier of a finger.
isPressed

1. bool OH_NativeXComponent_TouchPoint::isPressed = false

复制代码

Description:
Whether the current point is pressed.
numPoints

1. uint32_t OH_NativeXComponent_TouchEvent::numPoints = 0

复制代码

Description:
Number of current touch points.
OnSurfaceChanged

1. void(* OH_NativeXComponent_Callback::OnSurfaceChanged) (OH_NativeXComponent *component, void *window)

复制代码

Description:
Called when the surface is changed. This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.
OnSurfaceCreated

1. void(* OH_NativeXComponent_Callback::OnSurfaceCreated) (OH_NativeXComponent *component, void *window)

复制代码

Description:
Called when the surface is created.
OnSurfaceDestroyed

1. void(* OH_NativeXComponent_Callback::OnSurfaceDestroyed) (OH_NativeXComponent *component, void *window)

复制代码

Description:
Called when the surface is destroyed.
screenX [1/2]

1. float OH_NativeXComponent_TouchPoint::screenX = 0.0

复制代码

Description:
X coordinate of the touch point relative to the left edge of the screen.
screenX [2/2]

1. float OH_NativeXComponent_TouchEvent::screenX = 0.0

复制代码

Description:
X coordinate of the touch point relative to the left edge of the screen.
screenY [1/2]

1. float OH_NativeXComponent_TouchPoint::screenY = 0.0

复制代码

Description:
Y coordinate of the touch point relative to the upper edge of the screen.
screenY [2/2]

1. float OH_NativeXComponent_TouchEvent::screenY = 0.0

复制代码

Description:
Y coordinate of the touch point relative to the upper edge of the screen.
size [1/2]

1. double OH_NativeXComponent_TouchPoint::size = 0.0

复制代码

Description:
Contact area between the finger pad and the screen.
size [2/2]

1. double OH_NativeXComponent_TouchEvent::size = 0.0

复制代码

Description:
Contact area between the finger pad and the screen.
timeStamp [1/2]

1. long long OH_NativeXComponent_TouchPoint::timeStamp = 0

复制代码

Description:
Timestamp of the current touch event.
timeStamp [2/2]

1. long long OH_NativeXComponent_TouchEvent::timeStamp = 0

复制代码

Description:
Timestamp of the current touch event.
touchPoints

1. OH_NativeXComponent_TouchPoint OH_NativeXComponent_TouchEvent::touchPoints[OH_MAX_TOUCH_POINTS_NUMBER]

复制代码

Description:
Array of the current touch points.
type [1/2]

1. OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchPoint::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN

复制代码

Description:
Touch type of the touch event.
type [2/2]

1. OH_NativeXComponent_TouchEventType OH_NativeXComponent_TouchEvent::type = OH_NativeXComponent_TouchEventType::OH_NATIVEXCOMPONENT_UNKNOWN

复制代码

Description:
Touch type of the touch event.
x [1/2]

1. float OH_NativeXComponent_TouchPoint::x = 0.0

复制代码

Description:
X coordinate of the touch point relative to the left edge of the element to touch.
x [2/2]

1. float OH_NativeXComponent_TouchEvent::x = 0.0

复制代码

Description:
X coordinate of the touch point relative to the left edge of the element to touch.
y [1/2]

1. float OH_NativeXComponent_TouchPoint::y = 0.0

复制代码

Description:
Y coordinate of the touch point relative to the upper edge of the element to touch.
y [2/2]

1. float OH_NativeXComponent_TouchEvent::y = 0.0

复制代码

鸿蒙更多技能，末了扫

Description:
Y coordinate of the touch point relative to the upper edge of the element to touch.

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。