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 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010
|
import OCP.Image
from typing import *
from typing import Iterable as iterable
from typing import Iterator as iterator
from numpy import float64
_Shape = Tuple[int, ...]
import OCP.Quantity
import OCP.NCollection
import OCP.TColStd
import OCP.Standard
import io
import OCP.TCollection
__all__ = [
"Image_PixMap",
"Image_ColorBGR",
"Image_ColorBGR32",
"Image_ColorBGRA",
"Image_ColorBGRAF",
"Image_ColorBGRF",
"Image_ColorRGB",
"Image_ColorRGB32",
"Image_ColorRGBA",
"Image_ColorRGBAF",
"Image_ColorRGBF",
"Image_ColorRGF",
"Image_CompressedFormat",
"Image_CompressedPixMap",
"Image_DDSParser",
"Image_Diff",
"Image_Format",
"Image_AlienPixMap",
"Image_PixMapData",
"Image_SupportedFormats",
"Image_Texture",
"Image_VideoParams",
"Image_VideoRecorder",
"Image_CompressedFormat_NB",
"Image_CompressedFormat_RGBA_S3TC_DXT1",
"Image_CompressedFormat_RGBA_S3TC_DXT3",
"Image_CompressedFormat_RGBA_S3TC_DXT5",
"Image_CompressedFormat_RGB_S3TC_DXT1",
"Image_CompressedFormat_UNKNOWN",
"Image_Format_Alpha",
"Image_Format_AlphaF",
"Image_Format_BGR",
"Image_Format_BGR32",
"Image_Format_BGRA",
"Image_Format_BGRAF",
"Image_Format_BGRF",
"Image_Format_Gray",
"Image_Format_Gray16",
"Image_Format_GrayF",
"Image_Format_GrayF_half",
"Image_Format_NB",
"Image_Format_RGB",
"Image_Format_RGB32",
"Image_Format_RGBA",
"Image_Format_RGBAF",
"Image_Format_RGBAF_half",
"Image_Format_RGBF",
"Image_Format_RGF",
"Image_Format_RGF_half",
"Image_Format_UNKNOWN"
]
class Image_PixMap(OCP.Standard.Standard_Transient):
"""
Class represents packed image plane.Class represents packed image plane.
"""
def ChangeData(self) -> int:
"""
Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).
"""
def ChangeRawValue(self,theRow : int,theCol : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.
"""
def ChangeRawValueXY(self,theX : int,theY : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.
"""
def ChangeRawValueXYZ(self,theX : int,theY : int,theZ : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.
"""
def ChangeRow(self,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
def ChangeSlice(self,theSlice : int) -> int:
"""
Return data pointer to requested 2D slice. Indexation starts from 0.
"""
def ChangeSliceRow(self,theSlice : int,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
def Clear(self) -> None:
"""
Method correctly deallocate internal buffer.
"""
@staticmethod
def ColorFromRawPixel_s(theRawValue : int,theFormat : Image_Format,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA:
"""
Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow.
"""
@staticmethod
def ColorToRawPixel_s(theRawValue : int,theFormat : Image_Format,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None:
"""
Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow.
"""
@staticmethod
def ConvertFromHalfFloat_s(theHalf : int) -> float:
"""
Convert 16-bit half-float value into 32-bit float (simple conversion).
"""
@staticmethod
def ConvertToHalfFloat_s(theFloat : float) -> int:
"""
Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits.
"""
def Data(self) -> int:
"""
Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
@staticmethod
def DefaultAllocator_s() -> OCP.NCollection.NCollection_BaseAllocator:
"""
Return default image data allocator.
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def Depth(self) -> int:
"""
Return image depth in pixels.
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def FlipY_s(theImage : Image_PixMap) -> bool:
"""
Reverse line order as it draws it from bottom to top.
"""
def Format(self) -> Image_Format:
"""
Return pixel format.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def Height(self) -> int:
"""
Return image height in pixels.
"""
@staticmethod
@overload
def ImageFormatToString_s(theFormat : Image_Format) -> str:
"""
Return string representation of pixel format.
Return string representation of compressed pixel format.
"""
@staticmethod
@overload
def ImageFormatToString_s(theFormat : Image_CompressedFormat) -> str: ...
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def InitCopy(self,theCopy : Image_PixMap) -> bool:
"""
Initialize by copying data. If you want to copy alien data you should create wrapper using InitWrapper() before.
"""
def InitTrash(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool:
"""
Initialize image plane with required dimensions. Memory will be left uninitialized (performance trick).
"""
def InitTrash3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool:
"""
Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick).
"""
def InitWrapper(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool:
"""
Initialize image plane as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.
"""
def InitWrapper3D(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool:
"""
Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.
"""
def InitZero(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0,theValue : int=0) -> bool:
"""
Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats).
"""
def InitZero3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0,theValue : int=0) -> bool:
"""
Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats).
"""
@staticmethod
def IsBigEndianHost_s() -> bool:
"""
Determine Big-Endian at runtime
"""
def IsEmpty(self) -> bool:
"""
Return true if data is NULL.
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsTopDown(self) -> bool:
"""
Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support.
"""
def MaxRowAligmentBytes(self) -> int:
"""
Compute the maximal row alignment for current row size.
"""
def PixelColor(self,theX : int,theY : int,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA:
"""
Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().
"""
def Ratio(self) -> float:
"""
Return width / height.
"""
def RawValue(self,theRow : int,theCol : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.
"""
def RawValueXY(self,theX : int,theY : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.
"""
def RawValueXYZ(self,theX : int,theY : int,theZ : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.
"""
def Row(self,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
def RowExtraBytes(self) -> int:
"""
Return the extra bytes in the row.
"""
def SetFormat(self,thePixelFormat : Image_Format) -> None:
"""
Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha).
"""
@overload
def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None:
"""
Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().
Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().
"""
@overload
def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_Color,theToDeLinearize : bool=False) -> None: ...
def SetTopDown(self,theIsTopDown : bool) -> None:
"""
Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored!
"""
def SizeBytes(self) -> int:
"""
Return buffer size
"""
def SizePixelBytes(self) -> int:
"""
Return bytes reserved for one pixel (may include extra bytes for alignment).
"""
@staticmethod
def SizePixelBytes_s(thePixelFormat : Image_Format) -> int:
"""
Return bytes reserved for one pixel (may include extra bytes for alignment).
"""
def SizeRowBytes(self) -> int:
"""
Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.).
"""
def SizeSliceBytes(self) -> int:
"""
Return number of bytes per 2D slice.
"""
def SizeX(self) -> int:
"""
Return image width in pixels.
"""
def SizeXYZ(self) -> Any:
"""
Return image width x height x depth in pixels.
"""
def SizeY(self) -> int:
"""
Return image height in pixels.
"""
def SizeZ(self) -> int:
"""
Return image depth in pixels.
"""
def Slice(self,theSlice : int) -> int:
"""
Return data pointer to requested 2D slice. Indexation starts from 0.
"""
def SliceRow(self,theSlice : int,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
@staticmethod
def SwapRgbaBgra_s(theImage : Image_PixMap) -> bool:
"""
Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following: - Image_Format_RGB32 / Image_Format_BGR32 - Image_Format_RGBA / Image_Format_BGRA - Image_Format_RGB / Image_Format_BGR - Image_Format_RGBF / Image_Format_BGRF - Image_Format_RGBAF / Image_Format_BGRAF
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@staticmethod
def ToBlackWhite_s(theImage : Image_PixMap) -> None:
"""
Convert image to Black/White.
"""
def TopDownInc(self) -> int:
"""
Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise.
"""
def Width(self) -> int:
"""
Return image width in pixels.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Image_ColorBGR():
"""
POD structure for packed BGR color value (3 bytes)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def b(self) -> int:
"""
Alias to 1st component (blue intensity).
Alias to 1st component (blue intensity).
"""
def g(self) -> int:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> int:
"""
Alias to 3rd component (red intensity).
Alias to 3rd component (red intensity).
"""
pass
class Image_ColorBGR32():
"""
POD structure for packed BGR color value (4 bytes with extra byte for alignment)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def a_(self) -> int:
"""
Alias to 4th component (dummy).
Alias to 4th component (dummy).
"""
def b(self) -> int:
"""
Alias to 1st component (blue intensity).
Alias to 1st component (blue intensity).
"""
def g(self) -> int:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> int:
"""
Alias to 3rd component (red intensity).
Alias to 3rd component (red intensity).
"""
pass
class Image_ColorBGRA():
"""
POD structure for packed BGRA color value (4 bytes)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def a(self) -> int:
"""
Alias to 4th component (alpha value).
Alias to 4th component (alpha value).
"""
def b(self) -> int:
"""
Alias to 1st component (blue intensity).
Alias to 1st component (blue intensity).
"""
def g(self) -> int:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> int:
"""
Alias to 3rd component (red intensity).
Alias to 3rd component (red intensity).
"""
pass
class Image_ColorBGRAF():
"""
POD structure for packed float BGRA color value (4 floats)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def a(self) -> float:
"""
Alias to 4th component (alpha value).
Alias to 4th component (alpha value).
"""
def b(self) -> float:
"""
Alias to 1st component (blue intensity).
Alias to 1st component (blue intensity).
"""
def g(self) -> float:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> float:
"""
Alias to 3rd component (red intensity).
Alias to 3rd component (red intensity).
"""
pass
class Image_ColorBGRF():
"""
POD structure for packed BGR float color value (3 floats)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def b(self) -> float:
"""
Alias to 1st component (blue intensity).
Alias to 1st component (blue intensity).
"""
def g(self) -> float:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> float:
"""
Alias to 3rd component (red intensity).
Alias to 3rd component (red intensity).
"""
pass
class Image_ColorRGB():
"""
POD structure for packed RGB color value (3 bytes)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def b(self) -> int:
"""
Alias to 3rd component (blue intensity).
Alias to 3rd component (blue intensity).
"""
def g(self) -> int:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> int:
"""
Alias to 1st component (red intensity).
Alias to 1st component (red intensity).
"""
pass
class Image_ColorRGB32():
"""
POD structure for packed RGB color value (4 bytes with extra byte for alignment)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def a_(self) -> int:
"""
Alias to 4th component (dummy).
Alias to 4th component (dummy).
"""
def b(self) -> int:
"""
Alias to 3rd component (blue intensity).
Alias to 3rd component (blue intensity).
"""
def g(self) -> int:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> int:
"""
Alias to 1st component (red intensity).
Alias to 1st component (red intensity).
"""
pass
class Image_ColorRGBA():
"""
POD structure for packed RGBA color value (4 bytes)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def a(self) -> int:
"""
Alias to 4th component (alpha value).
Alias to 4th component (alpha value).
"""
def b(self) -> int:
"""
Alias to 3rd component (blue intensity).
Alias to 3rd component (blue intensity).
"""
def g(self) -> int:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> int:
"""
Alias to 1st component (red intensity).
Alias to 1st component (red intensity).
"""
pass
class Image_ColorRGBAF():
"""
POD structure for packed RGBA color value (4 floats)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def a(self) -> float:
"""
Alias to 4th component (alpha value).
Alias to 4th component (alpha value).
"""
def b(self) -> float:
"""
Alias to 3rd component (blue intensity).
Alias to 3rd component (blue intensity).
"""
def g(self) -> float:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> float:
"""
Alias to 1st component (red intensity).
Alias to 1st component (red intensity).
"""
pass
class Image_ColorRGBF():
"""
POD structure for packed float RGB color value (3 floats)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def b(self) -> float:
"""
Alias to 3rd component (blue intensity).
Alias to 3rd component (blue intensity).
"""
def g(self) -> float:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> float:
"""
Alias to 1st component (red intensity).
Alias to 1st component (red intensity).
"""
pass
class Image_ColorRGF():
"""
POD structure for packed float RG color value (2 floats)
"""
@staticmethod
def Length_s() -> int:
"""
Returns the number of components.
"""
def __init__(self) -> None: ...
def g(self) -> float:
"""
Alias to 2nd component (green intensity).
Alias to 2nd component (green intensity).
"""
def r(self) -> float:
"""
Alias to 1st component (red intensity).
Alias to 1st component (red intensity).
"""
pass
class Image_CompressedFormat():
"""
List of compressed pixel formats natively supported by various graphics hardware (e.g. for efficient decoding on-the-fly). It is defined as extension of Image_Format.
Members:
Image_CompressedFormat_UNKNOWN
Image_CompressedFormat_RGB_S3TC_DXT1
Image_CompressedFormat_RGBA_S3TC_DXT1
Image_CompressedFormat_RGBA_S3TC_DXT3
Image_CompressedFormat_RGBA_S3TC_DXT5
"""
def __eq__(self,other : object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self,value : int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self,other : object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self,state : int) -> None: ...
def __str__(self) -> str: ...
@property
def name(self) -> None:
"""
:type: None
"""
@property
def value(self) -> int:
"""
:type: int
"""
Image_CompressedFormat_RGBA_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT1: 21>
Image_CompressedFormat_RGBA_S3TC_DXT3: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT3: 22>
Image_CompressedFormat_RGBA_S3TC_DXT5: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT5: 23>
Image_CompressedFormat_RGB_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGB_S3TC_DXT1: 20>
Image_CompressedFormat_UNKNOWN: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_UNKNOWN: 0>
__entries: dict # value = {'Image_CompressedFormat_UNKNOWN': (<Image_CompressedFormat.Image_CompressedFormat_UNKNOWN: 0>, None), 'Image_CompressedFormat_RGB_S3TC_DXT1': (<Image_CompressedFormat.Image_CompressedFormat_RGB_S3TC_DXT1: 20>, None), 'Image_CompressedFormat_RGBA_S3TC_DXT1': (<Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT1: 21>, None), 'Image_CompressedFormat_RGBA_S3TC_DXT3': (<Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT3: 22>, None), 'Image_CompressedFormat_RGBA_S3TC_DXT5': (<Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT5: 23>, None)}
__members__: dict # value = {'Image_CompressedFormat_UNKNOWN': <Image_CompressedFormat.Image_CompressedFormat_UNKNOWN: 0>, 'Image_CompressedFormat_RGB_S3TC_DXT1': <Image_CompressedFormat.Image_CompressedFormat_RGB_S3TC_DXT1: 20>, 'Image_CompressedFormat_RGBA_S3TC_DXT1': <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT1: 21>, 'Image_CompressedFormat_RGBA_S3TC_DXT3': <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT3: 22>, 'Image_CompressedFormat_RGBA_S3TC_DXT5': <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT5: 23>}
pass
class Image_CompressedPixMap(OCP.Standard.Standard_Transient):
"""
Compressed pixmap data definition. It is defined independently from Image_PixMap, which defines only uncompressed formats.
"""
def BaseFormat(self) -> Image_Format:
"""
Return base (uncompressed) pixel format.
"""
def ChangeMipMaps(self) -> OCP.TColStd.TColStd_Array1OfInteger:
"""
Return Array of mipmap sizes, including base level.
"""
def CompressedFormat(self) -> Image_CompressedFormat:
"""
Return compressed format.
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def FaceBytes(self) -> int:
"""
Return surface length in bytes.
"""
def FaceData(self) -> OCP.NCollection.NCollection_Buffer:
"""
Return raw (compressed) data.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def IsCompleteMipMapSet(self) -> bool:
"""
Return TRUE if complete mip map level set (up to 1x1 resolution).
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsTopDown(self) -> bool:
"""
Return TRUE if image layout is top-down (always true).
"""
def MipMaps(self) -> OCP.TColStd.TColStd_Array1OfInteger:
"""
Return Array of mipmap sizes, including base level.
"""
def NbFaces(self) -> int:
"""
Return number of faces in the file; should be 6 for cubemap.
"""
def SetBaseFormat(self,theFormat : Image_Format) -> None:
"""
Set base (uncompressed) pixel format.
"""
def SetCompleteMipMapSet(self,theIsComplete : bool) -> None:
"""
Set if complete mip map level set (up to 1x1 resolution).
"""
def SetCompressedFormat(self,theFormat : Image_CompressedFormat) -> None:
"""
Set compressed format.
"""
def SetFaceBytes(self,theSize : int) -> None:
"""
Set surface length in bytes.
"""
def SetFaceData(self,theBuffer : OCP.NCollection.NCollection_Buffer) -> None:
"""
Set raw (compressed) data.
"""
def SetNbFaces(self,theSize : int) -> None:
"""
Set number of faces in the file.
"""
def SetSize(self,theSizeX : int,theSizeY : int) -> None:
"""
Set surface width x height.
"""
def SizeX(self) -> int:
"""
Return surface width.
"""
def SizeY(self) -> int:
"""
Return surface height.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Image_DDSParser():
"""
Auxiliary tool for parsing DDS file structure (without decoding).
"""
@staticmethod
@overload
def Load_s(theSupported : Image_SupportedFormats,theBuffer : OCP.NCollection.NCollection_Buffer,theFaceIndex : int) -> Image_CompressedPixMap:
"""
Load the face from DDS file.
Load the face from DDS file.
"""
@staticmethod
@overload
def Load_s(theSupported : Image_SupportedFormats,theFile : OCP.TCollection.TCollection_AsciiString,theFaceIndex : int,theFileOffset : int=0) -> Image_CompressedPixMap: ...
def __init__(self) -> None: ...
pass
class Image_Diff(OCP.Standard.Standard_Transient):
"""
This class compares two images pixel-by-pixel. It uses the following methods to ignore the difference between images: - Black/White comparison. It makes the images 2-colored before the comparison. - Equality with tolerance. Colors of two pixels are considered the same if the difference of their color is less than a tolerance. - Border filter. The algorithm ignores alone independent pixels, which are different on both images, ignores the "border effect" - the difference caused by triangles located at angle about 0 or 90 degrees to the user.This class compares two images pixel-by-pixel. It uses the following methods to ignore the difference between images: - Black/White comparison. It makes the images 2-colored before the comparison. - Equality with tolerance. Colors of two pixels are considered the same if the difference of their color is less than a tolerance. - Border filter. The algorithm ignores alone independent pixels, which are different on both images, ignores the "border effect" - the difference caused by triangles located at angle about 0 or 90 degrees to the user.
"""
def ColorTolerance(self) -> float:
"""
Color tolerance for equality check.
"""
def Compare(self) -> int:
"""
Compares two images. It returns a number of different pixels (or groups of pixels). It returns -1 if algorithm not initialized before.
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def Init(self,theImgPathRef : OCP.TCollection.TCollection_AsciiString,theImgPathNew : OCP.TCollection.TCollection_AsciiString,theToBlackWhite : bool=False) -> bool:
"""
Initialize algorithm by two images.
Initialize algorithm by two images (will be loaded from files).
"""
@overload
def Init(self,theImageRef : Image_PixMap,theImageNew : Image_PixMap,theToBlackWhite : bool=False) -> bool: ...
def IsBorderFilterOn(self) -> bool:
"""
Returns a flag of taking into account (ignoring) a border effect in comparison of images.
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
@overload
def SaveDiffImage(self,theDiffPath : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Saves a difference between two images as white pixels on black background.
Saves a difference between two images as white pixels on black background.
"""
@overload
def SaveDiffImage(self,theDiffImage : Image_PixMap) -> bool: ...
def SetBorderFilterOn(self,theToIgnore : bool) -> None:
"""
Sets taking into account (ignoring) a "border effect" on comparison of images. The border effect is caused by a border of shaded shapes in the viewer 3d. Triangles of this area are located at about 0 or 90 degrees to the user. Therefore, they deflect light differently according to implementation of a video card driver. This flag allows to detect such a "border" area and skip it from comparison of images. Filter turned OFF by default.
"""
def SetColorTolerance(self,theTolerance : float) -> None:
"""
Color tolerance for equality check. Should be within range 0..1: Corresponds to a difference between white and black colors (maximum difference). By default, the tolerance is equal to 0 thus equality check will return false for any different colors.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Image_Format():
"""
This enumeration defines packed image plane formats
Members:
Image_Format_UNKNOWN
Image_Format_Gray
Image_Format_Alpha
Image_Format_RGB
Image_Format_BGR
Image_Format_RGB32
Image_Format_BGR32
Image_Format_RGBA
Image_Format_BGRA
Image_Format_GrayF
Image_Format_AlphaF
Image_Format_RGF
Image_Format_RGBF
Image_Format_BGRF
Image_Format_RGBAF
Image_Format_BGRAF
Image_Format_GrayF_half
Image_Format_RGF_half
Image_Format_RGBAF_half
Image_Format_Gray16
"""
def __eq__(self,other : object) -> bool: ...
def __getstate__(self) -> int: ...
def __hash__(self) -> int: ...
def __index__(self) -> int: ...
def __init__(self,value : int) -> None: ...
def __int__(self) -> int: ...
def __ne__(self,other : object) -> bool: ...
def __repr__(self) -> str: ...
def __setstate__(self,state : int) -> None: ...
def __str__(self) -> str: ...
@property
def name(self) -> None:
"""
:type: None
"""
@property
def value(self) -> int:
"""
:type: int
"""
Image_Format_Alpha: OCP.Image.Image_Format # value = <Image_Format.Image_Format_Alpha: 2>
Image_Format_AlphaF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_AlphaF: 10>
Image_Format_BGR: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGR: 4>
Image_Format_BGR32: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGR32: 6>
Image_Format_BGRA: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGRA: 8>
Image_Format_BGRAF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGRAF: 15>
Image_Format_BGRF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGRF: 13>
Image_Format_Gray: OCP.Image.Image_Format # value = <Image_Format.Image_Format_Gray: 1>
Image_Format_Gray16: OCP.Image.Image_Format # value = <Image_Format.Image_Format_Gray16: 19>
Image_Format_GrayF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_GrayF: 9>
Image_Format_GrayF_half: OCP.Image.Image_Format # value = <Image_Format.Image_Format_GrayF_half: 16>
Image_Format_RGB: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGB: 3>
Image_Format_RGB32: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGB32: 5>
Image_Format_RGBA: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBA: 7>
Image_Format_RGBAF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBAF: 14>
Image_Format_RGBAF_half: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBAF_half: 18>
Image_Format_RGBF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBF: 12>
Image_Format_RGF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGF: 11>
Image_Format_RGF_half: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGF_half: 17>
Image_Format_UNKNOWN: OCP.Image.Image_Format # value = <Image_Format.Image_Format_UNKNOWN: 0>
__entries: dict # value = {'Image_Format_UNKNOWN': (<Image_Format.Image_Format_UNKNOWN: 0>, None), 'Image_Format_Gray': (<Image_Format.Image_Format_Gray: 1>, None), 'Image_Format_Alpha': (<Image_Format.Image_Format_Alpha: 2>, None), 'Image_Format_RGB': (<Image_Format.Image_Format_RGB: 3>, None), 'Image_Format_BGR': (<Image_Format.Image_Format_BGR: 4>, None), 'Image_Format_RGB32': (<Image_Format.Image_Format_RGB32: 5>, None), 'Image_Format_BGR32': (<Image_Format.Image_Format_BGR32: 6>, None), 'Image_Format_RGBA': (<Image_Format.Image_Format_RGBA: 7>, None), 'Image_Format_BGRA': (<Image_Format.Image_Format_BGRA: 8>, None), 'Image_Format_GrayF': (<Image_Format.Image_Format_GrayF: 9>, None), 'Image_Format_AlphaF': (<Image_Format.Image_Format_AlphaF: 10>, None), 'Image_Format_RGF': (<Image_Format.Image_Format_RGF: 11>, None), 'Image_Format_RGBF': (<Image_Format.Image_Format_RGBF: 12>, None), 'Image_Format_BGRF': (<Image_Format.Image_Format_BGRF: 13>, None), 'Image_Format_RGBAF': (<Image_Format.Image_Format_RGBAF: 14>, None), 'Image_Format_BGRAF': (<Image_Format.Image_Format_BGRAF: 15>, None), 'Image_Format_GrayF_half': (<Image_Format.Image_Format_GrayF_half: 16>, None), 'Image_Format_RGF_half': (<Image_Format.Image_Format_RGF_half: 17>, None), 'Image_Format_RGBAF_half': (<Image_Format.Image_Format_RGBAF_half: 18>, None), 'Image_Format_Gray16': (<Image_Format.Image_Format_Gray16: 19>, None)}
__members__: dict # value = {'Image_Format_UNKNOWN': <Image_Format.Image_Format_UNKNOWN: 0>, 'Image_Format_Gray': <Image_Format.Image_Format_Gray: 1>, 'Image_Format_Alpha': <Image_Format.Image_Format_Alpha: 2>, 'Image_Format_RGB': <Image_Format.Image_Format_RGB: 3>, 'Image_Format_BGR': <Image_Format.Image_Format_BGR: 4>, 'Image_Format_RGB32': <Image_Format.Image_Format_RGB32: 5>, 'Image_Format_BGR32': <Image_Format.Image_Format_BGR32: 6>, 'Image_Format_RGBA': <Image_Format.Image_Format_RGBA: 7>, 'Image_Format_BGRA': <Image_Format.Image_Format_BGRA: 8>, 'Image_Format_GrayF': <Image_Format.Image_Format_GrayF: 9>, 'Image_Format_AlphaF': <Image_Format.Image_Format_AlphaF: 10>, 'Image_Format_RGF': <Image_Format.Image_Format_RGF: 11>, 'Image_Format_RGBF': <Image_Format.Image_Format_RGBF: 12>, 'Image_Format_BGRF': <Image_Format.Image_Format_BGRF: 13>, 'Image_Format_RGBAF': <Image_Format.Image_Format_RGBAF: 14>, 'Image_Format_BGRAF': <Image_Format.Image_Format_BGRAF: 15>, 'Image_Format_GrayF_half': <Image_Format.Image_Format_GrayF_half: 16>, 'Image_Format_RGF_half': <Image_Format.Image_Format_RGF_half: 17>, 'Image_Format_RGBAF_half': <Image_Format.Image_Format_RGBAF_half: 18>, 'Image_Format_Gray16': <Image_Format.Image_Format_Gray16: 19>}
pass
class Image_AlienPixMap(Image_PixMap, OCP.Standard.Standard_Transient):
"""
Image class that support file reading/writing operations using auxiliary image library. Supported image formats: - *.bmp - bitmap image, lossless format without compression. - *.ppm - PPM (Portable Pixmap Format), lossless format without compression. - *.png - PNG (Portable Network Graphics) lossless format with compression. - *.jpg, *.jpe, *.jpeg - JPEG/JIFF (Joint Photographic Experts Group) lossy format (compressed with quality losses). YUV color space used (automatically converted from/to RGB). - *.tif, *.tiff - TIFF (Tagged Image File Format). - *.tga - TGA (Truevision Targa Graphic), lossless format. - *.gif - GIF (Graphical Interchange Format), lossy format. Color stored using palette (up to 256 distinct colors). - *.exr - OpenEXR high dynamic-range format (supports float pixel formats).Image class that support file reading/writing operations using auxiliary image library. Supported image formats: - *.bmp - bitmap image, lossless format without compression. - *.ppm - PPM (Portable Pixmap Format), lossless format without compression. - *.png - PNG (Portable Network Graphics) lossless format with compression. - *.jpg, *.jpe, *.jpeg - JPEG/JIFF (Joint Photographic Experts Group) lossy format (compressed with quality losses). YUV color space used (automatically converted from/to RGB). - *.tif, *.tiff - TIFF (Tagged Image File Format). - *.tga - TGA (Truevision Targa Graphic), lossless format. - *.gif - GIF (Graphical Interchange Format), lossy format. Color stored using palette (up to 256 distinct colors). - *.exr - OpenEXR high dynamic-range format (supports float pixel formats).
"""
def AdjustGamma(self,theGammaCorr : float) -> bool:
"""
Performs gamma correction on image.
"""
def ChangeData(self) -> int:
"""
Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).
"""
def ChangeRawValue(self,theRow : int,theCol : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.
"""
def ChangeRawValueXY(self,theX : int,theY : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.
"""
def ChangeRawValueXYZ(self,theX : int,theY : int,theZ : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.
"""
def ChangeRow(self,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
def ChangeSlice(self,theSlice : int) -> int:
"""
Return data pointer to requested 2D slice. Indexation starts from 0.
"""
def ChangeSliceRow(self,theSlice : int,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
def Clear(self) -> None:
"""
Method correctly deallocate internal buffer.
"""
@staticmethod
def ColorFromRawPixel_s(theRawValue : int,theFormat : Image_Format,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA:
"""
Convert raw pixel value into Quantity_ColorRGBA. This function is relatively slow.
"""
@staticmethod
def ColorToRawPixel_s(theRawValue : int,theFormat : Image_Format,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None:
"""
Set raw pixel value from Quantity_ColorRGBA. This function is relatively slow.
"""
@staticmethod
def ConvertFromHalfFloat_s(theHalf : int) -> float:
"""
Convert 16-bit half-float value into 32-bit float (simple conversion).
"""
@staticmethod
def ConvertToHalfFloat_s(theFloat : float) -> int:
"""
Convert 32-bit float value into IEEE-754 16-bit floating-point format without infinity: 1-5-10, exp-15, +-131008.0, +-6.1035156E-5, +-5.9604645E-8, 3.311 digits.
"""
def Data(self) -> int:
"""
Return data pointer for low-level operations (copying entire buffer, parsing with extra tools etc.).
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
@staticmethod
def DefaultAllocator_s() -> OCP.NCollection.NCollection_BaseAllocator:
"""
Return default image data allocator.
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def Depth(self) -> int:
"""
Return image depth in pixels.
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def FlipY_s(theImage : Image_PixMap) -> bool:
"""
Reverse line order as it draws it from bottom to top.
"""
def Format(self) -> Image_Format:
"""
Return pixel format.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def Height(self) -> int:
"""
Return image height in pixels.
"""
@staticmethod
@overload
def ImageFormatToString_s(theFormat : Image_Format) -> str:
"""
Return string representation of pixel format.
Return string representation of compressed pixel format.
"""
@staticmethod
@overload
def ImageFormatToString_s(theFormat : Image_CompressedFormat) -> str: ...
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
def InitCopy(self,theCopy : Image_PixMap) -> bool:
"""
Initialize by copying data.
"""
def InitTrash(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool:
"""
Initialize image plane with required dimensions.
"""
def InitTrash3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool:
"""
Initialize 2D/3D image with required dimensions. Memory will be left uninitialized (performance trick).
"""
def InitWrapper(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0) -> bool:
"""
Initialize image plane as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.
"""
def InitWrapper3D(self,thePixelFormat : Image_Format,theDataPtr : int,theSizeXYZ : Any,theSizeRowBytes : int=0) -> bool:
"""
Initialize 2D/3D image as wrapper over alien data. Data will not be copied! Notice that caller should ensure that data pointer will not be released during this wrapper lifetime. You may call InitCopy() to perform data copying.
"""
def InitZero(self,thePixelFormat : Image_Format,theSizeX : int,theSizeY : int,theSizeRowBytes : int=0,theValue : int=0) -> bool:
"""
Initialize image plane with required dimensions. Buffer will be zeroed (black color for most formats).
"""
def InitZero3D(self,thePixelFormat : Image_Format,theSizeXYZ : Any,theSizeRowBytes : int=0,theValue : int=0) -> bool:
"""
Initialize 2D/3D image with required dimensions. Buffer will be zeroed (black color for most formats).
"""
@staticmethod
def IsBigEndianHost_s() -> bool:
"""
Determine Big-Endian at runtime
"""
def IsEmpty(self) -> bool:
"""
Return true if data is NULL.
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def IsTopDown(self) -> bool:
"""
Returns TRUE if image data is stored from Top to the Down. By default Bottom Up order is used instead (topmost scanlines starts from the bottom in memory). which is most image frameworks naturally support.
"""
@staticmethod
def IsTopDownDefault_s() -> bool:
"""
Return default rows order used by underlying image library.
"""
def MaxRowAligmentBytes(self) -> int:
"""
Compute the maximal row alignment for current row size.
"""
def PixelColor(self,theX : int,theY : int,theToLinearize : bool=False) -> OCP.Quantity.Quantity_ColorRGBA:
"""
Returns the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().
"""
def Ratio(self) -> float:
"""
Return width / height.
"""
def RawValue(self,theRow : int,theCol : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in the decreasing majority following memory layout - e.g. row first, column next.
"""
def RawValueXY(self,theX : int,theY : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y order.
"""
def RawValueXYZ(self,theX : int,theY : int,theZ : int) -> int:
"""
Access image pixel as raw data pointer. Indexation starts from 0. This method does not perform any type checks - use on own risk (check Format() before)! WARNING: Input parameters are defined in traditional X, Y, Z order.
"""
def Row(self,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
def RowExtraBytes(self) -> int:
"""
Return the extra bytes in the row.
"""
@overload
def Save(self,theFileName : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Write image data to file.
Write image data to stream.
Write image data to file or memory buffer using file extension to determine format.
"""
@overload
def Save(self,theBuffer : int,theLength : int,theFileName : OCP.TCollection.TCollection_AsciiString) -> bool: ...
@overload
def Save(self,theStream : io.BytesIO,theExtension : OCP.TCollection.TCollection_AsciiString) -> bool: ...
def SetFormat(self,thePixelFormat : Image_Format) -> None:
"""
Override pixel format specified by InitXXX() methods. Will throw exception if pixel size of new format is not equal to currently initialized format. Intended to switch formats indicating different interpretation of the same data (e.g. ImgGray and ImgAlpha).
"""
@overload
def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_ColorRGBA,theToDeLinearize : bool=False) -> None:
"""
Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().
Sets the pixel color. This function is relatively slow. Beware that this method takes coordinates in opposite order in contrast to ::Value() and ::ChangeValue().
"""
@overload
def SetPixelColor(self,theX : int,theY : int,theColor : OCP.Quantity.Quantity_Color,theToDeLinearize : bool=False) -> None: ...
def SetTopDown(self,theIsTopDown : bool) -> None:
"""
Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored!
"""
def SizeBytes(self) -> int:
"""
Return buffer size
"""
def SizePixelBytes(self) -> int:
"""
Return bytes reserved for one pixel (may include extra bytes for alignment).
"""
@staticmethod
def SizePixelBytes_s(thePixelFormat : Image_Format) -> int:
"""
Return bytes reserved for one pixel (may include extra bytes for alignment).
"""
def SizeRowBytes(self) -> int:
"""
Return bytes reserved per row. Could be larger than needed to store packed row (extra bytes for alignment etc.).
"""
def SizeSliceBytes(self) -> int:
"""
Return number of bytes per 2D slice.
"""
def SizeX(self) -> int:
"""
Return image width in pixels.
"""
def SizeXYZ(self) -> Any:
"""
Return image width x height x depth in pixels.
"""
def SizeY(self) -> int:
"""
Return image height in pixels.
"""
def SizeZ(self) -> int:
"""
Return image depth in pixels.
"""
def Slice(self,theSlice : int) -> int:
"""
Return data pointer to requested 2D slice. Indexation starts from 0.
"""
def SliceRow(self,theSlice : int,theRow : int) -> int:
"""
Return data pointer to requested row (first column). Indexation starts from 0.
"""
@staticmethod
def SwapRgbaBgra_s(theImage : Image_PixMap) -> bool:
"""
Auxiliary method for swapping bytes between RGB and BGR formats. This method modifies the image data but does not change pixel format! Method will fail if pixel format is not one of the following: - Image_Format_RGB32 / Image_Format_BGR32 - Image_Format_RGBA / Image_Format_BGRA - Image_Format_RGB / Image_Format_BGR - Image_Format_RGBF / Image_Format_BGRF - Image_Format_RGBAF / Image_Format_BGRAF
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@staticmethod
def ToBlackWhite_s(theImage : Image_PixMap) -> None:
"""
Convert image to Black/White.
"""
def TopDownInc(self) -> int:
"""
Returns +1 if scanlines ordered in Top->Down order in memory and -1 otherwise.
"""
def Width(self) -> int:
"""
Return image width in pixels.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Image_PixMapData(OCP.NCollection.NCollection_Buffer, OCP.Standard.Standard_Transient):
"""
Structure to manage image buffer.Structure to manage image buffer.
"""
def Allocate(self,theSize : int) -> bool:
"""
Allocate the buffer.
"""
def Allocator(self) -> OCP.NCollection.NCollection_BaseAllocator:
"""
Returns buffer allocator
"""
def ChangeData(self) -> int:
"""
Returns buffer data
"""
def ChangeRow(self,theRow : int) -> int:
"""
Return data pointer to requested row (first column).
"""
def ChangeSlice(self,theSlice : int) -> int:
"""
Return data pointer to requested 2D slice.
"""
def ChangeSliceRow(self,theSlice : int,theRow : int) -> int:
"""
Return data pointer to requested row (first column).
"""
def ChangeValue(self,theRow : int,theCol : int) -> int:
"""
Return data pointer to requested position.
"""
def ChangeValueXY(self,theX : int,theY : int) -> int:
"""
Return data pointer to requested position.
"""
def ChangeValueXYZ(self,theX : int,theY : int,theZ : int) -> int:
"""
Return data pointer to requested position.
"""
def Data(self) -> int:
"""
Returns buffer data
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None:
"""
Dumps the content of me into the stream
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def Free(self) -> None:
"""
De-allocate buffer.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def Init(self,theAlloc : OCP.NCollection.NCollection_BaseAllocator,theSizeBPP : int,theSizeXYZ : Any,theSizeRowBytes : int,theDataPtr : int) -> bool:
"""
Initializer.
Initializer.
"""
@overload
def Init(self,theAlloc : OCP.NCollection.NCollection_BaseAllocator,theSizeBPP : int,theSizeX : int,theSizeY : int,theSizeRowBytes : int,theDataPtr : int) -> bool: ...
def IsEmpty(self) -> bool:
"""
Returns true if buffer is not allocated
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def MaxRowAligmentBytes(self) -> int:
"""
Compute the maximal row alignment for current row size.
"""
def Row(self,theRow : int) -> int:
"""
Return data pointer to requested row (first column).
"""
def SetAllocator(self,theAlloc : OCP.NCollection.NCollection_BaseAllocator) -> None:
"""
Assign new buffer allocator with de-allocation of buffer.
"""
def SetTopDown(self,theIsTopDown : bool) -> None:
"""
Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored!
"""
def Size(self) -> int:
"""
Return buffer length in bytes.
"""
def Slice(self,theSlice : int) -> int:
"""
Return data pointer to requested 2D slice.
"""
def SliceRow(self,theSlice : int,theRow : int) -> int:
"""
Return data pointer to requested row (first column).
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def Value(self,theRow : int,theCol : int) -> int:
"""
Return data pointer to requested position.
"""
def ValueXY(self,theX : int,theY : int) -> int:
"""
Return data pointer to requested position.
"""
def ValueXYZ(self,theX : int,theY : int,theZ : int) -> int:
"""
Return data pointer to requested position.
"""
def ZeroData(self) -> None:
"""
Reset all values to zeros.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
@property
def SizeBPP(self) -> int:
"""
:type: int
"""
@SizeBPP.setter
def SizeBPP(self, arg0: int) -> None:
pass
@property
def SizeRowBytes(self) -> int:
"""
:type: int
"""
@SizeRowBytes.setter
def SizeRowBytes(self, arg0: int) -> None:
pass
@property
def SizeSliceBytes(self) -> int:
"""
:type: int
"""
@SizeSliceBytes.setter
def SizeSliceBytes(self, arg0: int) -> None:
pass
@property
def SizeX(self) -> int:
"""
:type: int
"""
@SizeX.setter
def SizeX(self, arg0: int) -> None:
pass
@property
def SizeY(self) -> int:
"""
:type: int
"""
@SizeY.setter
def SizeY(self, arg0: int) -> None:
pass
@property
def SizeZ(self) -> int:
"""
:type: int
"""
@SizeZ.setter
def SizeZ(self, arg0: int) -> None:
pass
@property
def TopToDown(self) -> int:
"""
:type: int
"""
@TopToDown.setter
def TopToDown(self, arg0: int) -> None:
pass
pass
class Image_SupportedFormats(OCP.Standard.Standard_Transient):
"""
Structure holding information about supported texture formats.
"""
@overload
def Add(self,theFormat : Image_Format) -> None:
"""
Set if image format is supported or not.
Set if compressed image format is supported or not.
"""
@overload
def Add(self,theFormat : Image_CompressedFormat) -> None: ...
def Clear(self) -> None:
"""
Reset flags.
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def HasCompressed(self) -> bool:
"""
Return TRUE if there are compressed image formats supported.
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
@overload
def IsSupported(self,theFormat : Image_Format) -> bool:
"""
Return TRUE if image format is supported.
Return TRUE if compressed image format is supported.
"""
@overload
def IsSupported(self,theFormat : Image_CompressedFormat) -> bool: ...
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Image_Texture(OCP.Standard.Standard_Transient):
"""
Texture image definition. The image can be stored as path to image file, as file path with the given offset and as a data buffer of encoded image.
"""
def DataBuffer(self) -> OCP.NCollection.NCollection_Buffer:
"""
Return buffer holding encoded image content.
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DumpJson(self,theOStream : io.BytesIO,theDepth : int=-1) -> None:
"""
Dumps the content of me into the stream
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def FileLength(self) -> int:
"""
Return length of image data within the file after offset.
"""
def FileOffset(self) -> int:
"""
Return offset within file.
"""
def FilePath(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Return image file path.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def MimeType(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Return mime-type of image file based on ProbeImageFileFormat().
"""
def ProbeImageFileFormat(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Return image file format.
"""
def ReadCompressedImage(self,theSupported : Image_SupportedFormats) -> Image_CompressedPixMap:
"""
Image reader without decoding data for formats supported natively by GPUs.
"""
def ReadImage(self,theSupported : Image_SupportedFormats) -> Image_PixMap:
"""
Image reader.
"""
def TextureId(self) -> OCP.TCollection.TCollection_AsciiString:
"""
Return generated texture id.
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
@overload
def WriteImage(self,theFile : OCP.TCollection.TCollection_AsciiString) -> bool:
"""
Write image to specified file without decoding data.
Write image to specified stream without decoding data.
"""
@overload
def WriteImage(self,theStream : io.BytesIO,theFile : OCP.TCollection.TCollection_AsciiString) -> bool: ...
@overload
def __init__(self,theBuffer : OCP.NCollection.NCollection_Buffer,theId : OCP.TCollection.TCollection_AsciiString) -> None: ...
@overload
def __init__(self,theFileName : OCP.TCollection.TCollection_AsciiString) -> None: ...
@overload
def __init__(self,theFileName : OCP.TCollection.TCollection_AsciiString,theOffset : int,theLength : int) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
class Image_VideoParams():
"""
Auxiliary structure defining video parameters. Please refer to FFmpeg documentation for defining text values.
"""
@overload
def SetFramerate(self,theNumerator : int,theDenominator : int) -> None:
"""
Setup playback FPS.
Setup playback FPS. For fixed-fps content, timebase should be 1/framerate and timestamp increments should be identical to 1.
"""
@overload
def SetFramerate(self,theValue : int) -> None: ...
def __init__(self) -> None: ...
@property
def Format(self) -> OCP.TCollection.TCollection_AsciiString:
"""
:type: OCP.TCollection.TCollection_AsciiString
"""
@Format.setter
def Format(self, arg0: OCP.TCollection.TCollection_AsciiString) -> None:
pass
@property
def FpsDen(self) -> int:
"""
:type: int
"""
@FpsDen.setter
def FpsDen(self, arg0: int) -> None:
pass
@property
def FpsNum(self) -> int:
"""
:type: int
"""
@FpsNum.setter
def FpsNum(self, arg0: int) -> None:
pass
@property
def Height(self) -> int:
"""
:type: int
"""
@Height.setter
def Height(self, arg0: int) -> None:
pass
@property
def PixelFormat(self) -> OCP.TCollection.TCollection_AsciiString:
"""
:type: OCP.TCollection.TCollection_AsciiString
"""
@PixelFormat.setter
def PixelFormat(self, arg0: OCP.TCollection.TCollection_AsciiString) -> None:
pass
@property
def VideoCodec(self) -> OCP.TCollection.TCollection_AsciiString:
"""
:type: OCP.TCollection.TCollection_AsciiString
"""
@VideoCodec.setter
def VideoCodec(self, arg0: OCP.TCollection.TCollection_AsciiString) -> None:
pass
@property
def VideoCodecParams(self) -> OCP.Resource.Resource_DataMapOfAsciiStringAsciiString:
"""
:type: OCP.Resource.Resource_DataMapOfAsciiStringAsciiString
"""
@VideoCodecParams.setter
def VideoCodecParams(self, arg0: OCP.Resource.Resource_DataMapOfAsciiStringAsciiString) -> None:
pass
@property
def Width(self) -> int:
"""
:type: int
"""
@Width.setter
def Width(self, arg0: int) -> None:
pass
pass
class Image_VideoRecorder(OCP.Standard.Standard_Transient):
"""
Video recording tool based on FFmpeg framework.Video recording tool based on FFmpeg framework.
"""
def ChangeFrame(self) -> Image_PixMap:
"""
Access RGBA frame, should NOT be re-initialized outside. Note that image is expected to have upper-left origin.
"""
def Close(self) -> None:
"""
Close the stream - stop recorder.
"""
def DecrementRefCounter(self) -> int:
"""
Decrements the reference counter of this object; returns the decremented value
"""
def Delete(self) -> None:
"""
Memory deallocator for transient classes
"""
def DynamicType(self) -> OCP.Standard.Standard_Type:
"""
None
"""
def FrameCount(self) -> int:
"""
Return current frame index.
"""
def GetRefCount(self) -> int:
"""
Get the reference counter of this object
"""
def IncrementRefCounter(self) -> None:
"""
Increments the reference counter of this object
"""
@overload
def IsInstance(self,theType : OCP.Standard.Standard_Type) -> bool:
"""
Returns a true value if this is an instance of Type.
Returns a true value if this is an instance of TypeName.
"""
@overload
def IsInstance(self,theTypeName : str) -> bool: ...
@overload
def IsKind(self,theTypeName : str) -> bool:
"""
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
"""
@overload
def IsKind(self,theType : OCP.Standard.Standard_Type) -> bool: ...
def Open(self,theFileName : str,theParams : Image_VideoParams) -> bool:
"""
Open output stream - initialize recorder.
"""
def PushFrame(self) -> bool:
"""
Push new frame, should be called after Open().
"""
def This(self) -> OCP.Standard.Standard_Transient:
"""
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
"""
def __init__(self) -> None: ...
@staticmethod
def get_type_descriptor_s() -> OCP.Standard.Standard_Type:
"""
None
"""
@staticmethod
def get_type_name_s() -> str:
"""
None
"""
pass
Image_CompressedFormat_NB = 24
Image_CompressedFormat_RGBA_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT1: 21>
Image_CompressedFormat_RGBA_S3TC_DXT3: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT3: 22>
Image_CompressedFormat_RGBA_S3TC_DXT5: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGBA_S3TC_DXT5: 23>
Image_CompressedFormat_RGB_S3TC_DXT1: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_RGB_S3TC_DXT1: 20>
Image_CompressedFormat_UNKNOWN: OCP.Image.Image_CompressedFormat # value = <Image_CompressedFormat.Image_CompressedFormat_UNKNOWN: 0>
Image_Format_Alpha: OCP.Image.Image_Format # value = <Image_Format.Image_Format_Alpha: 2>
Image_Format_AlphaF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_AlphaF: 10>
Image_Format_BGR: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGR: 4>
Image_Format_BGR32: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGR32: 6>
Image_Format_BGRA: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGRA: 8>
Image_Format_BGRAF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGRAF: 15>
Image_Format_BGRF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_BGRF: 13>
Image_Format_Gray: OCP.Image.Image_Format # value = <Image_Format.Image_Format_Gray: 1>
Image_Format_Gray16: OCP.Image.Image_Format # value = <Image_Format.Image_Format_Gray16: 19>
Image_Format_GrayF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_GrayF: 9>
Image_Format_GrayF_half: OCP.Image.Image_Format # value = <Image_Format.Image_Format_GrayF_half: 16>
Image_Format_NB = 20
Image_Format_RGB: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGB: 3>
Image_Format_RGB32: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGB32: 5>
Image_Format_RGBA: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBA: 7>
Image_Format_RGBAF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBAF: 14>
Image_Format_RGBAF_half: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBAF_half: 18>
Image_Format_RGBF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGBF: 12>
Image_Format_RGF: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGF: 11>
Image_Format_RGF_half: OCP.Image.Image_Format # value = <Image_Format.Image_Format_RGF_half: 17>
Image_Format_UNKNOWN: OCP.Image.Image_Format # value = <Image_Format.Image_Format_UNKNOWN: 0>
|