Hash :
50704dc3
Author :
Date :
2020-08-04T12:08:00
Metal: Implement EXT_occlusion_query_boolean.
- Metal's occlusion(called visibility) query operates per render pass.
Implementation details are in
src/libANGLE/renderer/metal/doc/OcclusionQueries.md.
- New tests:
- OcclusionQueriesTest.ClearNotCounted.
- OcclusionQueriesTest.MultiQueries (failure on OpenGL/D3D11
back-end).
Bug: angleproject:2634
Change-Id: Idd1327b5472d0e8c2b69307a7f04a1da4a847a40
Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/2336121
Commit-Queue: Le Hoang Quyen <le.hoang.q@gmail.com>
Reviewed-by: back sept 10 - Jamie Madill <jmadill@chromium.org>
Reviewed-by: Jonah Ryan-Davis <jonahr@google.com>
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
//
// Copyright 2015 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
#include "test_utils/ANGLETest.h"
#include "util/EGLWindow.h"
#include "util/random_utils.h"
#include "util/test_utils.h"
using namespace angle;
class OcclusionQueriesTest : public ANGLETest
{
protected:
OcclusionQueriesTest() : mProgram(0), mRNG(1)
{
setWindowWidth(128);
setWindowHeight(128);
setConfigRedBits(8);
setConfigGreenBits(8);
setConfigBlueBits(8);
setConfigAlphaBits(8);
setConfigDepthBits(24);
}
void testSetUp() override
{
mProgram = CompileProgram(essl1_shaders::vs::Simple(), essl1_shaders::fs::Red());
ASSERT_NE(0u, mProgram);
}
void testTearDown() override { glDeleteProgram(mProgram); }
GLuint mProgram;
RNG mRNG;
};
TEST_P(OcclusionQueriesTest, IsOccluded)
{
ANGLE_SKIP_TEST_IF(getClientMajorVersion() < 3 &&
!IsGLExtensionEnabled("GL_EXT_occlusion_query_boolean"));
glDepthMask(GL_TRUE);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
// draw a quad at depth 0.3
glEnable(GL_DEPTH_TEST);
glUseProgram(mProgram);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.3f);
glUseProgram(0);
EXPECT_GL_NO_ERROR();
GLuint query = 0;
glGenQueriesEXT(1, &query);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query);
drawQuad(mProgram, essl1_shaders::PositionAttrib(),
0.8f); // this quad should be occluded by first quad
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
EXPECT_GL_NO_ERROR();
swapBuffers();
GLuint ready = GL_FALSE;
while (ready == GL_FALSE)
{
angle::Sleep(0);
glGetQueryObjectuivEXT(query, GL_QUERY_RESULT_AVAILABLE_EXT, &ready);
}
GLuint result = GL_TRUE;
glGetQueryObjectuivEXT(query, GL_QUERY_RESULT_EXT, &result);
EXPECT_GL_NO_ERROR();
glDeleteQueriesEXT(1, &query);
EXPECT_GL_FALSE(result);
}
TEST_P(OcclusionQueriesTest, IsNotOccluded)
{
ANGLE_SKIP_TEST_IF(getClientMajorVersion() < 3 &&
!IsGLExtensionEnabled("GL_EXT_occlusion_query_boolean"));
// TODO(syoussefi): Using render pass ops to clear the framebuffer attachment results in
// AMD/Windows misbehaving in this test. http://anglebug.com/3286
ANGLE_SKIP_TEST_IF(IsWindows() && IsAMD() && IsVulkan());
glDepthMask(GL_TRUE);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
EXPECT_GL_NO_ERROR();
GLuint query = 0;
glGenQueriesEXT(1, &query);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f); // this quad should not be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
EXPECT_GL_NO_ERROR();
swapBuffers();
GLuint result = GL_TRUE;
glGetQueryObjectuivEXT(query, GL_QUERY_RESULT_EXT, &result); // will block waiting for result
EXPECT_GL_NO_ERROR();
glDeleteQueriesEXT(1, &query);
EXPECT_GL_TRUE(result);
}
// Test that glClear should not be counted by occlusion query.
TEST_P(OcclusionQueriesTest, ClearNotCounted)
{
ANGLE_SKIP_TEST_IF(getClientMajorVersion() < 3 &&
!IsGLExtensionEnabled("GL_EXT_occlusion_query_boolean"));
// TODO(syoussefi): Using render pass ops to clear the framebuffer attachment results in
// AMD/Windows misbehaving in this test. http://anglebug.com/3286
ANGLE_SKIP_TEST_IF(IsWindows() && IsAMD() && IsVulkan());
// http://anglebug.com/4925
ANGLE_SKIP_TEST_IF(IsD3D11());
glDepthMask(GL_TRUE);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
EXPECT_GL_NO_ERROR();
GLuint query[2] = {0};
glGenQueriesEXT(2, query);
// First query
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[0]);
// Full screen clear
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
// View port clear
glViewport(0, 0, getWindowWidth() / 2, getWindowHeight());
glScissor(0, 0, getWindowWidth() / 2, getWindowHeight());
glEnable(GL_SCISSOR_TEST);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
EXPECT_GL_NO_ERROR();
// Second query
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[1]);
// View port clear
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
// View port clear
glViewport(0, 0, getWindowWidth() / 2, getWindowHeight());
glScissor(0, 0, getWindowWidth() / 2, getWindowHeight());
glEnable(GL_SCISSOR_TEST);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
// this quad should not be occluded
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f, 0.5f);
// Clear again
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
// this quad should not be occluded
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f, 1.0);
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
EXPECT_GL_NO_ERROR();
swapBuffers();
GLuint result[2] = {GL_TRUE, GL_TRUE};
glGetQueryObjectuivEXT(query[0], GL_QUERY_RESULT_EXT,
&result[0]); // will block waiting for result
glGetQueryObjectuivEXT(query[1], GL_QUERY_RESULT_EXT,
&result[1]); // will block waiting for result
EXPECT_GL_NO_ERROR();
glDeleteQueriesEXT(2, query);
EXPECT_GL_FALSE(result[0]);
EXPECT_GL_TRUE(result[1]);
}
// Test multiple occlusion queries.
TEST_P(OcclusionQueriesTest, MultiQueries)
{
ANGLE_SKIP_TEST_IF(getClientMajorVersion() < 3 &&
!IsGLExtensionEnabled("GL_EXT_occlusion_query_boolean"));
// TODO(syoussefi): Using render pass ops to clear the framebuffer attachment results in
// AMD/Windows misbehaving in this test. http://anglebug.com/3286
ANGLE_SKIP_TEST_IF(IsWindows() && IsAMD() && IsVulkan());
// http://anglebug.com/4925
ANGLE_SKIP_TEST_IF(IsOpenGL() || IsD3D11());
// http://anglebug.com/4925
ANGLE_SKIP_TEST_IF(IsMetal() && IsNVIDIA());
GLuint query[5] = {};
glGenQueriesEXT(5, query);
// First query
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[0]);
EXPECT_GL_NO_ERROR();
glEnable(GL_DEPTH_TEST);
glDepthMask(GL_TRUE);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
EXPECT_GL_NO_ERROR();
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f); // this quad should not be occluded
EXPECT_GL_NO_ERROR();
// A flush shound't clear the query result
glFlush();
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), -2, 0.25f); // this quad should be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
// First query ends
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f,
0.25f); // this quad should not be occluded
// Second query
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[1]);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.9f,
0.25f); // this quad should be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
// Third query
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[2]);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.9f,
0.5f); // this quad should not be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
// ------------
glFlush();
glViewport(0, 0, getWindowWidth() / 2, getWindowHeight());
glScissor(0, 0, getWindowWidth() / 2, getWindowHeight());
glEnable(GL_SCISSOR_TEST);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.9f,
0.5f); // this quad should not be occluded
// Fourth query: begin query then end then begin again
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[3]);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.9f,
1); // this quad should not be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[3]);
EXPECT_GL_NO_ERROR();
// glClear should not be counted toward query);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
// Fifth query spans across frames
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query[4]);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f,
0.25f); // this quad should not be occluded
swapBuffers();
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.9f,
0.5f); // this quad should not be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
GLuint result = GL_TRUE;
glGetQueryObjectuivEXT(query[0], GL_QUERY_RESULT_EXT,
&result); // will block waiting for result
EXPECT_GL_NO_ERROR();
EXPECT_GL_TRUE(result);
glGetQueryObjectuivEXT(query[1], GL_QUERY_RESULT_EXT,
&result); // will block waiting for result
EXPECT_GL_NO_ERROR();
EXPECT_GL_FALSE(result);
glGetQueryObjectuivEXT(query[2], GL_QUERY_RESULT_EXT,
&result); // will block waiting for result
EXPECT_GL_NO_ERROR();
EXPECT_GL_TRUE(result);
glGetQueryObjectuivEXT(query[3], GL_QUERY_RESULT_EXT,
&result); // will block waiting for result
EXPECT_GL_NO_ERROR();
EXPECT_GL_FALSE(result);
glGetQueryObjectuivEXT(query[4], GL_QUERY_RESULT_EXT,
&result); // will block waiting for result
EXPECT_GL_NO_ERROR();
EXPECT_GL_TRUE(result);
glDeleteQueriesEXT(5, query);
}
TEST_P(OcclusionQueriesTest, Errors)
{
ANGLE_SKIP_TEST_IF(getClientMajorVersion() < 3 &&
!IsGLExtensionEnabled("GL_EXT_occlusion_query_boolean"));
glDepthMask(GL_TRUE);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
EXPECT_GL_NO_ERROR();
GLuint query = 0;
GLuint query2 = 0;
glGenQueriesEXT(1, &query);
EXPECT_GL_FALSE(glIsQueryEXT(query));
EXPECT_GL_FALSE(glIsQueryEXT(query2));
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, 0); // can't pass 0 as query id
EXPECT_GL_ERROR(GL_INVALID_OPERATION);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, query);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_CONSERVATIVE_EXT,
query2); // can't initiate a query while one's already active
EXPECT_GL_ERROR(GL_INVALID_OPERATION);
EXPECT_GL_TRUE(glIsQueryEXT(query));
EXPECT_GL_FALSE(glIsQueryEXT(query2)); // have not called begin
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.8f); // this quad should not be occluded
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_CONSERVATIVE_EXT); // no active query for this target
EXPECT_GL_ERROR(GL_INVALID_OPERATION);
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_CONSERVATIVE_EXT,
query); // can't begin a query as a different type than previously used
EXPECT_GL_ERROR(GL_INVALID_OPERATION);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_CONSERVATIVE_EXT,
query2); // have to call genqueries first
EXPECT_GL_ERROR(GL_INVALID_OPERATION);
glGenQueriesEXT(1, &query2);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_CONSERVATIVE_EXT, query2); // should be ok now
EXPECT_GL_TRUE(glIsQueryEXT(query2));
drawQuad(mProgram, essl1_shaders::PositionAttrib(),
0.3f); // this should draw in front of other quad
glDeleteQueriesEXT(1, &query2); // should delete when query becomes inactive
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_CONSERVATIVE_EXT); // should not incur error; should delete
// query + 1 at end of execution.
EXPECT_GL_NO_ERROR();
swapBuffers();
EXPECT_GL_NO_ERROR();
GLuint ready = GL_FALSE;
glGetQueryObjectuivEXT(query2, GL_QUERY_RESULT_AVAILABLE_EXT,
&ready); // this query is now deleted
EXPECT_GL_ERROR(GL_INVALID_OPERATION);
EXPECT_GL_NO_ERROR();
}
// Test that running multiple simultaneous queries from multiple EGL contexts returns the correct
// result for each query. Helps expose bugs in ANGLE's virtual contexts.
TEST_P(OcclusionQueriesTest, MultiContext)
{
ANGLE_SKIP_TEST_IF(getClientMajorVersion() < 3 &&
!IsGLExtensionEnabled("GL_EXT_occlusion_query_boolean"));
// TODO(cwallez@chromium.org): Suppression for http://anglebug.com/3080
ANGLE_SKIP_TEST_IF(IsWindows() && IsNVIDIA() && IsVulkan());
// Test skipped because the D3D backends cannot support simultaneous queries on multiple
// contexts yet. Same with the Vulkan backend.
ANGLE_SKIP_TEST_IF(GetParam() == ES2_D3D9() || GetParam() == ES2_D3D11() ||
GetParam() == ES3_D3D11() || GetParam() == ES2_VULKAN());
// http://anglebug.com/4092
ANGLE_SKIP_TEST_IF(IsVulkan());
glDepthMask(GL_TRUE);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
// draw a quad at depth 0.5
glEnable(GL_DEPTH_TEST);
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.5f);
EGLWindow *window = getEGLWindow();
EGLDisplay display = window->getDisplay();
EGLConfig config = window->getConfig();
EGLSurface surface = window->getSurface();
EGLint contextAttributes[] = {
EGL_CONTEXT_MAJOR_VERSION_KHR,
GetParam().majorVersion,
EGL_CONTEXT_MINOR_VERSION_KHR,
GetParam().minorVersion,
EGL_NONE,
};
const size_t passCount = 5;
struct ContextInfo
{
EGLContext context;
GLuint program;
GLuint query;
bool visiblePasses[passCount];
bool shouldPass;
};
ContextInfo contexts[] = {
{
EGL_NO_CONTEXT,
0,
0,
{false, false, false, false, false},
false,
},
{
EGL_NO_CONTEXT,
0,
0,
{false, true, false, true, false},
true,
},
{
EGL_NO_CONTEXT,
0,
0,
{false, false, false, false, false},
false,
},
{
EGL_NO_CONTEXT,
0,
0,
{true, true, false, true, true},
true,
},
{
EGL_NO_CONTEXT,
0,
0,
{false, true, true, true, true},
true,
},
{
EGL_NO_CONTEXT,
0,
0,
{true, false, false, true, false},
true,
},
{
EGL_NO_CONTEXT,
0,
0,
{false, false, false, false, false},
false,
},
{
EGL_NO_CONTEXT,
0,
0,
{false, false, false, false, false},
false,
},
};
for (auto &context : contexts)
{
context.context = eglCreateContext(display, config, EGL_NO_CONTEXT, contextAttributes);
ASSERT_NE(context.context, EGL_NO_CONTEXT);
eglMakeCurrent(display, surface, surface, context.context);
context.program = CompileProgram(essl1_shaders::vs::Simple(), essl1_shaders::fs::Red());
ASSERT_NE(context.program, 0u);
glDepthMask(GL_FALSE);
glEnable(GL_DEPTH_TEST);
glGenQueriesEXT(1, &context.query);
glBeginQueryEXT(GL_ANY_SAMPLES_PASSED_EXT, context.query);
ASSERT_GL_NO_ERROR();
}
for (size_t pass = 0; pass < passCount; pass++)
{
for (const auto &context : contexts)
{
eglMakeCurrent(display, surface, surface, context.context);
float depth = context.visiblePasses[pass] ? mRNG.randomFloatBetween(0.0f, 0.4f)
: mRNG.randomFloatBetween(0.6f, 1.0f);
drawQuad(context.program, essl1_shaders::PositionAttrib(), depth);
EXPECT_GL_NO_ERROR();
}
}
for (const auto &context : contexts)
{
eglMakeCurrent(display, surface, surface, context.context);
glEndQueryEXT(GL_ANY_SAMPLES_PASSED_EXT);
GLuint result = GL_TRUE;
glGetQueryObjectuivEXT(context.query, GL_QUERY_RESULT_EXT, &result);
EXPECT_GL_NO_ERROR();
GLuint expectation = context.shouldPass ? GL_TRUE : GL_FALSE;
EXPECT_EQ(expectation, result);
}
eglMakeCurrent(display, surface, surface, window->getContext());
for (auto &context : contexts)
{
eglDestroyContext(display, context.context);
context.context = EGL_NO_CONTEXT;
}
}
// Use this to select which configurations (e.g. which renderer, which GLES major version) these
// tests should be run against.
ANGLE_INSTANTIATE_TEST_ES2_AND_ES3(OcclusionQueriesTest);