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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
#![allow(deprecated)]
use crate::{
Accessible, AccessibleRole, Align, Buildable, ConstraintTarget, LayoutManager, Overflow, Widget,
};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem, mem::transmute};
glib::wrapper! {
/// [`GLArea`][crate::GLArea] is a widget that allows drawing with OpenGL.
///
/// 
///
/// [`GLArea`][crate::GLArea] sets up its own [`gdk::GLContext`][crate::gdk::GLContext], and creates a custom
/// GL framebuffer that the widget will do GL rendering onto. It also ensures
/// that this framebuffer is the default GL rendering target when rendering.
///
/// In order to draw, you have to connect to the [`render`][struct@crate::GLArea#render]
/// signal, or subclass [`GLArea`][crate::GLArea] and override the GtkGLAreaClass.render
/// virtual function.
///
/// The [`GLArea`][crate::GLArea] widget ensures that the [`gdk::GLContext`][crate::gdk::GLContext] is associated with
/// the widget's drawing area, and it is kept updated when the size and
/// position of the drawing area changes.
///
/// ## Drawing with GtkGLArea
///
/// The simplest way to draw using OpenGL commands in a [`GLArea`][crate::GLArea] is to
/// create a widget instance and connect to the [`render`][struct@crate::GLArea#render] signal:
///
/// The `render()` function will be called when the [`GLArea`][crate::GLArea] is ready
/// for you to draw its content:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// static gboolean
/// render (GtkGLArea *area, GdkGLContext *context)
/// {
/// // inside this function it's safe to use GL; the given
/// // GdkGLContext has been made current to the drawable
/// // surface used by the `GtkGLArea` and the viewport has
/// // already been set to be the size of the allocation
///
/// // we can start by clearing the buffer
/// glClearColor (0, 0, 0, 0);
/// glClear (GL_COLOR_BUFFER_BIT);
///
/// // draw your object
/// // draw_an_object ();
///
/// // we completed our drawing; the draw commands will be
/// // flushed at the end of the signal emission chain, and
/// // the buffers will be drawn on the window
/// return TRUE;
/// }
///
/// void setup_glarea (void)
/// {
/// // create a GtkGLArea instance
/// GtkWidget *gl_area = gtk_gl_area_new ();
///
/// // connect to the "render" signal
/// g_signal_connect (gl_area, "render", G_CALLBACK (render), NULL);
/// }
/// ```
///
/// If you need to initialize OpenGL state, e.g. buffer objects or
/// shaders, you should use the [`realize`][struct@crate::Widget#realize] signal;
/// you can use the [`unrealize`][struct@crate::Widget#unrealize] signal to clean up.
/// Since the [`gdk::GLContext`][crate::gdk::GLContext] creation and initialization may fail, you
/// will need to check for errors, using [`GLAreaExt::error()`][crate::prelude::GLAreaExt::error()].
///
/// An example of how to safely initialize the GL state is:
///
/// **⚠️ The following code is in c ⚠️**
///
/// ```c
/// static void
/// on_realize (GtkGLarea *area)
/// {
/// // We need to make the context current if we want to
/// // call GL API
/// gtk_gl_area_make_current (area);
///
/// // If there were errors during the initialization or
/// // when trying to make the context current, this
/// // function will return a GError for you to catch
/// if (gtk_gl_area_get_error (area) != NULL)
/// return;
///
/// // You can also use gtk_gl_area_set_error() in order
/// // to show eventual initialization errors on the
/// // GtkGLArea widget itself
/// GError *internal_error = NULL;
/// init_buffer_objects (&error);
/// if (error != NULL)
/// {
/// gtk_gl_area_set_error (area, error);
/// g_error_free (error);
/// return;
/// }
///
/// init_shaders (&error);
/// if (error != NULL)
/// {
/// gtk_gl_area_set_error (area, error);
/// g_error_free (error);
/// return;
/// }
/// }
/// ```
///
/// If you need to change the options for creating the [`gdk::GLContext`][crate::gdk::GLContext]
/// you should use the [`create-context`][struct@crate::GLArea#create-context] signal.
///
/// ## Properties
///
///
/// #### `allowed-apis`
/// The allowed APIs.
///
/// Readable | Writeable
///
///
/// #### `api`
/// The API currently in use.
///
/// Readable
///
///
/// #### `auto-render`
/// If set to [`true`] the ::render signal will be emitted every time
/// the widget draws.
///
/// This is the default and is useful if drawing the widget is faster.
///
/// If set to [`false`] the data from previous rendering is kept around and will
/// be used for drawing the widget the next time, unless the window is resized.
/// In order to force a rendering [`GLAreaExt::queue_render()`][crate::prelude::GLAreaExt::queue_render()] must be called.
/// This mode is useful when the scene changes seldom, but takes a long time
/// to redraw.
///
/// Readable | Writeable
///
///
/// #### `context`
/// The [`gdk::GLContext`][crate::gdk::GLContext] used by the [`GLArea`][crate::GLArea] widget.
///
/// The [`GLArea`][crate::GLArea] widget is responsible for creating the [`gdk::GLContext`][crate::gdk::GLContext]
/// instance. If you need to render with other kinds of buffers (stencil,
/// depth, etc), use render buffers.
///
/// Readable
///
///
/// #### `has-depth-buffer`
/// If set to [`true`] the widget will allocate and enable a depth buffer for the
/// target framebuffer.
///
/// Setting this property will enable GL's depth testing as a side effect. If
/// you don't need depth testing, you should call `glDisable(GL_DEPTH_TEST)`
/// in your `GtkGLArea::render` handler.
///
/// Readable | Writeable
///
///
/// #### `has-stencil-buffer`
/// If set to [`true`] the widget will allocate and enable a stencil buffer for the
/// target framebuffer.
///
/// Readable | Writeable
///
///
/// #### `use-es`
/// If set to [`true`] the widget will try to create a [`gdk::GLContext`][crate::gdk::GLContext] using
/// OpenGL ES instead of OpenGL.
///
/// Readable | Writeable
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `can-focus`
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `can-target`
/// Whether the widget can receive pointer events.
///
/// Readable | Writeable
///
///
/// #### `css-classes`
/// A list of css classes applied to this widget.
///
/// Readable | Writeable
///
///
/// #### `css-name`
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `cursor`
/// The cursor used by @widget.
///
/// Readable | Writeable
///
///
/// #### `focus-on-click`
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
///
/// Readable | Writeable
///
///
/// #### `focusable`
/// Whether this widget itself will accept the input focus.
///
/// Readable | Writeable
///
///
/// #### `halign`
/// How to distribute horizontal space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `has-default`
/// Whether the widget is the default widget.
///
/// Readable
///
///
/// #### `has-focus`
/// Whether the widget has the input focus.
///
/// Readable
///
///
/// #### `has-tooltip`
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
///
/// Readable | Writeable
///
///
/// #### `height-request`
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
///
///
/// #### `hexpand`
/// Whether to expand horizontally.
///
/// Readable | Writeable
///
///
/// #### `hexpand-set`
/// Whether to use the `hexpand` property.
///
/// Readable | Writeable
///
///
/// #### `layout-manager`
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `margin-bottom`
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-end`
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-start`
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-top`
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `name`
/// The name of the widget.
///
/// Readable | Writeable
///
///
/// #### `opacity`
/// The requested opacity of the widget.
///
/// Readable | Writeable
///
///
/// #### `overflow`
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `parent`
/// The parent widget of this widget.
///
/// Readable
///
///
/// #### `receives-default`
/// Whether the widget will receive the default action when it is focused.
///
/// Readable | Writeable
///
///
/// #### `root`
/// The [`Root`][crate::Root] widget of the widget tree containing this widget.
///
/// This will be [`None`] if the widget is not contained in a root widget.
///
/// Readable
///
///
/// #### `scale-factor`
/// The scale factor of the widget.
///
/// Readable
///
///
/// #### `sensitive`
/// Whether the widget responds to input.
///
/// Readable | Writeable
///
///
/// #### `tooltip-markup`
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `tooltip-text`
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `valign`
/// How to distribute vertical space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `vexpand`
/// Whether to expand vertically.
///
/// Readable | Writeable
///
///
/// #### `vexpand-set`
/// Whether to use the `vexpand` property.
///
/// Readable | Writeable
///
///
/// #### `visible`
/// Whether the widget is visible.
///
/// Readable | Writeable
///
///
/// #### `width-request`
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Accessible</h4></summary>
///
///
/// #### `accessible-role`
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
///
/// Readable | Writeable
/// </details>
///
/// ## Signals
///
///
/// #### `create-context`
/// Emitted when the widget is being realized.
///
/// This allows you to override how the GL context is created.
/// This is useful when you want to reuse an existing GL context,
/// or if you want to try creating different kinds of GL options.
///
/// If context creation fails then the signal handler can use
/// [`GLAreaExt::set_error()`][crate::prelude::GLAreaExt::set_error()] to register a more detailed error
/// of how the construction failed.
///
///
///
///
/// #### `render`
/// Emitted every time the contents of the [`GLArea`][crate::GLArea] should be redrawn.
///
/// The @context is bound to the @area prior to emitting this function,
/// and the buffers are painted to the window once the emission terminates.
///
///
///
///
/// #### `resize`
/// Emitted once when the widget is realized, and then each time the widget
/// is changed while realized.
///
/// This is useful in order to keep GL state up to date with the widget size,
/// like for instance camera properties which may depend on the width/height
/// ratio.
///
/// The GL context for the area is guaranteed to be current when this signal
/// is emitted.
///
/// The default handler sets up the GL viewport.
///
///
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `destroy`
/// Signals that all holders of a reference to the widget should release
/// the reference that they hold.
///
/// May result in finalization of the widget if all references are released.
///
/// This signal is not suitable for saving widget state.
///
///
///
///
/// #### `direction-changed`
/// Emitted when the text direction of a widget changes.
///
///
///
///
/// #### `hide`
/// Emitted when @widget is hidden.
///
///
///
///
/// #### `keynav-failed`
/// Emitted if keyboard navigation fails.
///
/// See [`WidgetExt::keynav_failed()`][crate::prelude::WidgetExt::keynav_failed()] for details.
///
///
///
///
/// #### `map`
/// Emitted when @widget is going to be mapped.
///
/// A widget is mapped when the widget is visible (which is controlled with
/// [`visible`][struct@crate::Widget#visible]) and all its parents up to the toplevel widget
/// are also visible.
///
/// The ::map signal can be used to determine whether a widget will be drawn,
/// for instance it can resume an animation that was stopped during the
/// emission of [`unmap`][struct@crate::Widget#unmap].
///
///
///
///
/// #### `mnemonic-activate`
/// Emitted when a widget is activated via a mnemonic.
///
/// The default handler for this signal activates @widget if @group_cycling
/// is [`false`], or just makes @widget grab focus if @group_cycling is [`true`].
///
///
///
///
/// #### `move-focus`
/// Emitted when the focus is moved.
///
/// The ::move-focus signal is a [keybinding signal](class.SignalAction.html).
///
/// The default bindings for this signal are <kbd>Tab</kbd> to move forward,
/// and <kbd>Shift</kbd>+<kbd>Tab</kbd> to move backward.
///
/// Action
///
///
/// #### `query-tooltip`
/// Emitted when the widgets tooltip is about to be shown.
///
/// This happens when the [`has-tooltip`][struct@crate::Widget#has-tooltip] property
/// is [`true`] and the hover timeout has expired with the cursor hovering
/// "above" @widget; or emitted when @widget got focus in keyboard mode.
///
/// Using the given coordinates, the signal handler should determine
/// whether a tooltip should be shown for @widget. If this is the case
/// [`true`] should be returned, [`false`] otherwise. Note that if
/// @keyboard_mode is [`true`], the values of @x and @y are undefined and
/// should not be used.
///
/// The signal handler is free to manipulate @tooltip with the therefore
/// destined function calls.
///
///
///
///
/// #### `realize`
/// Emitted when @widget is associated with a [`gdk::Surface`][crate::gdk::Surface].
///
/// This means that [`WidgetExt::realize()`][crate::prelude::WidgetExt::realize()] has been called
/// or the widget has been mapped (that is, it is going to be drawn).
///
///
///
///
/// #### `show`
/// Emitted when @widget is shown.
///
///
///
///
/// #### `state-flags-changed`
/// Emitted when the widget state changes.
///
/// See [`WidgetExt::state_flags()`][crate::prelude::WidgetExt::state_flags()].
///
///
///
///
/// #### `unmap`
/// Emitted when @widget is going to be unmapped.
///
/// A widget is unmapped when either it or any of its parents up to the
/// toplevel widget have been set as hidden.
///
/// As ::unmap indicates that a widget will not be shown any longer,
/// it can be used to, for example, stop an animation on the widget.
///
///
///
///
/// #### `unrealize`
/// Emitted when the [`gdk::Surface`][crate::gdk::Surface] associated with @widget is destroyed.
///
/// This means that [`WidgetExt::unrealize()`][crate::prelude::WidgetExt::unrealize()] has been called
/// or the widget has been unmapped (that is, it is going to be hidden).
///
///
/// </details>
///
/// # Implements
///
/// [`GLAreaExt`][trait@crate::prelude::GLAreaExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
#[doc(alias = "GtkGLArea")]
pub struct GLArea(Object<ffi::GtkGLArea, ffi::GtkGLAreaClass>) @extends Widget, @implements Accessible, Buildable, ConstraintTarget;
match fn {
type_ => || ffi::gtk_gl_area_get_type(),
}
}
impl GLArea {
pub const NONE: Option<&'static GLArea> = None;
/// Creates a new [`GLArea`][crate::GLArea] widget.
///
/// # Returns
///
/// a new [`GLArea`][crate::GLArea]
#[doc(alias = "gtk_gl_area_new")]
pub fn new() -> GLArea {
assert_initialized_main_thread!();
unsafe { Widget::from_glib_none(ffi::gtk_gl_area_new()).unsafe_cast() }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`GLArea`] objects.
///
/// This method returns an instance of [`GLAreaBuilder`](crate::builders::GLAreaBuilder) which can be used to create [`GLArea`] objects.
pub fn builder() -> GLAreaBuilder {
GLAreaBuilder::new()
}
}
impl Default for GLArea {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`GLArea`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct GLAreaBuilder {
builder: glib::object::ObjectBuilder<'static, GLArea>,
}
impl GLAreaBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The allowed APIs.
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
pub fn allowed_apis(self, allowed_apis: gdk::GLAPI) -> Self {
Self {
builder: self.builder.property("allowed-apis", allowed_apis),
}
}
/// If set to [`true`] the ::render signal will be emitted every time
/// the widget draws.
///
/// This is the default and is useful if drawing the widget is faster.
///
/// If set to [`false`] the data from previous rendering is kept around and will
/// be used for drawing the widget the next time, unless the window is resized.
/// In order to force a rendering [`GLAreaExt::queue_render()`][crate::prelude::GLAreaExt::queue_render()] must be called.
/// This mode is useful when the scene changes seldom, but takes a long time
/// to redraw.
pub fn auto_render(self, auto_render: bool) -> Self {
Self {
builder: self.builder.property("auto-render", auto_render),
}
}
/// If set to [`true`] the widget will allocate and enable a depth buffer for the
/// target framebuffer.
///
/// Setting this property will enable GL's depth testing as a side effect. If
/// you don't need depth testing, you should call `glDisable(GL_DEPTH_TEST)`
/// in your `GtkGLArea::render` handler.
pub fn has_depth_buffer(self, has_depth_buffer: bool) -> Self {
Self {
builder: self.builder.property("has-depth-buffer", has_depth_buffer),
}
}
/// If set to [`true`] the widget will allocate and enable a stencil buffer for the
/// target framebuffer.
pub fn has_stencil_buffer(self, has_stencil_buffer: bool) -> Self {
Self {
builder: self
.builder
.property("has-stencil-buffer", has_stencil_buffer),
}
}
/// If set to [`true`] the widget will try to create a [`gdk::GLContext`][crate::gdk::GLContext] using
/// OpenGL ES instead of OpenGL.
/// Use [`allowed-apis`][struct@crate::GLArea#allowed-apis]
#[cfg_attr(feature = "v4_12", deprecated = "Since 4.12")]
pub fn use_es(self, use_es: bool) -> Self {
Self {
builder: self.builder.property("use-es", use_es),
}
}
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn can_focus(self, can_focus: bool) -> Self {
Self {
builder: self.builder.property("can-focus", can_focus),
}
}
/// Whether the widget can receive pointer events.
pub fn can_target(self, can_target: bool) -> Self {
Self {
builder: self.builder.property("can-target", can_target),
}
}
/// A list of css classes applied to this widget.
pub fn css_classes(self, css_classes: impl Into<glib::StrV>) -> Self {
Self {
builder: self.builder.property("css-classes", css_classes.into()),
}
}
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn css_name(self, css_name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("css-name", css_name.into()),
}
}
/// The cursor used by @widget.
pub fn cursor(self, cursor: &gdk::Cursor) -> Self {
Self {
builder: self.builder.property("cursor", cursor.clone()),
}
}
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
pub fn focus_on_click(self, focus_on_click: bool) -> Self {
Self {
builder: self.builder.property("focus-on-click", focus_on_click),
}
}
/// Whether this widget itself will accept the input focus.
pub fn focusable(self, focusable: bool) -> Self {
Self {
builder: self.builder.property("focusable", focusable),
}
}
/// How to distribute horizontal space if widget gets extra space.
pub fn halign(self, halign: Align) -> Self {
Self {
builder: self.builder.property("halign", halign),
}
}
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
pub fn has_tooltip(self, has_tooltip: bool) -> Self {
Self {
builder: self.builder.property("has-tooltip", has_tooltip),
}
}
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn height_request(self, height_request: i32) -> Self {
Self {
builder: self.builder.property("height-request", height_request),
}
}
/// Whether to expand horizontally.
pub fn hexpand(self, hexpand: bool) -> Self {
Self {
builder: self.builder.property("hexpand", hexpand),
}
}
/// Whether to use the `hexpand` property.
pub fn hexpand_set(self, hexpand_set: bool) -> Self {
Self {
builder: self.builder.property("hexpand-set", hexpand_set),
}
}
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self {
Self {
builder: self
.builder
.property("layout-manager", layout_manager.clone().upcast()),
}
}
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_bottom(self, margin_bottom: i32) -> Self {
Self {
builder: self.builder.property("margin-bottom", margin_bottom),
}
}
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_end(self, margin_end: i32) -> Self {
Self {
builder: self.builder.property("margin-end", margin_end),
}
}
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_start(self, margin_start: i32) -> Self {
Self {
builder: self.builder.property("margin-start", margin_start),
}
}
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
pub fn margin_top(self, margin_top: i32) -> Self {
Self {
builder: self.builder.property("margin-top", margin_top),
}
}
/// The name of the widget.
pub fn name(self, name: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("name", name.into()),
}
}
/// The requested opacity of the widget.
pub fn opacity(self, opacity: f64) -> Self {
Self {
builder: self.builder.property("opacity", opacity),
}
}
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
pub fn overflow(self, overflow: Overflow) -> Self {
Self {
builder: self.builder.property("overflow", overflow),
}
}
/// Whether the widget will receive the default action when it is focused.
pub fn receives_default(self, receives_default: bool) -> Self {
Self {
builder: self.builder.property("receives-default", receives_default),
}
}
/// Whether the widget responds to input.
pub fn sensitive(self, sensitive: bool) -> Self {
Self {
builder: self.builder.property("sensitive", sensitive),
}
}
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
Self {
builder: self
.builder
.property("tooltip-markup", tooltip_markup.into()),
}
}
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("tooltip-text", tooltip_text.into()),
}
}
/// How to distribute vertical space if widget gets extra space.
pub fn valign(self, valign: Align) -> Self {
Self {
builder: self.builder.property("valign", valign),
}
}
/// Whether to expand vertically.
pub fn vexpand(self, vexpand: bool) -> Self {
Self {
builder: self.builder.property("vexpand", vexpand),
}
}
/// Whether to use the `vexpand` property.
pub fn vexpand_set(self, vexpand_set: bool) -> Self {
Self {
builder: self.builder.property("vexpand-set", vexpand_set),
}
}
/// Whether the widget is visible.
pub fn visible(self, visible: bool) -> Self {
Self {
builder: self.builder.property("visible", visible),
}
}
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
pub fn width_request(self, width_request: i32) -> Self {
Self {
builder: self.builder.property("width-request", width_request),
}
}
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self {
Self {
builder: self.builder.property("accessible-role", accessible_role),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`GLArea`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> GLArea {
self.builder.build()
}
}
/// Trait containing all [`struct@GLArea`] methods.
///
/// # Implementors
///
/// [`GLArea`][struct@crate::GLArea]
pub trait GLAreaExt: IsA<GLArea> + 'static {
/// Binds buffers to the framebuffer.
///
/// Ensures that the @self framebuffer object is made the current draw
/// and read target, and that all the required buffers for the @self
/// are created and bound to the framebuffer.
///
/// This function is automatically called before emitting the
/// [`render`][struct@crate::GLArea#render] signal, and doesn't normally need to be
/// called by application code.
#[doc(alias = "gtk_gl_area_attach_buffers")]
fn attach_buffers(&self) {
unsafe {
ffi::gtk_gl_area_attach_buffers(self.as_ref().to_glib_none().0);
}
}
/// Gets the allowed APIs.
///
/// See [`set_allowed_apis()`][Self::set_allowed_apis()].
///
/// # Returns
///
/// the allowed APIs
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "gtk_gl_area_get_allowed_apis")]
#[doc(alias = "get_allowed_apis")]
fn allowed_apis(&self) -> gdk::GLAPI {
unsafe {
from_glib(ffi::gtk_gl_area_get_allowed_apis(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the API that is currently in use.
///
/// If the GL area has not been realized yet, 0 is returned.
///
/// # Returns
///
/// the currently used API
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "gtk_gl_area_get_api")]
#[doc(alias = "get_api")]
fn api(&self) -> gdk::GLAPI {
unsafe { from_glib(ffi::gtk_gl_area_get_api(self.as_ref().to_glib_none().0)) }
}
/// Returns whether the area is in auto render mode or not.
///
/// # Returns
///
/// [`true`] if the @self is auto rendering, [`false`] otherwise
#[doc(alias = "gtk_gl_area_get_auto_render")]
#[doc(alias = "get_auto_render")]
fn is_auto_render(&self) -> bool {
unsafe {
from_glib(ffi::gtk_gl_area_get_auto_render(
self.as_ref().to_glib_none().0,
))
}
}
/// Retrieves the [`gdk::GLContext`][crate::gdk::GLContext] used by @self.
///
/// # Returns
///
/// the [`gdk::GLContext`][crate::gdk::GLContext]
#[doc(alias = "gtk_gl_area_get_context")]
#[doc(alias = "get_context")]
fn context(&self) -> Option<gdk::GLContext> {
unsafe { from_glib_none(ffi::gtk_gl_area_get_context(self.as_ref().to_glib_none().0)) }
}
/// Gets the current error set on the @self.
///
/// # Returns
///
/// the `GError`
#[doc(alias = "gtk_gl_area_get_error")]
#[doc(alias = "get_error")]
fn error(&self) -> Option<glib::Error> {
unsafe { from_glib_none(ffi::gtk_gl_area_get_error(self.as_ref().to_glib_none().0)) }
}
/// Returns whether the area has a depth buffer.
///
/// # Returns
///
/// [`true`] if the @self has a depth buffer, [`false`] otherwise
#[doc(alias = "gtk_gl_area_get_has_depth_buffer")]
#[doc(alias = "get_has_depth_buffer")]
fn has_depth_buffer(&self) -> bool {
unsafe {
from_glib(ffi::gtk_gl_area_get_has_depth_buffer(
self.as_ref().to_glib_none().0,
))
}
}
/// Returns whether the area has a stencil buffer.
///
/// # Returns
///
/// [`true`] if the @self has a stencil buffer, [`false`] otherwise
#[doc(alias = "gtk_gl_area_get_has_stencil_buffer")]
#[doc(alias = "get_has_stencil_buffer")]
fn has_stencil_buffer(&self) -> bool {
unsafe {
from_glib(ffi::gtk_gl_area_get_has_stencil_buffer(
self.as_ref().to_glib_none().0,
))
}
}
/// Retrieves the required version of OpenGL.
///
/// See [`set_required_version()`][Self::set_required_version()].
///
/// # Returns
///
///
/// ## `major`
/// return location for the required major version
///
/// ## `minor`
/// return location for the required minor version
#[doc(alias = "gtk_gl_area_get_required_version")]
#[doc(alias = "get_required_version")]
fn required_version(&self) -> (i32, i32) {
unsafe {
let mut major = mem::MaybeUninit::uninit();
let mut minor = mem::MaybeUninit::uninit();
ffi::gtk_gl_area_get_required_version(
self.as_ref().to_glib_none().0,
major.as_mut_ptr(),
minor.as_mut_ptr(),
);
(major.assume_init(), minor.assume_init())
}
}
/// Returns whether the [`GLArea`][crate::GLArea] should use OpenGL ES.
///
/// See [`set_use_es()`][Self::set_use_es()].
///
/// # Deprecated since 4.12
///
/// Use [`api()`][Self::api()]
///
/// # Returns
///
/// [`true`] if the [`GLArea`][crate::GLArea] should create an OpenGL ES context
/// and [`false`] otherwise
#[cfg_attr(feature = "v4_12", deprecated = "Since 4.12")]
#[allow(deprecated)]
#[doc(alias = "gtk_gl_area_get_use_es")]
#[doc(alias = "get_use_es")]
fn uses_es(&self) -> bool {
unsafe { from_glib(ffi::gtk_gl_area_get_use_es(self.as_ref().to_glib_none().0)) }
}
/// Ensures that the [`gdk::GLContext`][crate::gdk::GLContext] used by @self is associated with
/// the [`GLArea`][crate::GLArea].
///
/// This function is automatically called before emitting the
/// [`render`][struct@crate::GLArea#render] signal, and doesn't normally need
/// to be called by application code.
#[doc(alias = "gtk_gl_area_make_current")]
fn make_current(&self) {
unsafe {
ffi::gtk_gl_area_make_current(self.as_ref().to_glib_none().0);
}
}
/// Marks the currently rendered data (if any) as invalid, and queues
/// a redraw of the widget.
///
/// This ensures that the [`render`][struct@crate::GLArea#render] signal
/// is emitted during the draw.
///
/// This is only needed when [`set_auto_render()`][Self::set_auto_render()] has
/// been called with a [`false`] value. The default behaviour is to
/// emit [`render`][struct@crate::GLArea#render] on each draw.
#[doc(alias = "gtk_gl_area_queue_render")]
fn queue_render(&self) {
unsafe {
ffi::gtk_gl_area_queue_render(self.as_ref().to_glib_none().0);
}
}
/// Sets the allowed APIs to create a context with.
///
/// You should check [`api`][struct@crate::GLArea#api] before drawing
/// with either API.
///
/// By default, all APIs are allowed.
/// ## `apis`
/// the allowed APIs
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "gtk_gl_area_set_allowed_apis")]
fn set_allowed_apis(&self, apis: gdk::GLAPI) {
unsafe {
ffi::gtk_gl_area_set_allowed_apis(self.as_ref().to_glib_none().0, apis.into_glib());
}
}
/// Sets whether the [`GLArea`][crate::GLArea] is in auto render mode.
///
/// If @auto_render is [`true`] the [`render`][struct@crate::GLArea#render] signal will
/// be emitted every time the widget draws. This is the default and is
/// useful if drawing the widget is faster.
///
/// If @auto_render is [`false`] the data from previous rendering is kept
/// around and will be used for drawing the widget the next time,
/// unless the window is resized. In order to force a rendering
/// [`queue_render()`][Self::queue_render()] must be called. This mode is
/// useful when the scene changes seldom, but takes a long time to redraw.
/// ## `auto_render`
/// a boolean
#[doc(alias = "gtk_gl_area_set_auto_render")]
fn set_auto_render(&self, auto_render: bool) {
unsafe {
ffi::gtk_gl_area_set_auto_render(
self.as_ref().to_glib_none().0,
auto_render.into_glib(),
);
}
}
/// Sets an error on the area which will be shown instead of the
/// GL rendering.
///
/// This is useful in the [`create-context`][struct@crate::GLArea#create-context]
/// signal if GL context creation fails.
/// ## `error`
/// a new `GError`, or [`None`] to unset the error
#[doc(alias = "gtk_gl_area_set_error")]
fn set_error(&self, error: Option<&glib::Error>) {
unsafe {
ffi::gtk_gl_area_set_error(self.as_ref().to_glib_none().0, error.to_glib_none().0);
}
}
/// Sets whether the [`GLArea`][crate::GLArea] should use a depth buffer.
///
/// If @has_depth_buffer is [`true`] the widget will allocate and
/// enable a depth buffer for the target framebuffer. Otherwise
/// there will be none.
/// ## `has_depth_buffer`
/// [`true`] to add a depth buffer
#[doc(alias = "gtk_gl_area_set_has_depth_buffer")]
fn set_has_depth_buffer(&self, has_depth_buffer: bool) {
unsafe {
ffi::gtk_gl_area_set_has_depth_buffer(
self.as_ref().to_glib_none().0,
has_depth_buffer.into_glib(),
);
}
}
/// Sets whether the [`GLArea`][crate::GLArea] should use a stencil buffer.
///
/// If @has_stencil_buffer is [`true`] the widget will allocate and
/// enable a stencil buffer for the target framebuffer. Otherwise
/// there will be none.
/// ## `has_stencil_buffer`
/// [`true`] to add a stencil buffer
#[doc(alias = "gtk_gl_area_set_has_stencil_buffer")]
fn set_has_stencil_buffer(&self, has_stencil_buffer: bool) {
unsafe {
ffi::gtk_gl_area_set_has_stencil_buffer(
self.as_ref().to_glib_none().0,
has_stencil_buffer.into_glib(),
);
}
}
/// Sets the required version of OpenGL to be used when creating
/// the context for the widget.
///
/// This function must be called before the area has been realized.
/// ## `major`
/// the major version
/// ## `minor`
/// the minor version
#[doc(alias = "gtk_gl_area_set_required_version")]
fn set_required_version(&self, major: i32, minor: i32) {
unsafe {
ffi::gtk_gl_area_set_required_version(self.as_ref().to_glib_none().0, major, minor);
}
}
/// Sets whether the @self should create an OpenGL or an OpenGL ES context.
///
/// You should check the capabilities of the [`gdk::GLContext`][crate::gdk::GLContext] before drawing
/// with either API.
///
/// # Deprecated since 4.12
///
/// Use [`set_allowed_apis()`][Self::set_allowed_apis()]
/// ## `use_es`
/// whether to use OpenGL or OpenGL ES
#[cfg_attr(feature = "v4_12", deprecated = "Since 4.12")]
#[allow(deprecated)]
#[doc(alias = "gtk_gl_area_set_use_es")]
fn set_use_es(&self, use_es: bool) {
unsafe {
ffi::gtk_gl_area_set_use_es(self.as_ref().to_glib_none().0, use_es.into_glib());
}
}
/// Emitted when the widget is being realized.
///
/// This allows you to override how the GL context is created.
/// This is useful when you want to reuse an existing GL context,
/// or if you want to try creating different kinds of GL options.
///
/// If context creation fails then the signal handler can use
/// [`set_error()`][Self::set_error()] to register a more detailed error
/// of how the construction failed.
///
/// # Returns
///
/// a newly created [`gdk::GLContext`][crate::gdk::GLContext];
/// the [`GLArea`][crate::GLArea] widget will take ownership of the returned value.
#[doc(alias = "create-context")]
fn connect_create_context<F: Fn(&Self) -> Option<gdk::GLContext> + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn create_context_trampoline<
P: IsA<GLArea>,
F: Fn(&P) -> Option<gdk::GLContext> + 'static,
>(
this: *mut ffi::GtkGLArea,
f: glib::ffi::gpointer,
) -> *mut gdk::ffi::GdkGLContext {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref()).to_glib_full()
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"create-context\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
create_context_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Emitted every time the contents of the [`GLArea`][crate::GLArea] should be redrawn.
///
/// The @context is bound to the @area prior to emitting this function,
/// and the buffers are painted to the window once the emission terminates.
/// ## `context`
/// the [`gdk::GLContext`][crate::gdk::GLContext] used by @area
///
/// # Returns
///
/// [`true`] to stop other handlers from being invoked for the event.
/// [`false`] to propagate the event further.
#[doc(alias = "render")]
fn connect_render<F: Fn(&Self, &gdk::GLContext) -> glib::signal::Inhibit + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn render_trampoline<
P: IsA<GLArea>,
F: Fn(&P, &gdk::GLContext) -> glib::signal::Inhibit + 'static,
>(
this: *mut ffi::GtkGLArea,
context: *mut gdk::ffi::GdkGLContext,
f: glib::ffi::gpointer,
) -> glib::ffi::gboolean {
let f: &F = &*(f as *const F);
f(
GLArea::from_glib_borrow(this).unsafe_cast_ref(),
&from_glib_borrow(context),
)
.into_glib()
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"render\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
render_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
/// Emitted once when the widget is realized, and then each time the widget
/// is changed while realized.
///
/// This is useful in order to keep GL state up to date with the widget size,
/// like for instance camera properties which may depend on the width/height
/// ratio.
///
/// The GL context for the area is guaranteed to be current when this signal
/// is emitted.
///
/// The default handler sets up the GL viewport.
/// ## `width`
/// the width of the viewport
/// ## `height`
/// the height of the viewport
#[doc(alias = "resize")]
fn connect_resize<F: Fn(&Self, i32, i32) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn resize_trampoline<P: IsA<GLArea>, F: Fn(&P, i32, i32) + 'static>(
this: *mut ffi::GtkGLArea,
width: libc::c_int,
height: libc::c_int,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(
GLArea::from_glib_borrow(this).unsafe_cast_ref(),
width,
height,
)
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"resize\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
resize_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "allowed-apis")]
fn connect_allowed_apis_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_allowed_apis_trampoline<P: IsA<GLArea>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::allowed-apis\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_allowed_apis_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v4_12")]
#[cfg_attr(docsrs, doc(cfg(feature = "v4_12")))]
#[doc(alias = "api")]
fn connect_api_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_api_trampoline<P: IsA<GLArea>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::api\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_api_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "auto-render")]
fn connect_auto_render_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_auto_render_trampoline<P: IsA<GLArea>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::auto-render\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_auto_render_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "context")]
fn connect_context_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_context_trampoline<P: IsA<GLArea>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::context\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_context_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "has-depth-buffer")]
fn connect_has_depth_buffer_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_has_depth_buffer_trampoline<
P: IsA<GLArea>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::has-depth-buffer\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_has_depth_buffer_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "has-stencil-buffer")]
fn connect_has_stencil_buffer_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_has_stencil_buffer_trampoline<
P: IsA<GLArea>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::has-stencil-buffer\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_has_stencil_buffer_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg_attr(feature = "v4_12", deprecated = "Since 4.12")]
#[doc(alias = "use-es")]
fn connect_use_es_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_use_es_trampoline<P: IsA<GLArea>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkGLArea,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(GLArea::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::use-es\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_use_es_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl<O: IsA<GLArea>> GLAreaExt for O {}
impl fmt::Display for GLArea {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("GLArea")
}
}