arkui_sys/native_animate/native_animate_ffi.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739
// automatically generated by rust-bindgen 0.71.1
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::native_type::*;
/// Defines the expected frame rate range of the animation.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct ArkUI_ExpectedFrameRateRange {
/// Expected minimum frame rate.
pub min: u32,
/// Expected maximum frame rate.
pub max: u32,
/// Expected optimal frame rate.
pub expected: u32,
}
/// Defines the callback type for when the animation playback is complete.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct ArkUI_AnimateCompleteCallback {
/// Type of the <b>onFinish</b> callback.
pub type_: ArkUI_FinishCallbackType,
/// Callback invoked when the animation playback is complete.
pub callback: ::core::option::Option<unsafe extern "C" fn(userData: *mut ::core::ffi::c_void)>,
/// Custom type.
pub userData: *mut ::core::ffi::c_void,
}
#[repr(C)]
pub struct ArkUI_AnimateOption {
_unused: [u8; 0],
}
#[repr(C)]
pub struct ArkUI_Curve {
_unused: [u8; 0],
}
/// Defines the pointer to an interpolation curve.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub type ArkUI_CurveHandle = *mut ArkUI_Curve;
#[repr(C)]
pub struct ArkUI_KeyframeAnimateOption {
_unused: [u8; 0],
}
#[repr(C)]
pub struct ArkUI_AnimatorOption {
_unused: [u8; 0],
}
#[repr(C)]
pub struct ArkUI_Animator {
_unused: [u8; 0],
}
/// Defines the pointer to an animator object.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub type ArkUI_AnimatorHandle = *mut ArkUI_Animator;
#[repr(C)]
pub struct ArkUI_AnimatorEvent {
_unused: [u8; 0],
}
#[repr(C)]
pub struct ArkUI_AnimatorOnFrameEvent {
_unused: [u8; 0],
}
#[repr(C)]
pub struct ArkUI_TransitionEffect {
_unused: [u8; 0],
}
/// Implements the native animation APIs provided by ArkUI.
///
///
/// Version: 1
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct ArkUI_NativeAnimateAPI_1 {
/// Defines an explicit animation.
///
///
/// **Note:** Make sure the component attributes to be set in the event closure have been set before.
///
/// # Arguments
///
/// * `context` - Indicates a <b>UIContext</b> instance.
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `update` - Indicates the animation closure. The system automatically inserts a transition animation for the
/// state change caused by the closure.
///
/// * `complete` - Indicates the callback to be invoked when the animation playback is complete.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
pub animateTo: ::core::option::Option<
unsafe extern "C" fn(
context: ArkUI_ContextHandle,
option: *mut ArkUI_AnimateOption,
update: *mut ArkUI_ContextCallback,
complete: *mut ArkUI_AnimateCompleteCallback,
) -> i32,
>,
/// Sets the keyframe animation.
///
///
/// # Arguments
///
/// * `context` - Indicates a <b>UIContext</b> instance.
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
pub keyframeAnimateTo: ::core::option::Option<
unsafe extern "C" fn(
context: ArkUI_ContextHandle,
option: *mut ArkUI_KeyframeAnimateOption,
) -> i32,
>,
/// Creates an animator object.
///
/// # Arguments
///
/// * `context` - Indicates a <b>UIContext</b> instance.
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the pointer to the animator object; returns <b>NULL</b> if a function parameter error occurs.
pub createAnimator: ::core::option::Option<
unsafe extern "C" fn(
context: ArkUI_ContextHandle,
option: *mut ArkUI_AnimatorOption,
) -> ArkUI_AnimatorHandle,
>,
/// Disposes of an animator object.
///
/// # Arguments
///
/// * `animator` - Indicates the target animator object.
pub disposeAnimator:
::core::option::Option<unsafe extern "C" fn(animatorHandle: ArkUI_AnimatorHandle)>,
}
extern "C" {
/// Creates an animation configuration.
///
///
/// # Returns
///
/// * Returns the pointer to the created animation configuration.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_Create() -> *mut ArkUI_AnimateOption;
/// Disposes of an animation configuration.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_Dispose(option: *mut ArkUI_AnimateOption);
/// Obtains the animation duration, in milliseconds.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the duration.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetDuration(option: *mut ArkUI_AnimateOption) -> u32;
/// Obtains the animation playback speed.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the animation playback speed.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetTempo(option: *mut ArkUI_AnimateOption) -> f32;
/// Obtains the animation curve.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the animated curve.If Null is returned, it means option is an invalid value.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetCurve(
option: *mut ArkUI_AnimateOption,
) -> ArkUI_AnimationCurve;
/// Obtains the animation delay, in milliseconds.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the animation delay.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetDelay(option: *mut ArkUI_AnimateOption) -> i32;
/// Obtains the number of times that an animation is played.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the number of times that the animation is played.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetIterations(option: *mut ArkUI_AnimateOption) -> i32;
/// Obtains the animation playback mode.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the animation playback mode.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetPlayMode(
option: *mut ArkUI_AnimateOption,
) -> ArkUI_AnimationPlayMode;
/// Obtains the expected frame rate range of an animation.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// # Returns
///
/// * Returns the expected frame rate range.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetExpectedFrameRateRange(
option: *mut ArkUI_AnimateOption,
) -> *mut ArkUI_ExpectedFrameRateRange;
/// Sets the animation duration.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the duration, in milliseconds.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetDuration(option: *mut ArkUI_AnimateOption, value: i32);
/// Sets the animation playback speed.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the animation playback speed.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetTempo(option: *mut ArkUI_AnimateOption, value: f32);
/// Sets the animation curve.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the animated curve. Default value:ARKUI_CURVE_LINEAR.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetCurve(
option: *mut ArkUI_AnimateOption,
value: ArkUI_AnimationCurve,
);
/// Sets the animation delay.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the animation delay.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetDelay(option: *mut ArkUI_AnimateOption, value: i32);
/// Sets the number of times that an animation is played.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the number of times that the animation is played.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetIterations(option: *mut ArkUI_AnimateOption, value: i32);
/// Sets the animation playback mode.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the animation playback mode.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetPlayMode(
option: *mut ArkUI_AnimateOption,
value: ArkUI_AnimationPlayMode,
);
/// Sets the expected frame rate range of an animation.
///
/// # Arguments
///
/// * `option` - Indicates the pointer to an animation configuration.
///
/// * `value` - Indicates the expected frame rate range.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetExpectedFrameRateRange(
option: *mut ArkUI_AnimateOption,
value: *mut ArkUI_ExpectedFrameRateRange,
);
/// Sets the animation curve for the animation of an animator.
///
///
/// **Note:** This method is better than the value set by OH_ArkUI_AnimateOption_SetCurve.
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// * `value` - Indicates the animation curve settings.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_SetICurve(
option: *mut ArkUI_AnimateOption,
value: ArkUI_CurveHandle,
);
/// Obtains the animation curve of the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the animation curve of the specified animation.
/// If Null is returned, it means option is an invalid value.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimateOption_GetICurve(option: *mut ArkUI_AnimateOption) -> ArkUI_CurveHandle;
/// Obtains the keyframe animation parameters.
///
/// # Arguments
///
/// * `size` - Indicates the number of keyframe animation states.
///
/// # Returns
///
/// * Returns the keyframe animation parameter object; returns <b>NULL</b> if the value of <b>size</b> is less than
/// 0.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_Create(size: i32) -> *mut ArkUI_KeyframeAnimateOption;
/// Disposes of the keyframe animation parameter object.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameter object.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_Dispose(option: *mut ArkUI_KeyframeAnimateOption);
/// Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played
/// without delay.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `value` - Indicates the delay, in milliseconds.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_SetDelay(
option: *mut ArkUI_KeyframeAnimateOption,
value: i32,
) -> i32;
/// Sets the number of times that the keyframe animation is played. By default, the animation is played once.
/// The value <b>-1</b> indicates that the animation is played for an unlimited number of times. The value <b>0</b>
/// indicates that there is no animation.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `value` - Indicates the number of times that the animation is played.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_SetIterations(
option: *mut ArkUI_KeyframeAnimateOption,
value: i32,
) -> i32;
/// Sets the callback invoked when the keyframe animation playback is complete. This API is called after the
/// keyframe animation has played for the specified number of times.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `userData` - Indicates the pointer to a custom object.
///
/// * `onFinish` - Indicates the callback.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback(
option: *mut ArkUI_KeyframeAnimateOption,
userData: *mut ::core::ffi::c_void,
onFinish: ::core::option::Option<unsafe extern "C" fn(userData: *mut ::core::ffi::c_void)>,
) -> i32;
/// Sets the duration of a keyframe animation, in milliseconds.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `value` - Indicates the duration to set, in milliseconds.
///
/// * `index` - Indicates a state index.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_SetDuration(
option: *mut ArkUI_KeyframeAnimateOption,
value: i32,
index: i32,
) -> i32;
/// Sets the animation curve for a specific keyframe in a keyframe animation.
///
///
/// **Note:** Because the <b>springMotion</b>, <b>responsiveSpringMotion</b>, and <b>interpolatingSpring</b> curves do not
/// have effective duration settings, they are not supported.
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `value` - Indicates the animation curve to set. Default value:EASE_IN_OUT.
///
/// * `index` - Indicates a state index.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_SetCurve(
option: *mut ArkUI_KeyframeAnimateOption,
value: ArkUI_CurveHandle,
index: i32,
) -> i32;
/// Sets the closure function of the state at the time of the keyframe, that is, the state to be reached at the
/// time of the keyframe.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `event` - Indicates a closure function.
///
/// * `userData` - Indicates the pointer to a custom object.
///
/// * `index` - Indicates a state index.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback(
option: *mut ArkUI_KeyframeAnimateOption,
userData: *mut ::core::ffi::c_void,
event: ::core::option::Option<unsafe extern "C" fn(userData: *mut ::core::ffi::c_void)>,
index: i32,
) -> i32;
/// Obtains the overall delay of a keyframe animation
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// # Returns
///
/// * Returns the overall delay.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_GetDelay(option: *mut ArkUI_KeyframeAnimateOption)
-> i32;
/// Obtains the number of times that a keyframe animation is played.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// # Returns
///
/// * Returns the number of times that the animation is played.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_GetIterations(
option: *mut ArkUI_KeyframeAnimateOption,
) -> i32;
/// Obtains the duration of a specific state in a keyframe animation.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `index` - Indicates a state index.
///
/// # Returns
///
/// * Returns the duration. The unit is millisecond.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_GetDuration(
option: *mut ArkUI_KeyframeAnimateOption,
index: i32,
) -> i32;
/// Obtains the animation curve of a specific state in a keyframe animation.
///
/// # Arguments
///
/// * `option` - Indicates the keyframe animation parameters.
///
/// * `index` - Indicates a state index.
///
/// # Returns
///
/// * Returns the animated curve.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_KeyframeAnimateOption_GetCurve(
option: *mut ArkUI_KeyframeAnimateOption,
index: i32,
) -> ArkUI_CurveHandle;
/// Creates an animator parameter object.
///
///
/// **Note:** When <b>keyframeSize</b> is greater than 0, the animation interpolation start point is 0, and the animation
/// interpolation end point is 1; no setting is allowed.
/// # Arguments
///
/// * `keyframeSize` - Indicates the number of keyframes.
///
/// # Returns
///
/// * Returns the pointer to the animator parameter object.
/// returns <b>NULL</b> if the value of <b>size</b> is less than 0.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_Create(keyframeSize: i32) -> *mut ArkUI_AnimatorOption;
/// Disposes of an animator parameter object.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_Dispose(option: *mut ArkUI_AnimatorOption);
/// Sets the duration for thea nimation of an animator, in milliseconds.
///
/// # Arguments
///
/// * `option` - Indicates the target animator parameter object.
///
/// * `value` - Indicates the playback duration, in milliseconds.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetDuration(
option: *mut ArkUI_AnimatorOption,
value: i32,
) -> i32;
/// Sets the delay for playing the animation of an animator, in milliseconds.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the delay to set, in milliseconds.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetDelay(option: *mut ArkUI_AnimatorOption, value: i32) -> i32;
/// Sets the number of times that the animation of an animator is played. The value <b>0</b> means not to play the
/// animation, and <b>-1</b> means to play the animation for an unlimited number of times.
///
///
/// **Note:** If this parameter is set to a negative value other than <b>-1</b>, the value is invalid. In this case, the
/// animation is played once.
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the number of times that the animation is played.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetIterations(
option: *mut ArkUI_AnimatorOption,
value: i32,
) -> i32;
/// Sets whether the animation of an animator is restored to the initial state after being executed.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates whether to restore the animation to the initial state after the animation is executed.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetFill(
option: *mut ArkUI_AnimatorOption,
value: ArkUI_AnimationFillMode,
) -> i32;
/// Sets the playback direction for the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the animation playback direction.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetDirection(
option: *mut ArkUI_AnimatorOption,
value: ArkUI_AnimationDirection,
) -> i32;
/// Sets the interpolation curve for the animation of an animator.
///
///
/// **Note:** <b>springCurve</b>, <b>springMotion</b>, <b>responsiveSpringMotion</b>, <b>interpolatingSpring</b>,
/// and <b>customCurve</b> curves are not supported.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the target interpolation curve. Default value:ARKUI_CURVE_LINEAR.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetCurve(
option: *mut ArkUI_AnimatorOption,
value: ArkUI_CurveHandle,
) -> i32;
/// Sets the interpolation start point for the animation of an animator.
///
/// **Note:** This API does not take effect when the animation is a keyframe animation.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the interpolation start point to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetBegin(option: *mut ArkUI_AnimatorOption, value: f32) -> i32;
/// Sets the interpolation end point for the animation of an animator.
///
/// **Note:** This API does not take effect when the animation is a keyframe animation.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the interpolation end point to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetEnd(option: *mut ArkUI_AnimatorOption, value: f32) -> i32;
/// Sets the expected frame rate range for the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the expected frame rate range to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange(
option: *mut ArkUI_AnimatorOption,
value: *mut ArkUI_ExpectedFrameRateRange,
) -> i32;
/// Sets the keyframe parameters for the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `time` - Indicates the keyframe time. Value range: [0,1].
///
/// * `value` - Indicates the keyframe value.
///
/// * `index` - Indicates the keyframe index.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetKeyframe(
option: *mut ArkUI_AnimatorOption,
time: f32,
value: f32,
index: i32,
) -> i32;
/// Sets the keyframe curve type for the animation of an animator.
///
///
/// **Note:** <b>springCurve</b>, <b>springMotion</b>, <b>responsiveSpringMotion</b>, <b>interpolatingSpring</b>,
/// and <b>customCurve</b> curves are not supported.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `value` - Indicates the target interpolation curve.
///
/// * `index` - Indicates the keyframe index.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_SetKeyframeCurve(
option: *mut ArkUI_AnimatorOption,
value: ArkUI_CurveHandle,
index: i32,
) -> i32;
/// Obtains the duration for playing an animation.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the duration for playing the animation, in milliseconds.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetDuration(option: *mut ArkUI_AnimatorOption) -> i32;
/// Obtains the delay for playing the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the delay for playing the animation, in milliseconds.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetDelay(option: *mut ArkUI_AnimatorOption) -> i32;
/// Obtains the number of times that an animation is played.
///
/// # Arguments
///
/// * `option` - Animator animation parameter.
///
/// # Returns
///
/// * Returns the number of times that the animation is played.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetIterations(option: *mut ArkUI_AnimatorOption) -> i32;
/// Obtains whether the animator animation is restored to the initial state after being executed.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns whether the animator animation is restored to the initial state after being executed.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetFill(
option: *mut ArkUI_AnimatorOption,
) -> ArkUI_AnimationFillMode;
/// Obtains the playback direction of an animation.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the animation playback direction.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetDirection(
option: *mut ArkUI_AnimatorOption,
) -> ArkUI_AnimationDirection;
/// Obtains the interpolation curve of the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the interpolation curve of the animation.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetCurve(option: *mut ArkUI_AnimatorOption)
-> ArkUI_CurveHandle;
/// Obtains the interpolation start point of an animation.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the interpolation start point of the animation.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetBegin(option: *mut ArkUI_AnimatorOption) -> f32;
/// Obtains the interpolation end point of an animation.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the interpolation end point of the animation.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetEnd(option: *mut ArkUI_AnimatorOption) -> f32;
/// Obtains the expected frame rate range of an animation.
///
/// # Arguments
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the pointer to the expected frame rate range object.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange(
option: *mut ArkUI_AnimatorOption,
) -> *mut ArkUI_ExpectedFrameRateRange;
/// Obtains the keyframe time of an animation.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `index` - Indicates the keyframe index.
///
/// # Returns
///
/// * Returns the keyframe time.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetKeyframeTime(
option: *mut ArkUI_AnimatorOption,
index: i32,
) -> f32;
/// Obtains the keyframe value of an animation.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `index` - Indicates the keyframe index.
///
/// # Returns
///
/// * Returns the keyframe value.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetKeyframeValue(
option: *mut ArkUI_AnimatorOption,
index: i32,
) -> f32;
/// Obtains the interpolation curve for a keyframe in the animation of an animator.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `index` - Indicates the keyframe index.
///
/// # Returns
///
/// * Returns the interpolation curve.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_GetKeyframeCurve(
option: *mut ArkUI_AnimatorOption,
index: i32,
) -> ArkUI_CurveHandle;
/// Obtains the custom object in an animation event object.
///
/// # Arguments
///
/// * `event` - Indicates an animation event object.
///
/// # Returns
///
/// * Returns the custom object.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorEvent_GetUserData(
event: *mut ArkUI_AnimatorEvent,
) -> *mut ::core::ffi::c_void;
/// Obtains the custom object in an animation event object.
///
/// # Arguments
///
/// * `event` - Indicates an animation event object.
///
/// # Returns
///
/// * Returns the custom object.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOnFrameEvent_GetUserData(
event: *mut ArkUI_AnimatorOnFrameEvent,
) -> *mut ::core::ffi::c_void;
/// Obtains the current progress in an animation event object.
///
/// # Arguments
///
/// * `event` - Indicates an animation event object.
///
/// # Returns
///
/// * Returns the animation progress.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOnFrameEvent_GetValue(event: *mut ArkUI_AnimatorOnFrameEvent) -> f32;
/// Sets the callback invoked when the animator receives a frame.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `userData` - Indicates the custom parameter.
///
/// * `callback` - Indicates the callback to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_RegisterOnFrameCallback(
option: *mut ArkUI_AnimatorOption,
userData: *mut ::core::ffi::c_void,
callback: ::core::option::Option<
unsafe extern "C" fn(event: *mut ArkUI_AnimatorOnFrameEvent),
>,
) -> i32;
/// Sets the callback invoked when the animation playback is complete.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `userData` - Indicates the custom parameter.
///
/// * `callback` - Indicates the callback to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_RegisterOnFinishCallback(
option: *mut ArkUI_AnimatorOption,
userData: *mut ::core::ffi::c_void,
callback: ::core::option::Option<unsafe extern "C" fn(event: *mut ArkUI_AnimatorEvent)>,
) -> i32;
/// Sets the callback invoked when the animation playback is canceled.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `userData` - Indicates the custom parameter.
///
/// * `callback` - Indicates the callback to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_RegisterOnCancelCallback(
option: *mut ArkUI_AnimatorOption,
userData: *mut ::core::ffi::c_void,
callback: ::core::option::Option<unsafe extern "C" fn(event: *mut ArkUI_AnimatorEvent)>,
) -> i32;
/// Sets the callback invoked when the animation playback is repeated.
///
/// # Arguments
///
/// * `option` - Indicates an animator parameter object.
///
/// * `userData` - Indicates the custom parameter.
///
/// * `callback` - Indicates the callback to set.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback(
option: *mut ArkUI_AnimatorOption,
userData: *mut ::core::ffi::c_void,
callback: ::core::option::Option<unsafe extern "C" fn(event: *mut ArkUI_AnimatorEvent)>,
) -> i32;
/// Resets the animation of an animator.
///
/// # Arguments
///
/// * `animatorHandle` - Indicates an animator object.
///
/// * `option` - Indicates the animator parameters.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_Animator_ResetAnimatorOption(
animatorHandle: ArkUI_AnimatorHandle,
option: *mut ArkUI_AnimatorOption,
) -> i32;
/// Starts the animation of an animator.
///
/// # Arguments
///
/// * `animatorHandle` - Indicates an animator object.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_Animator_Play(animatorHandle: ArkUI_AnimatorHandle) -> i32;
/// Ends the animation of an animator.
///
/// # Arguments
///
/// * `animatorHandle` - Indicates an animator object.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_Animator_Finish(animatorHandle: ArkUI_AnimatorHandle) -> i32;
/// Pauses the animation of an animator.
///
/// # Arguments
///
/// * `animatorHandle` - Indicates an animator object.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_Animator_Pause(animatorHandle: ArkUI_AnimatorHandle) -> i32;
/// Cancels the animation of an animator.
///
/// # Arguments
///
/// * `animatorHandle` - Indicates an animator object.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_Animator_Cancel(animatorHandle: ArkUI_AnimatorHandle) -> i32;
/// Plays the animation of an animator in reverse order.
///
/// # Arguments
///
/// * `animatorHandle` - Indicates an animator object.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_Animator_Reverse(animatorHandle: ArkUI_AnimatorHandle) -> i32;
/// Implements initialization for the interpolation curve, which is used to create an interpolation curve based on
/// the input parameter.
///
/// # Arguments
///
/// * `curve` - Indicates the curve type.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateCurveByType(curve: ArkUI_AnimationCurve) -> ArkUI_CurveHandle;
/// Creates a step curve.
///
/// # Arguments
///
/// * `count` - Indicates the number of steps. The value must be a positive integer. Value range: [1, +∞).
///
/// * `end` - Indicates whether jumping occurs when the interpolation ends.
/// <b>true</b>: Jumping occurs when the interpolation ends. <b>false</b>: Jumping occurs when the interpolation starts.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateStepsCurve(count: i32, end: bool) -> ArkUI_CurveHandle;
/// Creates a cubic Bezier curve.
///
///
/// # Arguments
///
/// * `x1` - Indicates the X coordinate of the first point on the Bezier curve. Value range: [0, 1].
/// A value less than 0 is handed as <b>0</b>. A value greater than 1 is handed as <b>1</b>.
///
/// * `y1` - Indicates the Y coordinate of the first point on the Bezier curve.
///
/// * `x2` - Indicates the X coordinate of the second point on the Bezier curve. Value range: [0, 1].
/// A value less than 0 is handed as <b>0</b>. A value greater than 1 is handed as <b>1</b>.
///
/// * `y2` - Indicates the Y coordinate of the second point on the Bezier curve.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateCubicBezierCurve(
x1: f32,
y1: f32,
x2: f32,
y2: f32,
) -> ArkUI_CurveHandle;
/// Creates a spring curve. The curve shape is subject to the spring parameters, and the animation duration is
/// subject to the <b>duration</b> parameter in <b>animation</b> and <b>animateTo</b>.
///
/// # Arguments
///
/// * `velocity` - Indicates the initial velocity of the spring. It is applied by external factors to the spring
/// animation, designed to help ensure the smooth transition from the previous motion state. The velocity is the
/// normalized velocity, and its value is equal to the actual velocity at the beginning of the animation divided by the
/// animation attribute change value.
///
/// * `mass` - Indicates the mass, which influences the inertia in the spring system. The greater the mass, the greater
/// the amplitude of the oscillation, and the slower the speed of restoring to the equilibrium position.
///
/// * `stiffness` - Indicates the stiffness. It is the degree to which an object deforms by resisting the force applied.
/// In an elastic system, the greater the stiffness, the stronger the ability to resist deformation, and the faster the
/// speed of restoring to the equilibrium position.
///
/// * `damping` - Indicates the damping. It is used to describe the oscillation and attenuation of the system after
/// being disturbed. The larger the damping, the smaller the number of oscillations of elastic motion, and the smaller
/// the oscillation amplitude.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateSpringCurve(
velocity: f32,
mass: f32,
stiffness: f32,
damping: f32,
) -> ArkUI_CurveHandle;
/// Creates a spring animation curve. If multiple spring animations are applied to the same attribute of an
/// object, each animation replaces their predecessor and inherits the velocity.
///
/// **Note:** The animation duration is subject to the curve parameters, rather than the <b>duration</b> parameter in
/// <b>animation</b> or <b>animateTo</b>.
///
/// # Arguments
///
/// * `response` - Indicates the duration of one complete oscillation.
///
/// * `dampingFraction` - Indicates the damping coefficient.
/// > 0 and < 1: underdamped. In this case, the spring overshoots the equilibrium position.
/// <b>1</b>: critically damped.
/// > 1: overdamped. In this case, the spring approaches equilibrium gradually.
///
/// * `overlapDuration` - Indicates the duration for animations to overlap. When animations overlap, the <b>response</b>
/// values of these animations will
/// transit smoothly over this duration if they are different.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateSpringMotion(
response: f32,
dampingFraction: f32,
overlapDuration: f32,
) -> ArkUI_CurveHandle;
/// Creates a responsive spring animation curve. It is a special case of <b>springMotion</b>, with the only
/// difference in the default values. It can be used together with <b>springMotion</b>.
///
/// **Note:** The animation duration is subject to the curve parameters, rather than the <b>duration</b> parameter in
/// <b>animation</b> or <b>animateTo</b>.
///
/// # Arguments
///
/// * `response` - Indicates the duration of one complete oscillation.
///
/// * `dampingFraction` - Indicates the damping coefficient.
/// > 0 and < 1: underdamped. In this case, the spring overshoots the equilibrium position.
/// <b>1</b>: critically damped.
/// > 1: overdamped. In this case, the spring approaches equilibrium gradually.
///
/// * `overlapDuration` - Indicates the duration for animations to overlap. When animations overlap, the
/// <b>response</b> values of these animations will
/// transit smoothly over this duration if they are different.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateResponsiveSpringMotion(
response: f32,
dampingFraction: f32,
overlapDuration: f32,
) -> ArkUI_CurveHandle;
/// Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on
/// the curve.
///
/// **Note:** The animation duration is subject to the curve parameters, rather than the <b>duration</b> parameter in
/// <b>animation</b> or <b>animateTo</b>.
///
///
/// # Arguments
///
/// * `velocity` - Indicates the initial velocity of the spring. It is applied by external factors to the spring
/// animation, esigned to help ensure the smooth transition from the previous motion state. The velocity is the
/// normalized velocity, and its value is equal to the actual velocity
/// at the beginning of the animation divided by the animation attribute change value.
///
/// * `mass` - Indicates the mass, which influences the inertia in the spring system.
/// The greater the mass, the greater the amplitude of the oscillation, and the slower the speed of restoring to the
/// equilibrium position.
///
/// * `stiffness` - Indicates the stiffness. It is the degree to which an object deforms by resisting the force applied.
/// In an elastic system, the greater the stiffness, the stronger the ability to resist deformation, and the faster the
/// speed of restoring to the equilibrium position.
///
/// * `damping` - Indicates the damping. It is used to describe the oscillation and attenuation of the system after
/// being disturbed. The larger the damping, the smaller the number of oscillations of elastic motion, and the smaller
/// the oscillation amplitude.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateInterpolatingSpring(
velocity: f32,
mass: f32,
stiffness: f32,
damping: f32,
) -> ArkUI_CurveHandle;
/// Creates a custom curve.
///
/// # Arguments
///
/// * `userData` - Indicates the custom data.
///
/// * `interpolate` - Indicates the custom interpolation callback. <b>fraction</b> indicates the input x value for
/// interpolation when the animation starts; value range: [0,1].
/// The return value is the y value of the curve; value range: [0,1].
/// If <b>fraction</b> is <b>0</b>, the return value <b>0</b> corresponds to the animation start point; any other return
/// value means that the animation jumps at the start point.
/// If <b>fraction</b> is <b>1</b>, the return value <b>1</b> corresponds to the animation end point; any other return
/// value means that the end value of the animation is not the value of the state variable,
/// which will result in an effect of transition from that end value to the value of the state variable.
///
/// # Returns
///
/// * Returns the pointer to the interpolation object of the curve.
/// Returns <b>NULL</b> if a parameter error occurs.
pub fn OH_ArkUI_Curve_CreateCustomCurve(
userData: *mut ::core::ffi::c_void,
interpolate: ::core::option::Option<
unsafe extern "C" fn(fraction: f32, userdata: *mut ::core::ffi::c_void) -> f32,
>,
) -> ArkUI_CurveHandle;
/// Disposes of a custom curve.
///
/// # Arguments
///
/// * `curve` - Indicates the pointer to the interpolation object of the curve.
pub fn OH_ArkUI_Curve_DisposeCurve(curveHandle: ArkUI_CurveHandle);
/// Creates an opacity object for component transition.
///
///
/// **Note:** If the value specified is less than 0, the value <b>0</b> is used. If the value specified is greater than 1,
/// the value <b>1</b> is used.
/// # Arguments
///
/// * `opacity` - Indicates the opacity. Value range: [0, 1].
///
/// # Returns
///
/// * Returns the created opacity object for component transition.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_CreateOpacityTransitionEffect(opacity: f32) -> *mut ArkUI_TransitionEffect;
/// Creates a translation object for component transition.
///
/// # Arguments
///
/// * `translate` - Indicates the translation settings for component transition.
///
/// # Returns
///
/// * Returns the translation object created for component transition.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_CreateTranslationTransitionEffect(
translate: *mut ArkUI_TranslationOptions,
) -> *mut ArkUI_TransitionEffect;
/// Creates a scaling object for component transition.
///
/// # Arguments
///
/// * `scale` - Indicates the scaling settings for component transition.
///
/// # Returns
///
/// * Returns the scaling object created for component transition.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_CreateScaleTransitionEffect(
scale: *mut ArkUI_ScaleOptions,
) -> *mut ArkUI_TransitionEffect;
/// Creates a rotation object for component transition.
///
/// # Arguments
///
/// * `rotate` - Indicates the rotation settings for component transition.
///
/// # Returns
///
/// * Returns the rotation object created for component transition.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_CreateRotationTransitionEffect(
rotate: *mut ArkUI_RotationOptions,
) -> *mut ArkUI_TransitionEffect;
/// Creates a movement object for component transition.
///
/// # Arguments
///
/// * `edge` - Indicates the movement type.
///
/// # Returns
///
/// * Returns the movement object created for component transition.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_CreateMovementTransitionEffect(
edge: ArkUI_TransitionEdge,
) -> *mut ArkUI_TransitionEffect;
/// Creates an asymmetric transition effect.
///
///
/// **Note:** If the <b>asymmetric</b> function is not used for <b>TransitionEffect</b>, the transition effect takes effect
/// for both appearance and disappearance of the component.
/// # Arguments
///
/// * `appear` - Indicates the transition effect for appearance.
///
/// * `disappear` - Indicates the transition effect for disappearance.
///
/// # Returns
///
/// * Returns the asymmetric transition effect.
/// Returns <b>NULL</b> if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_CreateAsymmetricTransitionEffect(
appear: *mut ArkUI_TransitionEffect,
disappear: *mut ArkUI_TransitionEffect,
) -> *mut ArkUI_TransitionEffect;
/// Disposes of a transition effect.
///
/// # Arguments
///
/// * `effect` - Indicates the transition effect to dispose of.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_TransitionEffect_Dispose(effect: *mut ArkUI_TransitionEffect);
/// Sets a combination of transition effects.
///
/// # Arguments
///
/// * `firstEffect` - Indicates the transition effect options.
///
/// * `secondEffect` - Indicates the combination of transition effects.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_TransitionEffect_Combine(
firstEffect: *mut ArkUI_TransitionEffect,
secondEffect: *mut ArkUI_TransitionEffect,
) -> i32;
/// Sets transition effect animation settings.
///
///
/// **Note:** If <b>combine</b> is used for combining transition effects, the animation settings of a transition effect are
/// applicable to the one following it.
/// # Arguments
///
/// * `effect` - Indicates the transition effect options.
///
/// * `animation` - Indicates the animation settings.
///
/// # Returns
///
/// * Returns the error code.
/// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_TransitionEffect_SetAnimation(
effect: *mut ArkUI_TransitionEffect,
animation: *mut ArkUI_AnimateOption,
) -> i32;
}