/usr/share/doc/libjuce/apiref/classOpenGLContext.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: OpenGLContext Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classOpenGLContext-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OpenGLContext Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Creates an OpenGL context, which can be attached to a component.
<a href="classOpenGLContext.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a3a6b8eeed7dbc7c7c649528252c07d02"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02">OpenGLVersion</a> { <a class="el" href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02abfbb3238e2943fa532a03e1473ac1baf">defaultGLVersion</a> = 0,
<a class="el" href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02a360335be2efbcff04897b872de9b8e45">openGL3_2</a>
}<tr class="memdesc:a3a6b8eeed7dbc7c7c649528252c07d02"><td class="mdescLeft"> </td><td class="mdescRight">OpenGL versions, used by <a class="el" href="classOpenGLContext.html#a45a3bcd0cfcf94796ed43113a1866315" title="Sets a preference for the version of GL that this context should use, if possible. ">setOpenGLVersionRequired()</a>. <a href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a3a6b8eeed7dbc7c7c649528252c07d02"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9be23e3642f28848a26cd00669f0b4d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a9be23e3642f28848a26cd00669f0b4d7">OpenGLContext</a> ()</td></tr>
<tr class="separator:a9be23e3642f28848a26cd00669f0b4d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1f6be39c9063b52dcfa60b94a2e5407"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#ac1f6be39c9063b52dcfa60b94a2e5407">~OpenGLContext</a> ()</td></tr>
<tr class="memdesc:ac1f6be39c9063b52dcfa60b94a2e5407"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac1f6be39c9063b52dcfa60b94a2e5407">More...</a><br /></td></tr>
<tr class="separator:ac1f6be39c9063b52dcfa60b94a2e5407"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adbb9e06c8783a85db58f8b666675e577"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#adbb9e06c8783a85db58f8b666675e577">setRenderer</a> (<a class="el" href="classOpenGLRenderer.html">OpenGLRenderer</a> *) noexcept</td></tr>
<tr class="memdesc:adbb9e06c8783a85db58f8b666675e577"><td class="mdescLeft"> </td><td class="mdescRight">Gives the context an <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> to use to do the drawing. <a href="#adbb9e06c8783a85db58f8b666675e577">More...</a><br /></td></tr>
<tr class="separator:adbb9e06c8783a85db58f8b666675e577"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad320cd274bba96c11dc1ea32310ad37c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#ad320cd274bba96c11dc1ea32310ad37c">attachTo</a> (<a class="el" href="classComponent.html">Component</a> &)</td></tr>
<tr class="memdesc:ad320cd274bba96c11dc1ea32310ad37c"><td class="mdescLeft"> </td><td class="mdescRight">Attaches the context to a target component. <a href="#ad320cd274bba96c11dc1ea32310ad37c">More...</a><br /></td></tr>
<tr class="separator:ad320cd274bba96c11dc1ea32310ad37c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7504aa8928c854732090ee9583e9f37d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a7504aa8928c854732090ee9583e9f37d">detach</a> ()</td></tr>
<tr class="memdesc:a7504aa8928c854732090ee9583e9f37d"><td class="mdescLeft"> </td><td class="mdescRight">Detaches the context from its target component and deletes any native resources. <a href="#a7504aa8928c854732090ee9583e9f37d">More...</a><br /></td></tr>
<tr class="separator:a7504aa8928c854732090ee9583e9f37d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2a9392e74c56fd8a0ee45d1a845b0f0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#ac2a9392e74c56fd8a0ee45d1a845b0f0">isAttached</a> () const noexcept</td></tr>
<tr class="memdesc:ac2a9392e74c56fd8a0ee45d1a845b0f0"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the context is attached to a component and is on-screen. <a href="#ac2a9392e74c56fd8a0ee45d1a845b0f0">More...</a><br /></td></tr>
<tr class="separator:ac2a9392e74c56fd8a0ee45d1a845b0f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0079c44b081f30fb0ace2396a95df343"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComponent.html">Component</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a0079c44b081f30fb0ace2396a95df343">getTargetComponent</a> () const noexcept</td></tr>
<tr class="memdesc:a0079c44b081f30fb0ace2396a95df343"><td class="mdescLeft"> </td><td class="mdescRight">Returns the component to which this context is currently attached, or nullptr. <a href="#a0079c44b081f30fb0ace2396a95df343">More...</a><br /></td></tr>
<tr class="separator:a0079c44b081f30fb0ace2396a95df343"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb49920c5ee4e4694fa4cbd1700b2acb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#aeb49920c5ee4e4694fa4cbd1700b2acb">setPixelFormat</a> (const <a class="el" href="classOpenGLPixelFormat.html">OpenGLPixelFormat</a> &preferredPixelFormat) noexcept</td></tr>
<tr class="memdesc:aeb49920c5ee4e4694fa4cbd1700b2acb"><td class="mdescLeft"> </td><td class="mdescRight">Sets the pixel format which you'd like to use for the target GL surface. <a href="#aeb49920c5ee4e4694fa4cbd1700b2acb">More...</a><br /></td></tr>
<tr class="separator:aeb49920c5ee4e4694fa4cbd1700b2acb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0129ecf603a0cc3034e4809a23812e4a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a0129ecf603a0cc3034e4809a23812e4a">setNativeSharedContext</a> (void *nativeContextToShareWith) noexcept</td></tr>
<tr class="memdesc:a0129ecf603a0cc3034e4809a23812e4a"><td class="mdescLeft"> </td><td class="mdescRight">Provides a context with which you'd like this context's resources to be shared. <a href="#a0129ecf603a0cc3034e4809a23812e4a">More...</a><br /></td></tr>
<tr class="separator:a0129ecf603a0cc3034e4809a23812e4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3e6fd6e0d9104a249f029833f6b4172"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#ab3e6fd6e0d9104a249f029833f6b4172">setMultisamplingEnabled</a> (bool) noexcept</td></tr>
<tr class="memdesc:ab3e6fd6e0d9104a249f029833f6b4172"><td class="mdescLeft"> </td><td class="mdescRight">Enables multisampling on platforms where this is implemented. <a href="#ab3e6fd6e0d9104a249f029833f6b4172">More...</a><br /></td></tr>
<tr class="separator:ab3e6fd6e0d9104a249f029833f6b4172"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af33252b1d42af69915c77401f8c0ba31"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#af33252b1d42af69915c77401f8c0ba31">areShadersAvailable</a> () const</td></tr>
<tr class="memdesc:af33252b1d42af69915c77401f8c0ba31"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if shaders can be used in this context. <a href="#af33252b1d42af69915c77401f8c0ba31">More...</a><br /></td></tr>
<tr class="separator:af33252b1d42af69915c77401f8c0ba31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45a3bcd0cfcf94796ed43113a1866315"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a45a3bcd0cfcf94796ed43113a1866315">setOpenGLVersionRequired</a> (<a class="el" href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02">OpenGLVersion</a>) noexcept</td></tr>
<tr class="memdesc:a45a3bcd0cfcf94796ed43113a1866315"><td class="mdescLeft"> </td><td class="mdescRight">Sets a preference for the version of GL that this context should use, if possible. <a href="#a45a3bcd0cfcf94796ed43113a1866315">More...</a><br /></td></tr>
<tr class="separator:a45a3bcd0cfcf94796ed43113a1866315"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa4cf6bbdb662b106cd44c203b8abb1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#aaa4cf6bbdb662b106cd44c203b8abb1a">setComponentPaintingEnabled</a> (bool shouldPaintComponent) noexcept</td></tr>
<tr class="memdesc:aaa4cf6bbdb662b106cd44c203b8abb1a"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables the use of the GL context to perform 2D rendering of the component to which it is attached. <a href="#aaa4cf6bbdb662b106cd44c203b8abb1a">More...</a><br /></td></tr>
<tr class="separator:aaa4cf6bbdb662b106cd44c203b8abb1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c305575ef3337ae64940db3c00abdc6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a7c305575ef3337ae64940db3c00abdc6">setContinuousRepainting</a> (bool shouldContinuouslyRepaint) noexcept</td></tr>
<tr class="memdesc:a7c305575ef3337ae64940db3c00abdc6"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables continuous repainting. <a href="#a7c305575ef3337ae64940db3c00abdc6">More...</a><br /></td></tr>
<tr class="separator:a7c305575ef3337ae64940db3c00abdc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc0fc11c02ebbe4af1cc234eb5d8b84a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#acc0fc11c02ebbe4af1cc234eb5d8b84a">triggerRepaint</a> ()</td></tr>
<tr class="memdesc:acc0fc11c02ebbe4af1cc234eb5d8b84a"><td class="mdescLeft"> </td><td class="mdescRight">Asynchronously causes a repaint to be made. <a href="#acc0fc11c02ebbe4af1cc234eb5d8b84a">More...</a><br /></td></tr>
<tr class="separator:acc0fc11c02ebbe4af1cc234eb5d8b84a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9668038df855f4682c4161cee1f8ce50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a9668038df855f4682c4161cee1f8ce50">getAssociatedObject</a> (const char *name) const</td></tr>
<tr class="memdesc:a9668038df855f4682c4161cee1f8ce50"><td class="mdescLeft"> </td><td class="mdescRight">This retrieves an object that was previously stored with <a class="el" href="classOpenGLContext.html#a51ee6e2d70c172820a4fb26722497892" title="Attaches a named object to the context, which will be deleted when the context is destroyed...">setAssociatedObject()</a>. <a href="#a9668038df855f4682c4161cee1f8ce50">More...</a><br /></td></tr>
<tr class="separator:a9668038df855f4682c4161cee1f8ce50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51ee6e2d70c172820a4fb26722497892"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a51ee6e2d70c172820a4fb26722497892">setAssociatedObject</a> (const char *name, <a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a> *newObject)</td></tr>
<tr class="memdesc:a51ee6e2d70c172820a4fb26722497892"><td class="mdescLeft"> </td><td class="mdescRight">Attaches a named object to the context, which will be deleted when the context is destroyed. <a href="#a51ee6e2d70c172820a4fb26722497892">More...</a><br /></td></tr>
<tr class="separator:a51ee6e2d70c172820a4fb26722497892"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a318c8cc5821b9b2b2a9f726c623385f8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a318c8cc5821b9b2b2a9f726c623385f8">makeActive</a> () const noexcept</td></tr>
<tr class="memdesc:a318c8cc5821b9b2b2a9f726c623385f8"><td class="mdescLeft"> </td><td class="mdescRight">Makes this context the currently active one. <a href="#a318c8cc5821b9b2b2a9f726c623385f8">More...</a><br /></td></tr>
<tr class="separator:a318c8cc5821b9b2b2a9f726c623385f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c5bce957be244229d9293d3303bff40"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a5c5bce957be244229d9293d3303bff40">isActive</a> () const noexcept</td></tr>
<tr class="memdesc:a5c5bce957be244229d9293d3303bff40"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this context is currently active for the calling thread. <a href="#a5c5bce957be244229d9293d3303bff40">More...</a><br /></td></tr>
<tr class="separator:a5c5bce957be244229d9293d3303bff40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a909377fc5880a61d28db1909b8d09e03"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a909377fc5880a61d28db1909b8d09e03">swapBuffers</a> ()</td></tr>
<tr class="memdesc:a909377fc5880a61d28db1909b8d09e03"><td class="mdescLeft"> </td><td class="mdescRight">Swaps the buffers (if the context can do this). <a href="#a909377fc5880a61d28db1909b8d09e03">More...</a><br /></td></tr>
<tr class="separator:a909377fc5880a61d28db1909b8d09e03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a046fe0f0de71000ee940d825d5dc57e0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a046fe0f0de71000ee940d825d5dc57e0">setSwapInterval</a> (int numFramesPerSwap)</td></tr>
<tr class="memdesc:a046fe0f0de71000ee940d825d5dc57e0"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the context checks the vertical sync before swapping. <a href="#a046fe0f0de71000ee940d825d5dc57e0">More...</a><br /></td></tr>
<tr class="separator:a046fe0f0de71000ee940d825d5dc57e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91717bbaa5243bda49b93e7048eff88f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a91717bbaa5243bda49b93e7048eff88f">getSwapInterval</a> () const</td></tr>
<tr class="memdesc:a91717bbaa5243bda49b93e7048eff88f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current swap-sync interval. <a href="#a91717bbaa5243bda49b93e7048eff88f">More...</a><br /></td></tr>
<tr class="separator:a91717bbaa5243bda49b93e7048eff88f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ae7fe1aa47448f75ef67f89cd9db798"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a5ae7fe1aa47448f75ef67f89cd9db798">getRenderingScale</a> () const noexcept</td></tr>
<tr class="memdesc:a5ae7fe1aa47448f75ef67f89cd9db798"><td class="mdescLeft"> </td><td class="mdescRight">Returns the scale factor used by the display that is being rendered. <a href="#a5ae7fe1aa47448f75ef67f89cd9db798">More...</a><br /></td></tr>
<tr class="separator:a5ae7fe1aa47448f75ef67f89cd9db798"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39b86efe11ffe091002d530d302e14bc"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a39b86efe11ffe091002d530d302e14bc">getFrameBufferID</a> () const noexcept</td></tr>
<tr class="memdesc:a39b86efe11ffe091002d530d302e14bc"><td class="mdescLeft"> </td><td class="mdescRight">If this context is backed by a frame buffer, this returns its ID number, or 0 if the context does not use a framebuffer. <a href="#a39b86efe11ffe091002d530d302e14bc">More...</a><br /></td></tr>
<tr class="separator:a39b86efe11ffe091002d530d302e14bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b9d12cc339f3f12124f4a3e54d5502c"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a9b9d12cc339f3f12124f4a3e54d5502c">getRawContext</a> () const noexcept</td></tr>
<tr class="memdesc:a9b9d12cc339f3f12124f4a3e54d5502c"><td class="mdescLeft"> </td><td class="mdescRight">Returns an OS-dependent handle to some kind of underlting OS-provided GL context. <a href="#a9b9d12cc339f3f12124f4a3e54d5502c">More...</a><br /></td></tr>
<tr class="separator:a9b9d12cc339f3f12124f4a3e54d5502c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0bf3594cb79029af5ee5eb66a14f152"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#ac0bf3594cb79029af5ee5eb66a14f152">copyTexture</a> (const <a class="el" href="classRectangle.html">Rectangle</a>< int > &targetClipArea, const <a class="el" href="classRectangle.html">Rectangle</a>< int > &anchorPosAndTextureSize, int contextWidth, int contextHeight, bool textureOriginIsBottomLeft)</td></tr>
<tr class="memdesc:ac0bf3594cb79029af5ee5eb66a14f152"><td class="mdescLeft"> </td><td class="mdescRight">Draws the currently selected texture into this context at its original size. <a href="#ac0bf3594cb79029af5ee5eb66a14f152">More...</a><br /></td></tr>
<tr class="separator:ac0bf3594cb79029af5ee5eb66a14f152"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eb85ffda148dac618e28fae654aab0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a1eb85ffda148dac618e28fae654aab0a">setImageCacheSize</a> (size_t cacheSizeBytes) noexcept</td></tr>
<tr class="memdesc:a1eb85ffda148dac618e28fae654aab0a"><td class="mdescLeft"> </td><td class="mdescRight">Changes the amount of GPU memory that the internal cache for Images is allowed to use. <a href="#a1eb85ffda148dac618e28fae654aab0a">More...</a><br /></td></tr>
<tr class="separator:a1eb85ffda148dac618e28fae654aab0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a370e786a96eac9fa8486eff23ab2da9c"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a370e786a96eac9fa8486eff23ab2da9c">getImageCacheSize</a> () const noexcept</td></tr>
<tr class="memdesc:a370e786a96eac9fa8486eff23ab2da9c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the amount of GPU memory that the internal cache for Images is allowed to use. <a href="#a370e786a96eac9fa8486eff23ab2da9c">More...</a><br /></td></tr>
<tr class="separator:a370e786a96eac9fa8486eff23ab2da9c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a0f7e55a23fc083656c0f35f4ec95e1d7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenGLContext.html">OpenGLContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a0f7e55a23fc083656c0f35f4ec95e1d7">getContextAttachedTo</a> (<a class="el" href="classComponent.html">Component</a> &component) noexcept</td></tr>
<tr class="memdesc:a0f7e55a23fc083656c0f35f4ec95e1d7"><td class="mdescLeft"> </td><td class="mdescRight">If the given component has an <a class="el" href="classOpenGLContext.html" title="Creates an OpenGL context, which can be attached to a component. ">OpenGLContext</a> attached, then this will return it. <a href="#a0f7e55a23fc083656c0f35f4ec95e1d7">More...</a><br /></td></tr>
<tr class="separator:a0f7e55a23fc083656c0f35f4ec95e1d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a3ece9be728d97e0343ae17a71f6562"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a5a3ece9be728d97e0343ae17a71f6562">deactivateCurrentContext</a> ()</td></tr>
<tr class="memdesc:a5a3ece9be728d97e0343ae17a71f6562"><td class="mdescLeft"> </td><td class="mdescRight">If any context is active on the current thread, this deactivates it. <a href="#a5a3ece9be728d97e0343ae17a71f6562">More...</a><br /></td></tr>
<tr class="separator:a5a3ece9be728d97e0343ae17a71f6562"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7e84e07e6f1228a865915ca21500f7a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenGLContext.html">OpenGLContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#af7e84e07e6f1228a865915ca21500f7a">getCurrentContext</a> ()</td></tr>
<tr class="memdesc:af7e84e07e6f1228a865915ca21500f7a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the context that's currently in active use by the calling thread, or nullptr if no context is active. <a href="#af7e84e07e6f1228a865915ca21500f7a">More...</a><br /></td></tr>
<tr class="separator:af7e84e07e6f1228a865915ca21500f7a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a3e204724fd78bbc272023525226caad7"><td class="memItemLeft" align="right" valign="top">OpenGLExtensionFunctions </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenGLContext.html#a3e204724fd78bbc272023525226caad7">extensions</a></td></tr>
<tr class="memdesc:a3e204724fd78bbc272023525226caad7"><td class="mdescLeft"> </td><td class="mdescRight">This structure holds a set of dynamically loaded GL functions for use on this context. <a href="#a3e204724fd78bbc272023525226caad7">More...</a><br /></td></tr>
<tr class="separator:a3e204724fd78bbc272023525226caad7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Creates an OpenGL context, which can be attached to a component. </p>
<p>To render some OpenGL, you should create an instance of an <a class="el" href="classOpenGLContext.html" title="Creates an OpenGL context, which can be attached to a component. ">OpenGLContext</a>, and call <a class="el" href="classOpenGLContext.html#ad320cd274bba96c11dc1ea32310ad37c" title="Attaches the context to a target component. ">attachTo()</a> to make it use a component as its render target.</p>
<p>To provide threaded rendering, you can supply an <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> object that will be used to render each frame.</p>
<p>Before your target component or <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> is deleted, you MUST call <a class="el" href="classOpenGLContext.html#a7504aa8928c854732090ee9583e9f37d" title="Detaches the context from its target component and deletes any native resources. ">detach()</a> or delete the <a class="el" href="classOpenGLContext.html" title="Creates an OpenGL context, which can be attached to a component. ">OpenGLContext</a> to allow the background thread to stop and the native resources to be freed safely.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a3a6b8eeed7dbc7c7c649528252c07d02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a6b8eeed7dbc7c7c649528252c07d02">§ </a></span>OpenGLVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02">OpenGLContext::OpenGLVersion</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>OpenGL versions, used by <a class="el" href="classOpenGLContext.html#a45a3bcd0cfcf94796ed43113a1866315" title="Sets a preference for the version of GL that this context should use, if possible. ">setOpenGLVersionRequired()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3a6b8eeed7dbc7c7c649528252c07d02abfbb3238e2943fa532a03e1473ac1baf"></a>defaultGLVersion </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a3a6b8eeed7dbc7c7c649528252c07d02a360335be2efbcff04897b872de9b8e45"></a>openGL3_2 </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a9be23e3642f28848a26cd00669f0b4d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9be23e3642f28848a26cd00669f0b4d7">§ </a></span>OpenGLContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenGLContext::OpenGLContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac1f6be39c9063b52dcfa60b94a2e5407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1f6be39c9063b52dcfa60b94a2e5407">§ </a></span>~OpenGLContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenGLContext::~OpenGLContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adbb9e06c8783a85db58f8b666675e577"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbb9e06c8783a85db58f8b666675e577">§ </a></span>setRenderer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setRenderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenGLRenderer.html">OpenGLRenderer</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the context an <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> to use to do the drawing. </p>
<p>The object that you give it will not be owned by the context, so it's the caller's responsibility to manage its lifetime and make sure that it doesn't get deleted while the context may be using it. To stop the context using a renderer, just call this method with a null pointer. Note: This must be called BEFORE attaching your context to a target component! </p>
</div>
</div>
<a id="ad320cd274bba96c11dc1ea32310ad37c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad320cd274bba96c11dc1ea32310ad37c">§ </a></span>attachTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::attachTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches the context to a target component. </p>
<p>If the component is not fully visible, this call will wait until the component is shown before actually creating a native context for it.</p>
<p>When a native context is created, a thread is started, and will be used to call the <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> methods. The context will be floated above the target component, and when the target moves, it will track it. If the component is hidden/shown, the context may be deleted and re-created. </p>
</div>
</div>
<a id="a7504aa8928c854732090ee9583e9f37d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7504aa8928c854732090ee9583e9f37d">§ </a></span>detach()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::detach </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Detaches the context from its target component and deletes any native resources. </p>
<p>If the context has not been attached, this will do nothing. Otherwise, it will block until the context and its thread have been cleaned up. </p>
</div>
</div>
<a id="ac2a9392e74c56fd8a0ee45d1a845b0f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2a9392e74c56fd8a0ee45d1a845b0f0">§ </a></span>isAttached()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool OpenGLContext::isAttached </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the context is attached to a component and is on-screen. </p>
<p>Note that if you call <a class="el" href="classOpenGLContext.html#ad320cd274bba96c11dc1ea32310ad37c" title="Attaches the context to a target component. ">attachTo()</a> for a non-visible component, this method will return false until the component is made visible. </p>
</div>
</div>
<a id="a0079c44b081f30fb0ace2396a95df343"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0079c44b081f30fb0ace2396a95df343">§ </a></span>getTargetComponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComponent.html">Component</a>* OpenGLContext::getTargetComponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the component to which this context is currently attached, or nullptr. </p>
</div>
</div>
<a id="a0f7e55a23fc083656c0f35f4ec95e1d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f7e55a23fc083656c0f35f4ec95e1d7">§ </a></span>getContextAttachedTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenGLContext.html">OpenGLContext</a>* OpenGLContext::getContextAttachedTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> & </td>
<td class="paramname"><em>component</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>If the given component has an <a class="el" href="classOpenGLContext.html" title="Creates an OpenGL context, which can be attached to a component. ">OpenGLContext</a> attached, then this will return it. </p>
</div>
</div>
<a id="aeb49920c5ee4e4694fa4cbd1700b2acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb49920c5ee4e4694fa4cbd1700b2acb">§ </a></span>setPixelFormat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setPixelFormat </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenGLPixelFormat.html">OpenGLPixelFormat</a> & </td>
<td class="paramname"><em>preferredPixelFormat</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the pixel format which you'd like to use for the target GL surface. </p>
<p>Note: This must be called BEFORE attaching your context to a target component! </p>
</div>
</div>
<a id="a0129ecf603a0cc3034e4809a23812e4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0129ecf603a0cc3034e4809a23812e4a">§ </a></span>setNativeSharedContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setNativeSharedContext </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>nativeContextToShareWith</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides a context with which you'd like this context's resources to be shared. </p>
<p>The object passed-in here is a platform-dependent native context object, and must not be deleted while this context may still be using it! To turn off sharing, you can call this method with a null pointer. Note: This must be called BEFORE attaching your context to a target component! </p>
</div>
</div>
<a id="ab3e6fd6e0d9104a249f029833f6b4172"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3e6fd6e0d9104a249f029833f6b4172">§ </a></span>setMultisamplingEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setMultisamplingEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables multisampling on platforms where this is implemented. </p>
<p>If enabling this, you must call this method before <a class="el" href="classOpenGLContext.html#ad320cd274bba96c11dc1ea32310ad37c" title="Attaches the context to a target component. ">attachTo()</a>. </p>
</div>
</div>
<a id="af33252b1d42af69915c77401f8c0ba31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af33252b1d42af69915c77401f8c0ba31">§ </a></span>areShadersAvailable()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool OpenGLContext::areShadersAvailable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if shaders can be used in this context. </p>
</div>
</div>
<a id="a45a3bcd0cfcf94796ed43113a1866315"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45a3bcd0cfcf94796ed43113a1866315">§ </a></span>setOpenGLVersionRequired()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setOpenGLVersionRequired </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenGLContext.html#a3a6b8eeed7dbc7c7c649528252c07d02">OpenGLVersion</a> </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a preference for the version of GL that this context should use, if possible. </p>
<p>Some platforms may ignore this value. </p>
</div>
</div>
<a id="aaa4cf6bbdb662b106cd44c203b8abb1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa4cf6bbdb662b106cd44c203b8abb1a">§ </a></span>setComponentPaintingEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setComponentPaintingEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldPaintComponent</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables the use of the GL context to perform 2D rendering of the component to which it is attached. </p>
<p>If this is false, then only your <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> will be used to perform any rendering. If true, then each time your target's paint() method needs to be called, an OpenGLGraphicsContext will be used to render it, (after calling your <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a> if there is one).</p>
<p>By default this is set to true. If you're not using any paint() method functionality and are doing all your rendering in an <a class="el" href="classOpenGLRenderer.html" title="A base class that should be implemented by classes which want to render openGL on a background thread...">OpenGLRenderer</a>, you should disable it to improve performance.</p>
<p>Note: This must be called BEFORE attaching your context to a target component! </p>
</div>
</div>
<a id="a7c305575ef3337ae64940db3c00abdc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c305575ef3337ae64940db3c00abdc6">§ </a></span>setContinuousRepainting()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setContinuousRepainting </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldContinuouslyRepaint</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables or disables continuous repainting. </p>
<p>If set to true, the context will run a loop, re-rendering itself without waiting for <a class="el" href="classOpenGLContext.html#acc0fc11c02ebbe4af1cc234eb5d8b84a" title="Asynchronously causes a repaint to be made. ">triggerRepaint()</a> to be called, at a frequency determined by the swap interval (see setSwapInterval). If false, then after each render callback, it will wait for another call to <a class="el" href="classOpenGLContext.html#acc0fc11c02ebbe4af1cc234eb5d8b84a" title="Asynchronously causes a repaint to be made. ">triggerRepaint()</a> before rendering again. This is disabled by default. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOpenGLContext.html#a046fe0f0de71000ee940d825d5dc57e0" title="Sets whether the context checks the vertical sync before swapping. ">setSwapInterval</a> </dd></dl>
</div>
</div>
<a id="acc0fc11c02ebbe4af1cc234eb5d8b84a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc0fc11c02ebbe4af1cc234eb5d8b84a">§ </a></span>triggerRepaint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::triggerRepaint </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Asynchronously causes a repaint to be made. </p>
</div>
</div>
<a id="a9668038df855f4682c4161cee1f8ce50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9668038df855f4682c4161cee1f8ce50">§ </a></span>getAssociatedObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a>* OpenGLContext::getAssociatedObject </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>This retrieves an object that was previously stored with <a class="el" href="classOpenGLContext.html#a51ee6e2d70c172820a4fb26722497892" title="Attaches a named object to the context, which will be deleted when the context is destroyed...">setAssociatedObject()</a>. </p>
<p>If no object is found with the given name, this will return nullptr. This method must only be called from within the GL rendering methods. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classOpenGLContext.html#a51ee6e2d70c172820a4fb26722497892" title="Attaches a named object to the context, which will be deleted when the context is destroyed...">setAssociatedObject</a> </dd></dl>
</div>
</div>
<a id="a51ee6e2d70c172820a4fb26722497892"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51ee6e2d70c172820a4fb26722497892">§ </a></span>setAssociatedObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setAssociatedObject </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classReferenceCountedObject.html">ReferenceCountedObject</a> * </td>
<td class="paramname"><em>newObject</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches a named object to the context, which will be deleted when the context is destroyed. </p>
<p>This allows you to store an object which will be released before the context is deleted. The main purpose is for caching GL objects such as shader programs, which will become invalid when the context is deleted.</p>
<p>This method must only be called from within the GL rendering methods. </p>
</div>
</div>
<a id="a318c8cc5821b9b2b2a9f726c623385f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a318c8cc5821b9b2b2a9f726c623385f8">§ </a></span>makeActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool OpenGLContext::makeActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes this context the currently active one. </p>
<p>You should never need to call this in normal use - the context will already be active when <a class="el" href="classOpenGLRenderer.html#a34077b4eaeb3207814b9e4302f724912" title="Called when you should render the next openGL frame. ">OpenGLRenderer::renderOpenGL()</a> is invoked. </p>
</div>
</div>
<a id="a5c5bce957be244229d9293d3303bff40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c5bce957be244229d9293d3303bff40">§ </a></span>isActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool OpenGLContext::isActive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if this context is currently active for the calling thread. </p>
</div>
</div>
<a id="a5a3ece9be728d97e0343ae17a71f6562"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a3ece9be728d97e0343ae17a71f6562">§ </a></span>deactivateCurrentContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void OpenGLContext::deactivateCurrentContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>If any context is active on the current thread, this deactivates it. </p>
<p>Note that on some platforms, like Android, this isn't possible. </p>
</div>
</div>
<a id="af7e84e07e6f1228a865915ca21500f7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7e84e07e6f1228a865915ca21500f7a">§ </a></span>getCurrentContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenGLContext.html">OpenGLContext</a>* OpenGLContext::getCurrentContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the context that's currently in active use by the calling thread, or nullptr if no context is active. </p>
</div>
</div>
<a id="a909377fc5880a61d28db1909b8d09e03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a909377fc5880a61d28db1909b8d09e03">§ </a></span>swapBuffers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::swapBuffers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Swaps the buffers (if the context can do this). </p>
<p>There's normally no need to call this directly - the buffers will be swapped automatically after your <a class="el" href="classOpenGLRenderer.html#a34077b4eaeb3207814b9e4302f724912" title="Called when you should render the next openGL frame. ">OpenGLRenderer::renderOpenGL()</a> method has been called. </p>
</div>
</div>
<a id="a046fe0f0de71000ee940d825d5dc57e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a046fe0f0de71000ee940d825d5dc57e0">§ </a></span>setSwapInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool OpenGLContext::setSwapInterval </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>numFramesPerSwap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether the context checks the vertical sync before swapping. </p>
<p>The value is the number of frames to allow between buffer-swapping. This is fairly system-dependent, but 0 turns off syncing, 1 makes it swap on frame-boundaries, and greater numbers indicate that it should swap less often.</p>
<p>By default, this will be set to 1.</p>
<p>Returns true if it sets the value successfully - some platforms won't support this setting.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOpenGLContext.html#a7c305575ef3337ae64940db3c00abdc6" title="Enables or disables continuous repainting. ">setContinuousRepainting</a> </dd></dl>
</div>
</div>
<a id="a91717bbaa5243bda49b93e7048eff88f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91717bbaa5243bda49b93e7048eff88f">§ </a></span>getSwapInterval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int OpenGLContext::getSwapInterval </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current swap-sync interval. </p>
<p>See <a class="el" href="classOpenGLContext.html#a046fe0f0de71000ee940d825d5dc57e0" title="Sets whether the context checks the vertical sync before swapping. ">setSwapInterval()</a> for info about the value returned. </p>
</div>
</div>
<a id="a5ae7fe1aa47448f75ef67f89cd9db798"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae7fe1aa47448f75ef67f89cd9db798">§ </a></span>getRenderingScale()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double OpenGLContext::getRenderingScale </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the scale factor used by the display that is being rendered. </p>
<p>The scale is that of the display - see <a class="el" href="structDesktop_1_1Displays_1_1Display.html#a1fa73b56829f21284aaf3ba95d64c227" title="This is the scale-factor of this display. ">Desktop::Displays::Display::scale</a></p>
<p>Note that this should only be called during an <a class="el" href="classOpenGLRenderer.html#a34077b4eaeb3207814b9e4302f724912" title="Called when you should render the next openGL frame. ">OpenGLRenderer::renderOpenGL()</a> callback - at other times the value it returns is undefined. </p>
</div>
</div>
<a id="a39b86efe11ffe091002d530d302e14bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39b86efe11ffe091002d530d302e14bc">§ </a></span>getFrameBufferID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int OpenGLContext::getFrameBufferID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>If this context is backed by a frame buffer, this returns its ID number, or 0 if the context does not use a framebuffer. </p>
</div>
</div>
<a id="a9b9d12cc339f3f12124f4a3e54d5502c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b9d12cc339f3f12124f4a3e54d5502c">§ </a></span>getRawContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void* OpenGLContext::getRawContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an OS-dependent handle to some kind of underlting OS-provided GL context. </p>
<p>The exact type of the value returned will depend on the OS and may change if the implementation changes. If you want to use this, digging around in the native code is probably the best way to find out what it is. </p>
</div>
</div>
<a id="ac0bf3594cb79029af5ee5eb66a14f152"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0bf3594cb79029af5ee5eb66a14f152">§ </a></span>copyTexture()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::copyTexture </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>targetClipArea</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>anchorPosAndTextureSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>contextWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>contextHeight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>textureOriginIsBottomLeft</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Draws the currently selected texture into this context at its original size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">targetClipArea</td><td>the target area to draw into (in top-left origin coords) </td></tr>
<tr><td class="paramname">anchorPosAndTextureSize</td><td>the position of this rectangle is the texture's top-left anchor position in the target space, and the size must be the total size of the texture. </td></tr>
<tr><td class="paramname">contextWidth</td><td>the width of the context or framebuffer that is being drawn into, used for scaling of the coordinates. </td></tr>
<tr><td class="paramname">contextHeight</td><td>the height of the context or framebuffer that is being drawn into, used for vertical flipping of the y coordinates. </td></tr>
<tr><td class="paramname">textureOriginIsBottomLeft</td><td>if true, the texture's origin is treated as being at (0, 0). If false, it is assumed to be (0, 1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1eb85ffda148dac618e28fae654aab0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eb85ffda148dac618e28fae654aab0a">§ </a></span>setImageCacheSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void OpenGLContext::setImageCacheSize </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cacheSizeBytes</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the amount of GPU memory that the internal cache for Images is allowed to use. </p>
</div>
</div>
<a id="a370e786a96eac9fa8486eff23ab2da9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a370e786a96eac9fa8486eff23ab2da9c">§ </a></span>getImageCacheSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t OpenGLContext::getImageCacheSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the amount of GPU memory that the internal cache for Images is allowed to use. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a3e204724fd78bbc272023525226caad7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e204724fd78bbc272023525226caad7">§ </a></span>extensions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenGLExtensionFunctions OpenGLContext::extensions</td>
</tr>
</table>
</div><div class="memdoc">
<p>This structure holds a set of dynamically loaded GL functions for use on this context. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__OpenGLContext_8h.html">juce_OpenGLContext.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|