Hash :
925ec6b5
Author :
Date :
2022-07-07T00:00:00
Clamp viewport dimensions on store Bug: angleproject:7486 Bug: chromium:1130759 Change-Id: I6131baacc940b5df7e33ba10fca8e6e148cb8670 Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/3751056 Reviewed-by: Kenneth Russell <kbr@chromium.org> Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org> Commit-Queue: Alexey Knyazev <lexa.knyazev@gmail.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
//
// 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 "test_utils/gl_raii.h"
using namespace angle;
namespace
{
class ViewportTest : public ANGLETest<>
{
protected:
ViewportTest()
{
setWindowWidth(512);
setWindowHeight(512);
setConfigRedBits(8);
setConfigGreenBits(8);
setConfigBlueBits(8);
setConfigAlphaBits(8);
setConfigDepthBits(24);
mProgram = 0;
}
void runNonScissoredTest()
{
glClearColor(0, 0, 0, 1);
glClear(GL_COLOR_BUFFER_BIT);
runTest();
}
void runScissoredTest()
{
glClearColor(0, 0, 0, 1);
glClear(GL_COLOR_BUFFER_BIT);
glEnable(GL_SCISSOR_TEST);
glScissor(0, getWindowHeight() / 2, getWindowWidth(), getWindowHeight() / 2);
runTest();
}
void runTest()
{
// Firstly ensure that no errors have been hit.
EXPECT_GL_NO_ERROR();
GLint viewportSize[4];
glGetIntegerv(GL_VIEWPORT, viewportSize);
// Clear to green. Might be a scissored clear, if scissorSize != window size
glClearColor(0, 1, 0, 1);
glClear(GL_COLOR_BUFFER_BIT);
// Draw a red quad centered in the middle of the viewport, with dimensions 25% of the size
// of the viewport.
drawQuad(mProgram, essl1_shaders::PositionAttrib(), 0.5f, 0.25f);
GLint centerViewportX = viewportSize[0] + (viewportSize[2] / 2);
GLint centerViewportY = viewportSize[1] + (viewportSize[3] / 2);
GLint redQuadLeftSideX = viewportSize[0] + viewportSize[2] * 3 / 8;
GLint redQuadRightSideX = viewportSize[0] + viewportSize[2] * 5 / 8;
GLint redQuadTopSideY = viewportSize[1] + viewportSize[3] * 3 / 8;
GLint redQuadBottomSideY = viewportSize[1] + viewportSize[3] * 5 / 8;
// The midpoint of the viewport should be red.
checkPixel(centerViewportX, centerViewportY, true);
// Pixels just inside the red quad should be red.
checkPixel(redQuadLeftSideX, redQuadTopSideY, true);
checkPixel(redQuadLeftSideX, redQuadBottomSideY - 1, true);
checkPixel(redQuadRightSideX - 1, redQuadTopSideY, true);
checkPixel(redQuadRightSideX - 1, redQuadBottomSideY - 1, true);
// Pixels just outside the red quad shouldn't be red.
checkPixel(redQuadLeftSideX - 1, redQuadTopSideY - 1, false);
checkPixel(redQuadLeftSideX - 1, redQuadBottomSideY, false);
checkPixel(redQuadRightSideX, redQuadTopSideY - 1, false);
checkPixel(redQuadRightSideX, redQuadBottomSideY, false);
// Pixels just within the viewport shouldn't be red.
checkPixel(viewportSize[0], viewportSize[1], false);
checkPixel(viewportSize[0], viewportSize[1] + viewportSize[3] - 1, false);
checkPixel(viewportSize[0] + viewportSize[2] - 1, viewportSize[1], false);
checkPixel(viewportSize[0] + viewportSize[2] - 1, viewportSize[1] + viewportSize[3] - 1,
false);
}
void checkPixel(GLint x, GLint y, GLboolean renderedRed)
{
// By default, expect the pixel to be black.
GLint expectedRedChannel = 0;
GLint expectedGreenChannel = 0;
GLint scissorSize[4];
glGetIntegerv(GL_SCISSOR_BOX, scissorSize);
EXPECT_GL_NO_ERROR();
if (scissorSize[0] <= x && x < scissorSize[0] + scissorSize[2] && scissorSize[1] <= y &&
y < scissorSize[1] + scissorSize[3])
{
// If the pixel lies within the scissor rect, then it should have been cleared to green.
// If we rendered a red square on top of it, then the pixel should be red (the green
// channel will have been reset to 0).
expectedRedChannel = renderedRed ? 255 : 0;
expectedGreenChannel = renderedRed ? 0 : 255;
}
// If the pixel is within the bounds of the window, then we check it. Otherwise we skip it.
if (0 <= x && x < getWindowWidth() && 0 <= y && y < getWindowHeight())
{
EXPECT_PIXEL_EQ(x, y, expectedRedChannel, expectedGreenChannel, 0, 255);
}
}
void testSetUp() override
{
mProgram = CompileProgram(essl1_shaders::vs::Simple(), essl1_shaders::fs::Red());
if (mProgram == 0)
{
FAIL() << "shader compilation failed.";
}
glUseProgram(mProgram);
glClearColor(0, 0, 0, 1);
glClearDepthf(0.0);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
// Call glViewport and glScissor with default parameters.
glScissor(0, 0, getWindowWidth(), getWindowHeight());
glViewport(0, 0, getWindowWidth(), getWindowHeight());
glDisable(GL_DEPTH_TEST);
}
void testTearDown() override { glDeleteProgram(mProgram); }
GLuint mProgram;
};
TEST_P(ViewportTest, QuarterWindow)
{
glViewport(0, 0, getWindowWidth() / 4, getWindowHeight() / 4);
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, QuarterWindowCentered)
{
glViewport(getWindowWidth() * 3 / 8, getWindowHeight() * 3 / 8, getWindowWidth() / 4,
getWindowHeight() / 4);
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, FullWindow)
{
glViewport(0, 0, getWindowWidth(), getWindowHeight());
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, FullWindowOffCenter)
{
glViewport(-getWindowWidth() / 2, getWindowHeight() / 2, getWindowWidth(), getWindowHeight());
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, DoubleWindow)
{
glViewport(0, 0, getWindowWidth() * 2, getWindowHeight() * 2);
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, DoubleWindowCentered)
{
glViewport(-getWindowWidth() / 2, -getWindowHeight() / 2, getWindowWidth() * 2,
getWindowHeight() * 2);
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, DoubleWindowOffCenter)
{
glViewport(-getWindowWidth() * 3 / 4, getWindowHeight() * 3 / 4, getWindowWidth(),
getWindowHeight());
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, TripleWindow)
{
glViewport(0, 0, getWindowWidth() * 3, getWindowHeight() * 3);
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, TripleWindowCentered)
{
glViewport(-getWindowWidth(), -getWindowHeight(), getWindowWidth() * 3, getWindowHeight() * 3);
runNonScissoredTest();
runScissoredTest();
}
TEST_P(ViewportTest, TripleWindowOffCenter)
{
glViewport(-getWindowWidth() * 3 / 2, -getWindowHeight() * 3 / 2, getWindowWidth() * 3,
getWindowHeight() * 3);
runNonScissoredTest();
runScissoredTest();
}
// Test line rendering with a non-standard viewport.
TEST_P(ViewportTest, DrawLineWithViewport)
{
// We assume in the test the width and height are equal and we are tracing
// the line from bottom left to top right. Verify that all pixels along that line
// have been traced with green.
ASSERT_EQ(getWindowWidth(), getWindowHeight());
ANGLE_GL_PROGRAM(program, essl1_shaders::vs::Simple(), essl1_shaders::fs::Green());
glUseProgram(program);
std::vector<Vector3> vertices = {{-1.0f, -1.0f, 0.0f}, {1.0f, 1.0f, 0.0f}};
const GLint positionLocation = glGetAttribLocation(program, essl1_shaders::PositionAttrib());
ASSERT_NE(-1, positionLocation);
GLBuffer vertexBuffer;
glBindBuffer(GL_ARRAY_BUFFER, vertexBuffer);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices[0]) * vertices.size(), vertices.data(),
GL_STATIC_DRAW);
glVertexAttribPointer(positionLocation, 3, GL_FLOAT, GL_FALSE, 0, nullptr);
glEnableVertexAttribArray(positionLocation);
// Set the viewport.
GLint quarterWidth = getWindowWidth() / 4;
GLint quarterHeight = getWindowHeight() / 4;
glViewport(quarterWidth, quarterHeight, quarterWidth, quarterHeight);
glClear(GL_COLOR_BUFFER_BIT);
glDrawArrays(GL_LINES, 0, static_cast<GLsizei>(vertices.size()));
glDisableVertexAttribArray(positionLocation);
ASSERT_GL_NO_ERROR();
for (GLint x = quarterWidth; x < getWindowWidth() / 2; x++)
{
EXPECT_PIXEL_COLOR_EQ(x, x, GLColor::green);
}
}
// Test line rendering with an overly large viewport.
TEST_P(ViewportTest, DrawLineWithLargeViewport)
{
// We assume in the test the width and height are equal and we are tracing
// the line from bottom left to top right. Verify that all pixels along that line
// have been traced with green.
ASSERT_EQ(getWindowWidth(), getWindowHeight());
ANGLE_GL_PROGRAM(program, essl1_shaders::vs::Simple(), essl1_shaders::fs::Green());
glUseProgram(program);
std::vector<Vector3> vertices = {{-1.0f, -1.0f, 0.0f}, {1.0f, 1.0f, 0.0f}};
const GLint positionLocation = glGetAttribLocation(program, essl1_shaders::PositionAttrib());
ASSERT_NE(-1, positionLocation);
GLBuffer vertexBuffer;
glBindBuffer(GL_ARRAY_BUFFER, vertexBuffer);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices[0]) * vertices.size(), vertices.data(),
GL_STATIC_DRAW);
glVertexAttribPointer(positionLocation, 3, GL_FLOAT, GL_FALSE, 0, nullptr);
glEnableVertexAttribArray(positionLocation);
// Set the viewport.
glViewport(0, 0, getWindowWidth() * 2, getWindowHeight() * 2);
glClear(GL_COLOR_BUFFER_BIT);
glDrawArrays(GL_LINES, 0, static_cast<GLsizei>(vertices.size()));
glDisableVertexAttribArray(positionLocation);
ASSERT_GL_NO_ERROR();
for (GLint x = 0; x < getWindowWidth(); x++)
{
EXPECT_PIXEL_COLOR_EQ(x, x, GLColor::green);
}
}
// Test very large viewport sizes so sanitizers can verify there is no undefined behaviour
TEST_P(ViewportTest, Overflow)
{
ANGLE_GL_PROGRAM(program, essl1_shaders::vs::Simple(), essl1_shaders::fs::Green());
glUseProgram(program);
std::vector<Vector3> vertices = {{-1.0f, -1.0f, 0.0f}, {1.0f, 1.0f, 0.0f}};
const GLint positionLocation = glGetAttribLocation(program, essl1_shaders::PositionAttrib());
ASSERT_NE(-1, positionLocation);
GLBuffer vertexBuffer;
glBindBuffer(GL_ARRAY_BUFFER, vertexBuffer);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices[0]) * vertices.size(), vertices.data(),
GL_STATIC_DRAW);
glVertexAttribPointer(positionLocation, 3, GL_FLOAT, GL_FALSE, 0, nullptr);
glEnableVertexAttribArray(positionLocation);
constexpr int kMaxSize = std::numeric_limits<int>::max();
const int kTestViewportSizes[][4] = {
{
kMaxSize,
kMaxSize,
1,
1,
},
{
0,
0,
kMaxSize,
kMaxSize,
},
{
1,
1,
kMaxSize,
kMaxSize,
},
{
kMaxSize,
kMaxSize,
kMaxSize,
kMaxSize,
},
};
for (const int *viewportSize : kTestViewportSizes)
{
// Set the viewport.
glViewport(viewportSize[0], viewportSize[1], viewportSize[2], viewportSize[3]);
glClear(GL_COLOR_BUFFER_BIT);
glDrawArrays(GL_LINES, 0, static_cast<GLsizei>(vertices.size()));
glDisableVertexAttribArray(positionLocation);
ASSERT_GL_NO_ERROR();
}
}
// Test that viewport dimensions are clamped to implementation-defined maximums
TEST_P(ViewportTest, ClampOnStore)
{
GLint maxDims[2];
glGetIntegerv(GL_MAX_VIEWPORT_DIMS, maxDims);
ASSERT_GT(maxDims[0], 0);
ASSERT_GT(maxDims[1], 0);
GLint viewport[4];
glViewport(0, 0, 1, 1);
ASSERT_GL_NO_ERROR();
glGetIntegerv(GL_VIEWPORT, viewport);
ASSERT_EQ(viewport[0], 0);
ASSERT_EQ(viewport[1], 0);
ASSERT_EQ(viewport[2], 1);
ASSERT_EQ(viewport[3], 1);
glViewport(0, 0, -2, 2);
ASSERT_GL_ERROR(GL_INVALID_VALUE);
glGetIntegerv(GL_VIEWPORT, viewport);
ASSERT_EQ(viewport[0], 0);
ASSERT_EQ(viewport[1], 0);
ASSERT_EQ(viewport[2], 1);
ASSERT_EQ(viewport[3], 1);
glViewport(0, 0, 3, -3);
ASSERT_GL_ERROR(GL_INVALID_VALUE);
glGetIntegerv(GL_VIEWPORT, viewport);
ASSERT_EQ(viewport[0], 0);
ASSERT_EQ(viewport[1], 0);
ASSERT_EQ(viewport[2], 1);
ASSERT_EQ(viewport[3], 1);
glViewport(0, 0, maxDims[0], maxDims[1]);
ASSERT_GL_NO_ERROR();
glGetIntegerv(GL_VIEWPORT, viewport);
ASSERT_EQ(viewport[0], 0);
ASSERT_EQ(viewport[1], 0);
ASSERT_EQ(viewport[2], maxDims[0]);
ASSERT_EQ(viewport[3], maxDims[1]);
glViewport(0, 0, maxDims[0] + 1, maxDims[1] + 1);
ASSERT_GL_NO_ERROR();
glGetIntegerv(GL_VIEWPORT, viewport);
ASSERT_EQ(viewport[0], 0);
ASSERT_EQ(viewport[1], 0);
ASSERT_EQ(viewport[2], maxDims[0]);
ASSERT_EQ(viewport[3], maxDims[1]);
}
// Use this to select which configurations (e.g. which renderer, which GLES major version) these
// tests should be run against. D3D11 Feature Level 9 and D3D9 emulate large and negative viewports
// in the vertex shader. We should test both of these as well as D3D11 Feature Level 10_0+.
ANGLE_INSTANTIATE_TEST(ViewportTest,
ES2_D3D9(),
ES2_D3D11(),
ES2_D3D11_PRESENT_PATH_FAST(),
ES2_OPENGLES(),
ES3_OPENGLES(),
ES2_METAL(),
ES2_OPENGL(),
ES2_VULKAN());
// This test suite is not instantiated on some OSes.
GTEST_ALLOW_UNINSTANTIATED_PARAMETERIZED_TEST(ViewportTest);
} // namespace