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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include <fmt/format.h>
#include <algorithm>
#include "CanvasUtils.h"
#include "GLContext.h"
#include "MozFramebuffer.h"
#include "WebGL2Context.h"
#include "WebGLBuffer.h"
#include "WebGLContext.h"
#include "WebGLContextUtils.h"
#include "WebGLFormats.h"
#include "WebGLFramebuffer.h"
#include "WebGLProgram.h"
#include "WebGLQuery.h"
#include "WebGLRenderbuffer.h"
#include "WebGLShader.h"
#include "WebGLTexelConversions.h"
#include "WebGLTexture.h"
#include "WebGLValidateStrings.h"
#include "WebGLVertexArray.h"
#include "gfxContext.h"
#include "gfxPlatform.h"
#include "gfxUtils.h"
#include "jsfriendapi.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/EndianUtils.h"
#include "mozilla/RefPtr.h"
#include "mozilla/StaticPrefs_webgl.h"
#include "mozilla/dom/BindingUtils.h"
#include "mozilla/dom/ImageData.h"
#include "mozilla/dom/WebGLRenderingContextBinding.h"
#include "nsContentUtils.h"
#include "nsDebug.h"
#include "nsError.h"
#include "nsLayoutUtils.h"
#include "nsReadableUtils.h"
#include "nsString.h"
namespace mozilla {
using namespace mozilla::dom;
using namespace mozilla::gfx;
using namespace mozilla::gl;
//
// WebGL API
//
void WebGLContext::ActiveTexture(uint32_t texUnit) {
FuncScope funcScope(*this, "activeTexture");
if (IsContextLost()) return;
funcScope.mBindFailureGuard = true;
if (texUnit >= Limits().maxTexUnits) {
return ErrorInvalidEnum("Texture unit %u out of range (%u).", texUnit,
Limits().maxTexUnits);
}
mActiveTexture = texUnit;
gl->fActiveTexture(LOCAL_GL_TEXTURE0 + texUnit);
funcScope.mBindFailureGuard = false;
}
void WebGLContext::AttachShader(WebGLProgram& prog, WebGLShader& shader) {
FuncScope funcScope(*this, "attachShader");
if (IsContextLost()) return;
funcScope.mBindFailureGuard = true;
prog.AttachShader(shader);
funcScope.mBindFailureGuard = false;
}
void WebGLContext::BindAttribLocation(WebGLProgram& prog, GLuint location,
const std::string& name) const {
const FuncScope funcScope(*this, "bindAttribLocation");
if (IsContextLost()) return;
prog.BindAttribLocation(location, name);
}
void WebGLContext::BindFramebuffer(GLenum target, WebGLFramebuffer* wfb) {
FuncScope funcScope(*this, "bindFramebuffer");
if (IsContextLost()) return;
funcScope.mBindFailureGuard = true;
if (!ValidateFramebufferTarget(target)) return;
if (!wfb) {
gl->fBindFramebuffer(target, 0);
} else {
GLuint framebuffername = wfb->mGLName;
gl->fBindFramebuffer(target, framebuffername);
wfb->mHasBeenBound = true;
}
switch (target) {
case LOCAL_GL_FRAMEBUFFER:
mBoundDrawFramebuffer = wfb;
mBoundReadFramebuffer = wfb;
break;
case LOCAL_GL_DRAW_FRAMEBUFFER:
mBoundDrawFramebuffer = wfb;
break;
case LOCAL_GL_READ_FRAMEBUFFER:
mBoundReadFramebuffer = wfb;
break;
default:
return;
}
funcScope.mBindFailureGuard = false;
}
void WebGLContext::BlendEquationSeparate(Maybe<GLuint> i, GLenum modeRGB,
GLenum modeAlpha) {
const FuncScope funcScope(*this, "blendEquationSeparate");
if (IsContextLost()) return;
if (!ValidateBlendEquationEnum(modeRGB, "modeRGB") ||
!ValidateBlendEquationEnum(modeAlpha, "modeAlpha")) {
return;
}
if (i) {
MOZ_RELEASE_ASSERT(
IsExtensionEnabled(WebGLExtensionID::OES_draw_buffers_indexed));
const auto limit = MaxValidDrawBuffers();
if (*i >= limit) {
ErrorInvalidValue("`index` (%u) must be < %s (%u)", *i,
"MAX_DRAW_BUFFERS", limit);
return;
}
gl->fBlendEquationSeparatei(*i, modeRGB, modeAlpha);
} else {
gl->fBlendEquationSeparate(modeRGB, modeAlpha);
}
}
static bool ValidateBlendFuncEnum(WebGLContext* webgl, GLenum factor,
const char* varName) {
switch (factor) {
case LOCAL_GL_ZERO:
case LOCAL_GL_ONE:
case LOCAL_GL_SRC_COLOR:
case LOCAL_GL_ONE_MINUS_SRC_COLOR:
case LOCAL_GL_DST_COLOR:
case LOCAL_GL_ONE_MINUS_DST_COLOR:
case LOCAL_GL_SRC_ALPHA:
case LOCAL_GL_ONE_MINUS_SRC_ALPHA:
case LOCAL_GL_DST_ALPHA:
case LOCAL_GL_ONE_MINUS_DST_ALPHA:
case LOCAL_GL_CONSTANT_COLOR:
case LOCAL_GL_ONE_MINUS_CONSTANT_COLOR:
case LOCAL_GL_CONSTANT_ALPHA:
case LOCAL_GL_ONE_MINUS_CONSTANT_ALPHA:
case LOCAL_GL_SRC_ALPHA_SATURATE:
return true;
default:
webgl->ErrorInvalidEnumInfo(varName, factor);
return false;
}
}
static bool ValidateBlendFuncEnums(WebGLContext* webgl, GLenum srcRGB,
GLenum srcAlpha, GLenum dstRGB,
GLenum dstAlpha) {
if (!webgl->IsWebGL2()) {
if (dstRGB == LOCAL_GL_SRC_ALPHA_SATURATE ||
dstAlpha == LOCAL_GL_SRC_ALPHA_SATURATE) {
webgl->ErrorInvalidEnum(
"LOCAL_GL_SRC_ALPHA_SATURATE as a destination"
" blend function is disallowed in WebGL 1 (dstRGB ="
" 0x%04x, dstAlpha = 0x%04x).",
dstRGB, dstAlpha);
return false;
}
}
if (!ValidateBlendFuncEnum(webgl, srcRGB, "srcRGB") ||
!ValidateBlendFuncEnum(webgl, srcAlpha, "srcAlpha") ||
!ValidateBlendFuncEnum(webgl, dstRGB, "dstRGB") ||
!ValidateBlendFuncEnum(webgl, dstAlpha, "dstAlpha")) {
return false;
}
return true;
}
void WebGLContext::BlendFuncSeparate(Maybe<GLuint> i, GLenum srcRGB,
GLenum dstRGB, GLenum srcAlpha,
GLenum dstAlpha) {
const FuncScope funcScope(*this, "blendFuncSeparate");
if (IsContextLost()) return;
if (!ValidateBlendFuncEnums(this, srcRGB, srcAlpha, dstRGB, dstAlpha)) return;
// note that we only check compatibity for the RGB enums, no need to for the
// Alpha enums, see "Section 6.8 forgetting to mention alpha factors?" thread
// on the public_webgl mailing list
if (!ValidateBlendFuncEnumsCompatibility(srcRGB, dstRGB, "srcRGB and dstRGB"))
return;
if (i) {
MOZ_RELEASE_ASSERT(
IsExtensionEnabled(WebGLExtensionID::OES_draw_buffers_indexed));
const auto limit = MaxValidDrawBuffers();
if (*i >= limit) {
ErrorInvalidValue("`index` (%u) must be < %s (%u)", *i,
"MAX_DRAW_BUFFERS", limit);
return;
}
gl->fBlendFuncSeparatei(*i, srcRGB, dstRGB, srcAlpha, dstAlpha);
} else {
gl->fBlendFuncSeparate(srcRGB, dstRGB, srcAlpha, dstAlpha);
}
}
GLenum WebGLContext::CheckFramebufferStatus(GLenum target) {
const FuncScope funcScope(*this, "checkFramebufferStatus");
if (IsContextLost()) return LOCAL_GL_FRAMEBUFFER_UNSUPPORTED;
if (!ValidateFramebufferTarget(target)) return 0;
WebGLFramebuffer* fb;
switch (target) {
case LOCAL_GL_FRAMEBUFFER:
case LOCAL_GL_DRAW_FRAMEBUFFER:
fb = mBoundDrawFramebuffer;
break;
case LOCAL_GL_READ_FRAMEBUFFER:
fb = mBoundReadFramebuffer;
break;
default:
MOZ_CRASH("GFX: Bad target.");
}
if (!fb) return LOCAL_GL_FRAMEBUFFER_COMPLETE;
return fb->CheckFramebufferStatus().get();
}
RefPtr<WebGLProgram> WebGLContext::CreateProgram() {
const FuncScope funcScope(*this, "createProgram");
if (IsContextLost()) return nullptr;
return new WebGLProgram(this);
}
RefPtr<WebGLShader> WebGLContext::CreateShader(GLenum type) {
const FuncScope funcScope(*this, "createShader");
if (IsContextLost()) return nullptr;
if (type != LOCAL_GL_VERTEX_SHADER && type != LOCAL_GL_FRAGMENT_SHADER) {
ErrorInvalidEnumInfo("type", type);
return nullptr;
}
return new WebGLShader(this, type);
}
void WebGLContext::CullFace(GLenum face) {
const FuncScope funcScope(*this, "cullFace");
if (IsContextLost()) return;
if (!ValidateFaceEnum(face)) return;
gl->fCullFace(face);
}
void WebGLContext::DetachShader(WebGLProgram& prog, const WebGLShader& shader) {
FuncScope funcScope(*this, "detachShader");
if (IsContextLost()) return;
funcScope.mBindFailureGuard = true;
prog.DetachShader(shader);
funcScope.mBindFailureGuard = false;
}
static bool ValidateComparisonEnum(WebGLContext& webgl, const GLenum func) {
switch (func) {
case LOCAL_GL_NEVER:
case LOCAL_GL_LESS:
case LOCAL_GL_LEQUAL:
case LOCAL_GL_GREATER:
case LOCAL_GL_GEQUAL:
case LOCAL_GL_EQUAL:
case LOCAL_GL_NOTEQUAL:
case LOCAL_GL_ALWAYS:
return true;
default:
webgl.ErrorInvalidEnumInfo("func", func);
return false;
}
}
void WebGLContext::DepthFunc(GLenum func) {
const FuncScope funcScope(*this, "depthFunc");
if (IsContextLost()) return;
if (!ValidateComparisonEnum(*this, func)) return;
gl->fDepthFunc(func);
}
void WebGLContext::DepthRange(GLfloat zNear, GLfloat zFar) {
const FuncScope funcScope(*this, "depthRange");
if (IsContextLost()) return;
if (zNear > zFar)
return ErrorInvalidOperation(
"the near value is greater than the far value!");
gl->fDepthRange(zNear, zFar);
}
// -
void WebGLContext::FramebufferAttach(const GLenum target,
const GLenum attachSlot,
const GLenum bindImageTarget,
const webgl::FbAttachInfo& toAttach) {
FuncScope funcScope(*this, "framebufferAttach");
funcScope.mBindFailureGuard = true;
const auto& limits = *mLimits;
if (!ValidateFramebufferTarget(target)) return;
auto fb = mBoundDrawFramebuffer;
if (target == LOCAL_GL_READ_FRAMEBUFFER) {
fb = mBoundReadFramebuffer;
}
if (!fb) return;
// `rb` needs no validation.
// `tex`
const auto& tex = toAttach.tex;
if (tex) {
const auto err = CheckFramebufferAttach(bindImageTarget, tex->mTarget.get(),
toAttach.mipLevel, toAttach.zLayer,
toAttach.zLayerCount, limits);
if (err) return;
}
auto safeToAttach = toAttach;
if (!toAttach.rb && !toAttach.tex) {
safeToAttach = {};
}
if (!IsWebGL2() &&
!IsExtensionEnabled(WebGLExtensionID::OES_fbo_render_mipmap)) {
safeToAttach.mipLevel = 0;
}
if (!IsExtensionEnabled(WebGLExtensionID::OVR_multiview2)) {
safeToAttach.isMultiview = false;
}
if (!fb->FramebufferAttach(attachSlot, safeToAttach)) return;
funcScope.mBindFailureGuard = false;
}
// -
void WebGLContext::FrontFace(GLenum mode) {
const FuncScope funcScope(*this, "frontFace");
if (IsContextLost()) return;
switch (mode) {
case LOCAL_GL_CW:
case LOCAL_GL_CCW:
break;
default:
return ErrorInvalidEnumInfo("mode", mode);
}
gl->fFrontFace(mode);
}
Maybe<double> WebGLContext::GetBufferParameter(GLenum target, GLenum pname) {
const FuncScope funcScope(*this, "getBufferParameter");
if (IsContextLost()) return Nothing();
const auto& slot = ValidateBufferSlot(target);
if (!slot) return Nothing();
const auto& buffer = *slot;
if (!buffer) {
ErrorInvalidOperation("Buffer for `target` is null.");
return Nothing();
}
switch (pname) {
case LOCAL_GL_BUFFER_SIZE:
return Some(buffer->ByteLength());
case LOCAL_GL_BUFFER_USAGE:
return Some(buffer->Usage());
default:
ErrorInvalidEnumInfo("pname", pname);
return Nothing();
}
}
Maybe<double> WebGLContext::GetFramebufferAttachmentParameter(
WebGLFramebuffer* const fb, GLenum attachment, GLenum pname) const {
const FuncScope funcScope(*this, "getFramebufferAttachmentParameter");
if (IsContextLost()) return Nothing();
if (fb) return fb->GetAttachmentParameter(attachment, pname);
////////////////////////////////////
if (!IsWebGL2()) {
ErrorInvalidOperation(
"Querying against the default framebuffer is not"
" allowed in WebGL 1.");
return Nothing();
}
switch (attachment) {
case LOCAL_GL_BACK:
case LOCAL_GL_DEPTH:
case LOCAL_GL_STENCIL:
break;
default:
ErrorInvalidEnum(
"For the default framebuffer, can only query COLOR, DEPTH,"
" or STENCIL.");
return Nothing();
}
switch (pname) {
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE:
switch (attachment) {
case LOCAL_GL_BACK:
break;
case LOCAL_GL_DEPTH:
if (!mOptions.depth) {
return Some(LOCAL_GL_NONE);
}
break;
case LOCAL_GL_STENCIL:
if (!mOptions.stencil) {
return Some(LOCAL_GL_NONE);
}
break;
default:
ErrorInvalidEnum(
"With the default framebuffer, can only query COLOR, DEPTH,"
" or STENCIL for GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE");
return Nothing();
}
return Some(LOCAL_GL_FRAMEBUFFER_DEFAULT);
////////////////
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE:
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE:
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE:
if (attachment == LOCAL_GL_BACK) return Some(8);
return Some(0);
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE:
if (attachment == LOCAL_GL_BACK) {
if (mOptions.alpha) {
return Some(8);
}
ErrorInvalidOperation(
"The default framebuffer doesn't contain an alpha buffer");
return Nothing();
}
return Some(0);
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE:
if (attachment == LOCAL_GL_DEPTH) {
if (mOptions.depth) {
return Some(24);
}
ErrorInvalidOperation(
"The default framebuffer doesn't contain an depth buffer");
return Nothing();
}
return Some(0);
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE:
if (attachment == LOCAL_GL_STENCIL) {
if (mOptions.stencil) {
return Some(8);
}
ErrorInvalidOperation(
"The default framebuffer doesn't contain an stencil buffer");
return Nothing();
}
return Some(0);
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE:
if (attachment == LOCAL_GL_STENCIL) {
if (mOptions.stencil) {
return Some(LOCAL_GL_UNSIGNED_INT);
}
ErrorInvalidOperation(
"The default framebuffer doesn't contain an stencil buffer");
} else if (attachment == LOCAL_GL_DEPTH) {
if (mOptions.depth) {
return Some(LOCAL_GL_UNSIGNED_NORMALIZED);
}
ErrorInvalidOperation(
"The default framebuffer doesn't contain an depth buffer");
} else { // LOCAL_GL_BACK
return Some(LOCAL_GL_UNSIGNED_NORMALIZED);
}
return Nothing();
case LOCAL_GL_FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING:
if (attachment == LOCAL_GL_STENCIL) {
if (!mOptions.stencil) {
ErrorInvalidOperation(
"The default framebuffer doesn't contain an stencil buffer");
return Nothing();
}
} else if (attachment == LOCAL_GL_DEPTH) {
if (!mOptions.depth) {
ErrorInvalidOperation(
"The default framebuffer doesn't contain an depth buffer");
return Nothing();
}
}
return Some(LOCAL_GL_LINEAR);
}
ErrorInvalidEnumInfo("pname", pname);
return Nothing();
}
Maybe<double> WebGLContext::GetRenderbufferParameter(
const WebGLRenderbuffer& rb, GLenum pname) const {
const FuncScope funcScope(*this, "getRenderbufferParameter");
if (IsContextLost()) return Nothing();
switch (pname) {
case LOCAL_GL_RENDERBUFFER_SAMPLES:
if (!IsWebGL2()) break;
[[fallthrough]];
case LOCAL_GL_RENDERBUFFER_WIDTH:
case LOCAL_GL_RENDERBUFFER_HEIGHT:
case LOCAL_GL_RENDERBUFFER_RED_SIZE:
case LOCAL_GL_RENDERBUFFER_GREEN_SIZE:
case LOCAL_GL_RENDERBUFFER_BLUE_SIZE:
case LOCAL_GL_RENDERBUFFER_ALPHA_SIZE:
case LOCAL_GL_RENDERBUFFER_DEPTH_SIZE:
case LOCAL_GL_RENDERBUFFER_STENCIL_SIZE:
case LOCAL_GL_RENDERBUFFER_INTERNAL_FORMAT: {
// RB emulation means we have to ask the RB itself.
GLint i = rb.GetRenderbufferParameter(pname);
return Some(i);
}
default:
break;
}
ErrorInvalidEnumInfo("pname", pname);
return Nothing();
}
RefPtr<WebGLTexture> WebGLContext::CreateTexture() {
const FuncScope funcScope(*this, "createTexture");
if (IsContextLost()) return nullptr;
GLuint tex = 0;
gl->fGenTextures(1, &tex);
return new WebGLTexture(this, tex);
}
GLenum WebGLContext::GetError() {
const FuncScope funcScope(*this, "getError");
/* WebGL 1.0: Section 5.14.3: Setting and getting state:
* If the context's webgl context lost flag is set, returns
* CONTEXT_LOST_WEBGL the first time this method is called.
* Afterward, returns NO_ERROR until the context has been
* restored.
*
* WEBGL_lose_context:
* [When this extension is enabled: ] loseContext and
* restoreContext are allowed to generate INVALID_OPERATION errors
* even when the context is lost.
*/
auto err = mWebGLError;
mWebGLError = 0;
if (IsContextLost() || err) // Must check IsContextLost in all flow paths.
return err;
// Either no WebGL-side error, or it's already been cleared.
// UnderlyingGL-side errors, now.
err = gl->fGetError();
if (gl->IsContextLost()) {
CheckForContextLoss();
return GetError();
}
MOZ_ASSERT(err != LOCAL_GL_CONTEXT_LOST);
if (err) {
GenerateWarning("Driver error unexpected by WebGL: 0x%04x", err);
// This might be:
// - INVALID_OPERATION from ANGLE due to incomplete RBAB implementation for
// DrawElements
// with DYNAMIC_DRAW index buffer.
}
return err;
}
webgl::GetUniformData WebGLContext::GetUniform(const WebGLProgram& prog,
const uint32_t loc) const {
const FuncScope funcScope(*this, "getUniform");
webgl::GetUniformData ret;
[&]() {
if (IsContextLost()) return;
const auto& info = prog.LinkInfo();
if (!info) return;
const auto locInfo = MaybeFind(info->locationMap, loc);
if (!locInfo) return;
ret.type = locInfo->info.info.elemType;
switch (ret.type) {
case LOCAL_GL_FLOAT:
case LOCAL_GL_FLOAT_VEC2:
case LOCAL_GL_FLOAT_VEC3:
case LOCAL_GL_FLOAT_VEC4:
case LOCAL_GL_FLOAT_MAT2:
case LOCAL_GL_FLOAT_MAT3:
case LOCAL_GL_FLOAT_MAT4:
case LOCAL_GL_FLOAT_MAT2x3:
case LOCAL_GL_FLOAT_MAT2x4:
case LOCAL_GL_FLOAT_MAT3x2:
case LOCAL_GL_FLOAT_MAT3x4:
case LOCAL_GL_FLOAT_MAT4x2:
case LOCAL_GL_FLOAT_MAT4x3:
gl->fGetUniformfv(prog.mGLName, loc,
reinterpret_cast<float*>(ret.data));
break;
case LOCAL_GL_INT:
case LOCAL_GL_INT_VEC2:
case LOCAL_GL_INT_VEC3:
case LOCAL_GL_INT_VEC4:
case LOCAL_GL_SAMPLER_2D:
case LOCAL_GL_SAMPLER_3D:
case LOCAL_GL_SAMPLER_CUBE:
case LOCAL_GL_SAMPLER_2D_SHADOW:
case LOCAL_GL_SAMPLER_2D_ARRAY:
case LOCAL_GL_SAMPLER_2D_ARRAY_SHADOW:
case LOCAL_GL_SAMPLER_CUBE_SHADOW:
case LOCAL_GL_INT_SAMPLER_2D:
case LOCAL_GL_INT_SAMPLER_3D:
case LOCAL_GL_INT_SAMPLER_CUBE:
case LOCAL_GL_INT_SAMPLER_2D_ARRAY:
case LOCAL_GL_UNSIGNED_INT_SAMPLER_2D:
case LOCAL_GL_UNSIGNED_INT_SAMPLER_3D:
case LOCAL_GL_UNSIGNED_INT_SAMPLER_CUBE:
case LOCAL_GL_UNSIGNED_INT_SAMPLER_2D_ARRAY:
case LOCAL_GL_BOOL:
case LOCAL_GL_BOOL_VEC2:
case LOCAL_GL_BOOL_VEC3:
case LOCAL_GL_BOOL_VEC4:
gl->fGetUniformiv(prog.mGLName, loc,
reinterpret_cast<int32_t*>(ret.data));
break;
case LOCAL_GL_UNSIGNED_INT:
case LOCAL_GL_UNSIGNED_INT_VEC2:
case LOCAL_GL_UNSIGNED_INT_VEC3:
case LOCAL_GL_UNSIGNED_INT_VEC4:
gl->fGetUniformuiv(prog.mGLName, loc,
reinterpret_cast<uint32_t*>(ret.data));
break;
default:
MOZ_CRASH("GFX: Invalid elemType.");
}
}();
return ret;
}
void WebGLContext::Hint(GLenum target, GLenum mode) {
const FuncScope funcScope(*this, "hint");
if (IsContextLost()) return;
switch (mode) {
case LOCAL_GL_FASTEST:
case LOCAL_GL_NICEST:
case LOCAL_GL_DONT_CARE:
break;
default:
return ErrorInvalidEnumArg("mode", mode);
}
// -
bool isValid = false;
switch (target) {
case LOCAL_GL_GENERATE_MIPMAP_HINT:
mGenerateMipmapHint = mode;
isValid = true;
// Deprecated and removed in desktop GL Core profiles.
if (gl->IsCoreProfile()) return;
break;
case LOCAL_GL_FRAGMENT_SHADER_DERIVATIVE_HINT:
if (IsWebGL2() ||
IsExtensionEnabled(WebGLExtensionID::OES_standard_derivatives)) {
isValid = true;
}
break;
}
if (!isValid) return ErrorInvalidEnumInfo("target", target);
// -
gl->fHint(target, mode);
}
// -
void WebGLContext::LinkProgram(WebGLProgram& prog) {
const FuncScope funcScope(*this, "linkProgram");
if (IsContextLost()) return;
prog.LinkProgram();
if (&prog == mCurrentProgram) {
if (!prog.IsLinked()) {
// We use to simply early-out here, and preserve the GL behavior that
// failed relink doesn't invalidate the current active program link info.
// The new behavior was changed for WebGL here:
// https://github.com/KhronosGroup/WebGL/pull/3371
mActiveProgramLinkInfo = nullptr;
gl->fUseProgram(0); // Shouldn't be needed, but let's be safe.
return;
}
mActiveProgramLinkInfo = prog.LinkInfo();
gl->fUseProgram(prog.mGLName); // Uncontionally re-use.
// Previously, we needed this re-use on nvidia as a driver workaround,
// but we might as well do it unconditionally.
}
}
Maybe<webgl::ErrorInfo> SetPixelUnpack(
const bool isWebgl2, webgl::PixelUnpackStateWebgl* const unpacking,
const GLenum pname, const GLint param) {
if (isWebgl2) {
uint32_t* pValueSlot = nullptr;
switch (pname) {
case LOCAL_GL_UNPACK_IMAGE_HEIGHT:
pValueSlot = &unpacking->imageHeight;
break;
case LOCAL_GL_UNPACK_SKIP_IMAGES:
pValueSlot = &unpacking->skipImages;
break;
case LOCAL_GL_UNPACK_ROW_LENGTH:
pValueSlot = &unpacking->rowLength;
break;
case LOCAL_GL_UNPACK_SKIP_ROWS:
pValueSlot = &unpacking->skipRows;
break;
case LOCAL_GL_UNPACK_SKIP_PIXELS:
pValueSlot = &unpacking->skipPixels;
break;
}
if (pValueSlot) {
*pValueSlot = static_cast<uint32_t>(param);
return {};
}
}
switch (pname) {
case dom::WebGLRenderingContext_Binding::UNPACK_FLIP_Y_WEBGL:
unpacking->flipY = bool(param);
return {};
case dom::WebGLRenderingContext_Binding::UNPACK_PREMULTIPLY_ALPHA_WEBGL:
unpacking->premultiplyAlpha = bool(param);
return {};
case dom::WebGLRenderingContext_Binding::UNPACK_COLORSPACE_CONVERSION_WEBGL:
switch (param) {
case LOCAL_GL_NONE:
case dom::WebGLRenderingContext_Binding::BROWSER_DEFAULT_WEBGL:
break;
default: {
const nsPrintfCString text("Bad UNPACK_COLORSPACE_CONVERSION: %s",
EnumString(param).c_str());
return Some(webgl::ErrorInfo{LOCAL_GL_INVALID_VALUE, ToString(text)});
}
}
unpacking->colorspaceConversion = param;
return {};
case dom::MOZ_debug_Binding::UNPACK_REQUIRE_FASTPATH:
unpacking->requireFastPath = bool(param);
return {};
case LOCAL_GL_UNPACK_ALIGNMENT:
switch (param) {
case 1:
case 2:
case 4:
case 8:
break;
default: {
const nsPrintfCString text(
"UNPACK_ALIGNMENT must be [1,2,4,8], was %i", param);
return Some(webgl::ErrorInfo{LOCAL_GL_INVALID_VALUE, ToString(text)});
}
}
unpacking->alignmentInTypeElems = param;
return {};
default:
break;
}
const nsPrintfCString text("Bad `pname`: %s", EnumString(pname).c_str());
return Some(webgl::ErrorInfo{LOCAL_GL_INVALID_ENUM, ToString(text)});
}
bool WebGLContext::DoReadPixelsAndConvert(
const webgl::FormatInfo* const srcFormat, const webgl::ReadPixelsDesc& desc,
const uintptr_t dest, const uint64_t destSize, const uint32_t rowStride) {
const auto& x = desc.srcOffset.x;
const auto& y = desc.srcOffset.y;
const auto size = *ivec2::From(desc.size);
const auto& pi = desc.pi;
// On at least Win+NV, we'll get PBO errors if we don't have at least
// `rowStride * height` bytes available to read into.
const auto naiveBytesNeeded = CheckedInt<uint64_t>(rowStride) * size.y;
const bool isDangerCloseToEdge =
(!naiveBytesNeeded.isValid() || naiveBytesNeeded.value() > destSize);
const bool useParanoidHandling =
(gl->WorkAroundDriverBugs() && isDangerCloseToEdge &&
mBoundPixelPackBuffer);
if (!useParanoidHandling) {
gl->fReadPixels(x, y, size.x, size.y, pi.format, pi.type,
reinterpret_cast<void*>(dest));
return true;
}
// Read everything but the last row.
const auto bodyHeight = size.y - 1;
if (bodyHeight) {
gl->fReadPixels(x, y, size.x, bodyHeight, pi.format, pi.type,
reinterpret_cast<void*>(dest));
}
// Now read the last row.
gl->fPixelStorei(LOCAL_GL_PACK_ALIGNMENT, 1);
gl->fPixelStorei(LOCAL_GL_PACK_ROW_LENGTH, 0);
gl->fPixelStorei(LOCAL_GL_PACK_SKIP_ROWS, 0);
const auto tailRowOffset =
reinterpret_cast<uint8_t*>(dest) + rowStride * bodyHeight;
gl->fReadPixels(x, y + bodyHeight, size.x, 1, pi.format, pi.type,
tailRowOffset);
return true;
}
webgl::ReadPixelsResult WebGLContext::ReadPixelsInto(
const webgl::ReadPixelsDesc& desc, const Range<uint8_t>& dest) {
const FuncScope funcScope(*this, "readPixels");
if (IsContextLost()) return {};
if (mBoundPixelPackBuffer) {
ErrorInvalidOperation("PIXEL_PACK_BUFFER must be null.");
return {};
}
return ReadPixelsImpl(desc, reinterpret_cast<uintptr_t>(dest.begin().get()),
dest.length());
}
void WebGLContext::ReadPixelsPbo(const webgl::ReadPixelsDesc& desc,
const uint64_t offset) {
const FuncScope funcScope(*this, "readPixels");
if (IsContextLost()) return;
const auto& buffer = ValidateBufferSelection(LOCAL_GL_PIXEL_PACK_BUFFER);
if (!buffer) return;
//////
{
const auto pii = webgl::PackingInfoInfo::For(desc.pi);
if (!pii) {
GLenum err = LOCAL_GL_INVALID_OPERATION;
if (!desc.pi.format || !desc.pi.type) {
err = LOCAL_GL_INVALID_ENUM;
}
GenerateError(err, "`format` (%s) and/or `type` (%s) not acceptable.",
EnumString(desc.pi.format).c_str(),
EnumString(desc.pi.type).c_str());
return;
}
if (offset % pii->bytesPerElement != 0) {
ErrorInvalidOperation(
"`offset` must be divisible by the size of `type`"
" in bytes.");
return;
}
}
//////
auto bytesAvailable = buffer->ByteLength();
if (offset > bytesAvailable) {
ErrorInvalidOperation("`offset` too large for bound PIXEL_PACK_BUFFER.");
return;
}
bytesAvailable -= offset;
// -
const ScopedLazyBind lazyBind(gl, LOCAL_GL_PIXEL_PACK_BUFFER, buffer);
ReadPixelsImpl(desc, offset, bytesAvailable);
buffer->ResetLastUpdateFenceId();
}
static webgl::PackingInfo DefaultReadPixelPI(
const webgl::FormatUsageInfo* usage) {
MOZ_ASSERT(usage->IsRenderable());
const auto& format = *usage->format;
switch (format.componentType) {
case webgl::ComponentType::NormUInt:
if (format.r == 16) {
return {LOCAL_GL_RGBA, LOCAL_GL_UNSIGNED_SHORT};
}
return {LOCAL_GL_RGBA, LOCAL_GL_UNSIGNED_BYTE};
case webgl::ComponentType::Int:
return {LOCAL_GL_RGBA_INTEGER, LOCAL_GL_INT};
case webgl::ComponentType::UInt:
return {LOCAL_GL_RGBA_INTEGER, LOCAL_GL_UNSIGNED_INT};
case webgl::ComponentType::Float:
return {LOCAL_GL_RGBA, LOCAL_GL_FLOAT};
case webgl::ComponentType::NormInt:
MOZ_RELEASE_ASSERT(false, "SNORM formats are never color-renderable!");
break;
}
MOZ_CRASH("bad webgl::ComponentType");
}
static bool ArePossiblePackEnums(const webgl::PackingInfo& pi) {
// OpenGL ES 2.0 $4.3.1 - IMPLEMENTATION_COLOR_READ_{TYPE/FORMAT} is a valid
// combination for glReadPixels()...
// Only valid when pulled from:
// * GLES 2.0.25 p105:
// "table 3.4, excluding formats LUMINANCE and LUMINANCE_ALPHA."
// * GLES 3.0.4 p193:
// "table 3.2, excluding formats DEPTH_COMPONENT and DEPTH_STENCIL."
switch (pi.format) {
case LOCAL_GL_LUMINANCE:
case LOCAL_GL_LUMINANCE_ALPHA:
case LOCAL_GL_DEPTH_COMPONENT:
case LOCAL_GL_DEPTH_STENCIL:
return false;
}
if (pi.type == LOCAL_GL_UNSIGNED_INT_24_8) return false;
const auto pii = webgl::PackingInfoInfo::For(pi);
if (!pii) return false;
return true;
}
webgl::PackingInfo WebGLContext::ValidImplementationColorReadPI(
const webgl::FormatUsageInfo* usage) const {
if (const auto implPI = usage->implReadPiCache) return *implPI;
const auto defaultPI = DefaultReadPixelPI(usage);
usage->implReadPiCache = [&]() {
if (StaticPrefs::webgl_porting_strict_readpixels_formats())
return defaultPI;
auto implPI = defaultPI;
// ES2_compatibility always returns RGBA/UNSIGNED_BYTE, so branch on actual
// IsGLES(). Also OSX+NV generates an error here.
if (gl->IsGLES()) {
gl->GetInt(LOCAL_GL_IMPLEMENTATION_COLOR_READ_FORMAT, &implPI.format);
gl->GetInt(LOCAL_GL_IMPLEMENTATION_COLOR_READ_TYPE, &implPI.type);
} else {
if (StaticPrefs::webgl_porting_strict_readpixels_formats_non_es())
return defaultPI;
// Non-ES GL is way more open, and basically supports reading anything.
// (Sucks to be their driver team!)
if (usage->idealUnpack) {
for (const auto& [validPi, validDui] : usage->validUnpacks) {
if (validDui != *usage->idealUnpack) continue;
implPI = validPi;
break;
}
}
}
// Normalize HALF_FLOAT_OES to HALF_FLOAT internally.
if (implPI.type == LOCAL_GL_HALF_FLOAT_OES) {
implPI.type = LOCAL_GL_HALF_FLOAT;
}
if (!ArePossiblePackEnums(implPI)) return defaultPI;
return implPI;
}();
return *usage->implReadPiCache;
}
std::string webgl::format_as(const PackingInfo& pi) {
return fmt::format(FMT_STRING("{}/{}"), pi.format, pi.type);
}
static bool ValidateReadPixelsFormatAndType(
const webgl::FormatUsageInfo* srcUsage, const webgl::PackingInfo& pi,
WebGLContext* webgl) {
if (!ArePossiblePackEnums(pi)) {
webgl->ErrorInvalidEnum("Unexpected format or type.");
return false;
}
const auto defaultPI = DefaultReadPixelPI(srcUsage);
if (pi == defaultPI) return true;
////
// OpenGL ES 3.0.4 p194 - When the internal format of the rendering surface is
// RGB10_A2, a third combination of format RGBA and type
// UNSIGNED_INT_2_10_10_10_REV is accepted.
std::optional<webgl::PackingInfo> bonusValidPi;
if (srcUsage->format->effectiveFormat == webgl::EffectiveFormat::RGB10_A2) {
bonusValidPi =
webgl::PackingInfo{LOCAL_GL_RGBA, LOCAL_GL_UNSIGNED_INT_2_10_10_10_REV};
}
if (bonusValidPi && pi == *bonusValidPi) return true;
////
const auto implPI = webgl->ValidImplementationColorReadPI(srcUsage);
MOZ_ASSERT(pi.type != LOCAL_GL_HALF_FLOAT_OES); // HALF_FLOAT-only
MOZ_ASSERT(implPI.type != LOCAL_GL_HALF_FLOAT_OES); // HALF_FLOAT-only
if (pi == implPI) return true;
////
// Map HALF_FLOAT to HALF_FLOAT_OES for error messages in webgl1.
webgl::PackingInfo clientImplPI = implPI;
if (clientImplPI.type == LOCAL_GL_HALF_FLOAT && !webgl->IsWebGL2()) {
clientImplPI.type = LOCAL_GL_HALF_FLOAT_OES;
}
auto validPiStr =
fmt::format(FMT_STRING("{} (spec-required baseline for format {})"),
defaultPI, srcUsage->format->name);
if (implPI != defaultPI) {
validPiStr += fmt::format(
FMT_STRING(
", or {} (spec-optional implementation-chosen format-dependant"
" IMPLEMENTATION_COLOR_READ_FORMAT/_TYPE)"),
clientImplPI);
}
if (bonusValidPi) {
validPiStr +=
fmt::format(FMT_STRING(", or {} (spec-required bonus for format {})"),
*bonusValidPi, srcUsage->format->name);
}
webgl->ErrorInvalidOperation(
"Format/type %s/%s incompatible with this %s framebuffer. Must use: %s.",
EnumString(pi.format).c_str(), EnumString(pi.type).c_str(),
srcUsage->format->name, validPiStr.c_str());
return false;
}
webgl::ReadPixelsResult WebGLContext::ReadPixelsImpl(
const webgl::ReadPixelsDesc& desc, const uintptr_t dest,
const uint64_t availBytes) {
const webgl::FormatUsageInfo* srcFormat;
uint32_t srcWidth;
uint32_t srcHeight;
if (!BindCurFBForColorRead(&srcFormat, &srcWidth, &srcHeight)) return {};
//////
if (!ValidateReadPixelsFormatAndType(srcFormat, desc.pi, this)) return {};
//////
const auto& srcOffset = desc.srcOffset;
const auto& size = desc.size;
if (!ivec2::From(size)) {
ErrorInvalidValue("width and height must be non-negative.");
return {};
}
const auto& packing = desc.packState;
const auto explicitPackingRes = webgl::ExplicitPixelPackingState::ForUseWith(
packing, LOCAL_GL_TEXTURE_2D, {size.x, size.y, 1}, desc.pi, {});
if (!explicitPackingRes.isOk()) {
ErrorInvalidOperation("%s", explicitPackingRes.inspectErr().c_str());
return {};
}
const auto& explicitPacking = explicitPackingRes.inspect();
const auto& rowStride = explicitPacking.metrics.bytesPerRowStride;
const auto& bytesNeeded = explicitPacking.metrics.totalBytesUsed;
if (bytesNeeded > availBytes) {
ErrorInvalidOperation("buffer too small");
return {};
}
////
int32_t readX, readY;
int32_t writeX, writeY;
int32_t rwWidth, rwHeight;
if (!Intersect(srcWidth, srcOffset.x, size.x, &readX, &writeX, &rwWidth) ||
!Intersect(srcHeight, srcOffset.y, size.y, &readY, &writeY, &rwHeight)) {
ErrorOutOfMemory("Bad subrect selection.");
return {};
}
////////////////
// Now that the errors are out of the way, on to actually reading!
gl->fPixelStorei(LOCAL_GL_PACK_ALIGNMENT, packing.alignmentInTypeElems);
if (IsWebGL2()) {
gl->fPixelStorei(LOCAL_GL_PACK_ROW_LENGTH, packing.rowLength);
gl->fPixelStorei(LOCAL_GL_PACK_SKIP_PIXELS, packing.skipPixels);
gl->fPixelStorei(LOCAL_GL_PACK_SKIP_ROWS, packing.skipRows);
}
if (!rwWidth || !rwHeight) {
// Disjoint rects, so we're done already.
DummyReadFramebufferOperation();
return {};
}
const auto rwSize = *uvec2::From(rwWidth, rwHeight);
const auto res = webgl::ReadPixelsResult{
{{writeX, writeY}, {rwSize.x, rwSize.y}}, rowStride};
if (rwSize == size) {
DoReadPixelsAndConvert(srcFormat->format, desc, dest, bytesNeeded,
rowStride);
return res;
}
// Read request contains out-of-bounds pixels. Unfortunately:
// GLES 3.0.4 p194 "Obtaining Pixels from the Framebuffer":
// "If any of these pixels lies outside of the window allocated to the current
// GL context, or outside of the image attached to the currently bound
// framebuffer object, then the values obtained for those pixels are
// undefined."
// This is a slow-path, so warn people away!
GenerateWarning(
"Out-of-bounds reads with readPixels are deprecated, and"
" may be slow.");
////////////////////////////////////
// Read only the in-bounds pixels.
if (IsWebGL2()) {
if (!packing.rowLength) {
gl->fPixelStorei(LOCAL_GL_PACK_ROW_LENGTH, packing.skipPixels + size.x);
}
gl->fPixelStorei(LOCAL_GL_PACK_SKIP_PIXELS, packing.skipPixels + writeX);
gl->fPixelStorei(LOCAL_GL_PACK_SKIP_ROWS, packing.skipRows + writeY);
auto desc2 = desc;
desc2.srcOffset = {readX, readY};
desc2.size = rwSize;
DoReadPixelsAndConvert(srcFormat->format, desc2, dest, bytesNeeded,
rowStride);
} else {
// I *did* say "hilariously slow".
auto desc2 = desc;
desc2.srcOffset = {readX, readY};
desc2.size = {rwSize.x, 1};
const auto skipBytes = writeX * explicitPacking.metrics.bytesPerPixel;
const auto usedRowBytes = rwSize.x * explicitPacking.metrics.bytesPerPixel;
for (const auto j : IntegerRange(rwSize.y)) {
desc2.srcOffset.y = readY + j;
const auto destWriteBegin = dest + skipBytes + (writeY + j) * rowStride;
MOZ_RELEASE_ASSERT(dest <= destWriteBegin);
MOZ_RELEASE_ASSERT(destWriteBegin <= dest + availBytes);
const auto destWriteEnd = destWriteBegin + usedRowBytes;
MOZ_RELEASE_ASSERT(dest <= destWriteEnd);
MOZ_RELEASE_ASSERT(destWriteEnd <= dest + availBytes);
DoReadPixelsAndConvert(srcFormat->format, desc2, destWriteBegin,
destWriteEnd - destWriteBegin, rowStride);
}
}
return res;
}
void WebGLContext::RenderbufferStorageMultisample(WebGLRenderbuffer& rb,
uint32_t samples,
GLenum internalFormat,
uint32_t width,
uint32_t height) const {
const FuncScope funcScope(*this, "renderbufferStorage(Multisample)?");
if (IsContextLost()) return;
rb.RenderbufferStorage(samples, internalFormat, width, height);
}
void WebGLContext::Scissor(GLint x, GLint y, GLsizei width, GLsizei height) {
const FuncScope funcScope(*this, "scissor");
if (IsContextLost()) return;
if (!ValidateNonNegative("width", width) ||
!ValidateNonNegative("height", height)) {
return;
}
mScissorRect = {x, y, width, height};
mScissorRect.Apply(*gl);
}
void WebGLContext::StencilFuncSeparate(GLenum face, GLenum func, GLint ref,
GLuint mask) {
const FuncScope funcScope(*this, "stencilFuncSeparate");
if (IsContextLost()) return;
if (!ValidateFaceEnum(face) || !ValidateComparisonEnum(*this, func)) {
return;
}
switch (face) {
case LOCAL_GL_FRONT_AND_BACK:
mStencilRefFront = ref;
mStencilRefBack = ref;
mStencilValueMaskFront = mask;
mStencilValueMaskBack = mask;
break;
case LOCAL_GL_FRONT:
mStencilRefFront = ref;
mStencilValueMaskFront = mask;
break;
case LOCAL_GL_BACK:
mStencilRefBack = ref;
mStencilValueMaskBack = mask;
break;
}
gl->fStencilFuncSeparate(face, func, ref, mask);
}
void WebGLContext::StencilOpSeparate(GLenum face, GLenum sfail, GLenum dpfail,
GLenum dppass) {
const FuncScope funcScope(*this, "stencilOpSeparate");
if (IsContextLost()) return;
if (!ValidateFaceEnum(face) || !ValidateStencilOpEnum(sfail, "sfail") ||
!ValidateStencilOpEnum(dpfail, "dpfail") ||
!ValidateStencilOpEnum(dppass, "dppass"))
return;
gl->fStencilOpSeparate(face, sfail, dpfail, dppass);
}
////////////////////////////////////////////////////////////////////////////////
// Uniform setters.
void WebGLContext::UniformData(
const uint32_t loc, const bool transpose,
const Span<const webgl::UniformDataVal>& data) const {
const FuncScope funcScope(*this, "uniform setter");
if (!IsWebGL2() && transpose) {
GenerateError(LOCAL_GL_INVALID_VALUE, "`transpose`:true requires WebGL 2.");
return;
}
// -
const auto& link = mActiveProgramLinkInfo;
if (!link) {
GenerateError(LOCAL_GL_INVALID_OPERATION, "Active program is not linked.");
return;
}
const auto locInfo = MaybeFind(link->locationMap, loc);
if (!locInfo) {
// Null WebGLUniformLocations become -1, which will end up here.
return;
}
const auto& validationInfo = locInfo->info;
const auto& activeInfo = validationInfo.info;
const auto& channels = validationInfo.channelsPerElem;
const auto& pfn = validationInfo.pfn;
// -
const auto lengthInType = data.size();
const auto elemCount = lengthInType / channels;
if (elemCount > 1 && !validationInfo.isArray) {
GenerateError(
LOCAL_GL_INVALID_OPERATION,
"(uniform %s) `values` length (%u) must exactly match size of %s.",
activeInfo.name.c_str(), (uint32_t)lengthInType,
EnumString(activeInfo.elemType).c_str());
return;
}
// -
const auto& samplerInfo = locInfo->samplerInfo;
if (samplerInfo) {
const auto idata = ReinterpretToSpan<const uint32_t>::From(data);
const auto maxTexUnits = GLMaxTextureUnits();
for (const auto& val : idata) {
if (val >= maxTexUnits) {
ErrorInvalidValue(
"This uniform location is a sampler, but %d"
" is not a valid texture unit.",
val);
return;
}
}
}
// -
// This is a little galaxy-brain, sorry!
const auto ptr = static_cast<const void*>(data.data());
(*pfn)(*gl, static_cast<GLint>(loc), elemCount, transpose, ptr);
// -
if (samplerInfo) {
auto& texUnits = samplerInfo->texUnits;
const auto srcBegin = reinterpret_cast<const uint32_t*>(data.data());
auto destIndex = locInfo->indexIntoUniform;
if (destIndex < texUnits.length()) {
// Only sample as many indexes as available tex units allow.
const auto destCount = std::min(elemCount, texUnits.length() - destIndex);
for (const auto& val : Span<const uint32_t>(srcBegin, destCount)) {
texUnits[destIndex] = AssertedCast<uint8_t>(val);
destIndex += 1;
}
}
}
}
////////////////////////////////////////////////////////////////////////////////
void WebGLContext::UseProgram(WebGLProgram* prog) {
FuncScope funcScope(*this, "useProgram");
if (IsContextLost()) return;
funcScope.mBindFailureGuard = true;
if (!prog) {
mCurrentProgram = nullptr;
mActiveProgramLinkInfo = nullptr;
funcScope.mBindFailureGuard = false;
return;
}
if (!ValidateObject("prog", *prog)) return;
if (!prog->UseProgram()) return;
mCurrentProgram = prog;
mActiveProgramLinkInfo = mCurrentProgram->LinkInfo();
funcScope.mBindFailureGuard = false;
}
bool WebGLContext::ValidateProgram(const WebGLProgram& prog) const {
const FuncScope funcScope(*this, "validateProgram");
if (IsContextLost()) return false;
return prog.ValidateProgram();
}
RefPtr<WebGLFramebuffer> WebGLContext::CreateFramebuffer() {
const FuncScope funcScope(*this, "createFramebuffer");
if (IsContextLost()) return nullptr;
GLuint fbo = 0;
gl->fGenFramebuffers(1, &fbo);
return new WebGLFramebuffer(this, fbo);
}
RefPtr<WebGLFramebuffer> WebGLContext::CreateOpaqueFramebuffer(
const webgl::OpaqueFramebufferOptions& options) {
const FuncScope funcScope(*this, "createOpaqueFramebuffer");
if (IsContextLost()) return nullptr;
uint32_t samples = options.antialias ? StaticPrefs::webgl_msaa_samples() : 0;
samples = std::min(samples, gl->MaxSamples());
const gfx::IntSize size = {options.width, options.height};
auto fbo =
gl::MozFramebuffer::Create(gl, size, samples, options.depthStencil);
if (!fbo) {
return nullptr;
}
return new WebGLFramebuffer(this, std::move(fbo));
}
RefPtr<WebGLRenderbuffer> WebGLContext::CreateRenderbuffer() {
const FuncScope funcScope(*this, "createRenderbuffer");
if (IsContextLost()) return nullptr;
return new WebGLRenderbuffer(this);
}
void WebGLContext::Viewport(GLint x, GLint y, GLsizei width, GLsizei height) {
const FuncScope funcScope(*this, "viewport");
if (IsContextLost()) return;
if (!ValidateNonNegative("width", width) ||
!ValidateNonNegative("height", height)) {
return;
}
const auto& limits = Limits();
width = std::min(width, static_cast<GLsizei>(limits.maxViewportDim));
height = std::min(height, static_cast<GLsizei>(limits.maxViewportDim));
gl->fViewport(x, y, width, height);
mViewportX = x;
mViewportY = y;
mViewportWidth = width;
mViewportHeight = height;
}
void WebGLContext::CompileShader(WebGLShader& shader) {
const FuncScope funcScope(*this, "compileShader");
if (IsContextLost()) return;
if (!ValidateObject("shader", shader)) return;
shader.CompileShader();
}
void WebGLContext::ShaderSource(WebGLShader& shader,
const std::string& source) const {
const FuncScope funcScope(*this, "shaderSource");
if (IsContextLost()) return;
shader.ShaderSource(source);
}
void WebGLContext::BlendColor(GLfloat r, GLfloat g, GLfloat b, GLfloat a) {
const FuncScope funcScope(*this, "blendColor");
if (IsContextLost()) return;
gl->fBlendColor(r, g, b, a);
}
void WebGLContext::Flush() {
const FuncScope funcScope(*this, "flush");
if (IsContextLost()) return;
gl->fFlush();
}
void WebGLContext::Finish() {
const FuncScope funcScope(*this, "finish");
if (IsContextLost()) return;
gl->fFinish();
mCompletedFenceId = mNextFenceId;
mNextFenceId += 1;
}
void WebGLContext::LineWidth(GLfloat width) {
const FuncScope funcScope(*this, "lineWidth");
if (IsContextLost()) return;
// Doing it this way instead of `if (width <= 0.0)` handles NaNs.
const bool isValid = width > 0.0;
if (!isValid) {
ErrorInvalidValue("`width` must be positive and non-zero.");
return;
}
mLineWidth = width;
if (gl->IsCoreProfile() && width > 1.0) {
width = 1.0;
}
gl->fLineWidth(width);
}
void WebGLContext::PolygonOffset(GLfloat factor, GLfloat units) {
const FuncScope funcScope(*this, "polygonOffset");
if (IsContextLost()) return;
gl->fPolygonOffset(factor, units);
}
void WebGLContext::ProvokingVertex(const webgl::ProvokingVertex mode) const {
const FuncScope funcScope(*this, "provokingVertex");
if (IsContextLost()) return;
MOZ_RELEASE_ASSERT(
IsExtensionEnabled(WebGLExtensionID::WEBGL_provoking_vertex));
gl->fProvokingVertex(UnderlyingValue(mode));
}
void WebGLContext::SampleCoverage(GLclampf value, WebGLboolean invert) {
const FuncScope funcScope(*this, "sampleCoverage");
if (IsContextLost()) return;
gl->fSampleCoverage(value, invert);
}
} // namespace mozilla
|