Edit

kc3-lang/angle/src/tests/compiler_tests/EmulateGLBaseVertexBaseInstance_test.cpp

Branch :

  • Show log

    Commit

  • Author : shrekshao
    Date : 2019-06-18 17:24:54
    Hash : cdab03aa
    Message : Add flags to shader translator to emulate gl_BaseVertex and gl_BaseInstance Adds support for translating gl_BaseVertex and gl_BaseInstance for implementation of GL_ANGLE_base_vertex_base_instance. They will only be available in WebGL 2. Since there's no gl_VertexID and gl_InstanceID in WebGL 1. It won't be very useful to add them to WebGL 1. Mostly follow pattern of gl_DrawID of GL_multi_draw BUG=angleproject:3402,chromium:891861 Change-Id: Ifcd990c52d12f6814127b904e61a779b8d382e0c Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/1666361 Commit-Queue: Shrek Shao <shrekshao@google.com> Reviewed-by: Jamie Madill <jmadill@chromium.org>

  • src/tests/compiler_tests/EmulateGLBaseVertexBaseInstance_test.cpp
  • //
    // Copyright 2019 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.
    //
    // ANGLE_base_vertex_base_instance.cpp:
    //   Test for ANGLE_base_vertex_base_instance extension
    //
    
    #include "GLSLANG/ShaderLang.h"
    #include "angle_gl.h"
    #include "compiler/translator/tree_ops/EmulateMultiDrawShaderBuiltins.h"
    #include "gtest/gtest.h"
    #include "tests/test_utils/compiler_test.h"
    
    using namespace sh;
    
    class EmulateGLBaseVertexBaseInstanceTest : public MatchOutputCodeTest
    {
      public:
        EmulateGLBaseVertexBaseInstanceTest()
            : MatchOutputCodeTest(GL_VERTEX_SHADER, SH_VARIABLES, SH_GLSL_COMPATIBILITY_OUTPUT)
        {
            getResources()->ANGLE_base_vertex_base_instance = 1;
        }
    
      protected:
        void CheckCompileFailure(const std::string &shaderString, const char *expectedError = nullptr)
        {
            std::string translatedCode;
            std::string infoLog;
            bool success = compileTestShader(GL_VERTEX_SHADER, SH_GLES2_SPEC,
                                             SH_GLSL_COMPATIBILITY_OUTPUT, shaderString, getResources(),
                                             SH_VARIABLES, &translatedCode, &infoLog);
            EXPECT_FALSE(success);
            if (expectedError)
            {
                EXPECT_TRUE(infoLog.find(expectedError) != std::string::npos);
            }
        }
    };
    
    // Check that compilation fails if the compile option to emulate gl_BaseVertex and gl_BaseInstance
    // is not set
    TEST_F(EmulateGLBaseVertexBaseInstanceTest, RequiresEmulation)
    {
        CheckCompileFailure(
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseVertex), float(gl_BaseInstance), 0.0, 1.0);\n"
            "}\n",
            "extension is not supported");
    }
    
    // Check that compiling with emulation with gl_BaseVertex and gl_BaseInstance works with different
    // shader versions
    TEST_F(EmulateGLBaseVertexBaseInstanceTest, CheckCompile)
    {
        const std::string shaderString =
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseVertex), float(gl_BaseInstance), 0.0, 1.0);\n"
            "}\n";
    
        compile("#version 300 es\n" + shaderString,
                SH_OBJECT_CODE | SH_VARIABLES | SH_EMULATE_GL_BASE_VERTEX_BASE_INSTANCE);
    }
    
    // Check that gl_BaseVertex and gl_BaseInstance is properly emulated
    TEST_F(EmulateGLBaseVertexBaseInstanceTest, EmulatesUniform)
    {
        addOutputType(SH_GLSL_COMPATIBILITY_OUTPUT);
        addOutputType(SH_ESSL_OUTPUT);
    #ifdef ANGLE_ENABLE_VULKAN
        addOutputType(SH_GLSL_VULKAN_OUTPUT);
    #endif
    #ifdef ANGLE_ENABLE_HLSL
        addOutputType(SH_HLSL_3_0_OUTPUT);
        addOutputType(SH_HLSL_3_0_OUTPUT);
    #endif
    
        const std::string &shaderString =
            "#version 300 es\n"
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseVertex), float(gl_BaseInstance), 0.0, 1.0);\n"
            "}\n";
    
        compile(shaderString, SH_OBJECT_CODE | SH_VARIABLES | SH_EMULATE_GL_BASE_VERTEX_BASE_INSTANCE);
    
        EXPECT_TRUE(notFoundInCode("gl_BaseVertex"));
        EXPECT_TRUE(foundInCode("angle_BaseVertex"));
        EXPECT_TRUE(notFoundInCode("gl_BaseInstance"));
        EXPECT_TRUE(foundInCode("angle_BaseInstance"));
        EXPECT_TRUE(notFoundInCode("GL_ANGLE_base_vertex_base_instance"));
    
        EXPECT_TRUE(foundInCode(SH_GLSL_COMPATIBILITY_OUTPUT, "uniform int angle_BaseVertex"));
        EXPECT_TRUE(foundInCode(SH_GLSL_COMPATIBILITY_OUTPUT, "uniform int angle_BaseInstance"));
        EXPECT_TRUE(foundInCode(SH_ESSL_OUTPUT, "uniform highp int angle_BaseVertex"));
        EXPECT_TRUE(foundInCode(SH_ESSL_OUTPUT, "uniform highp int angle_BaseInstance"));
    
    #ifdef ANGLE_ENABLE_VULKAN
        EXPECT_TRUE(foundInCode(
            SH_GLSL_VULKAN_OUTPUT,
            "uniform defaultUniforms\n{\n    int angle_BaseInstance;\n    int angle_BaseVertex;"));
    #endif
    #ifdef ANGLE_ENABLE_HLSL
        EXPECT_TRUE(foundInCode(SH_HLSL_3_0_OUTPUT, "uniform int angle_BaseVertex : register"));
        EXPECT_TRUE(foundInCode(SH_HLSL_3_0_OUTPUT, "uniform int angle_BaseInstance : register"));
    #endif
    }
    
    // Check that a user-defined "gl_BaseVertex" or "gl_BaseInstance" is not permitted
    TEST_F(EmulateGLBaseVertexBaseInstanceTest, DisallowsUserDefinedGLDrawID)
    {
        // Check that it is not permitted without the extension
        CheckCompileFailure(
            "#version 300 es\n"
            "uniform int gl_BaseVertex;\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseVertex), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        CheckCompileFailure(
            "#version 300 es\n"
            "uniform int gl_BaseInstance;\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseInstance), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        CheckCompileFailure(
            "#version 300 es\n"
            "void main() {\n"
            "   int gl_BaseVertex = 0;\n"
            "   gl_Position = vec4(float(gl_BaseVertex), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        CheckCompileFailure(
            "#version 300 es\n"
            "void main() {\n"
            "   int gl_BaseInstance = 0;\n"
            "   gl_Position = vec4(float(gl_BaseInstance), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        // Check that it is not permitted with the extension
        CheckCompileFailure(
            "#version 300 es\n"
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "uniform int gl_BaseVertex;\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseVertex), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        CheckCompileFailure(
            "#version 300 es\n"
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "uniform int gl_BaseInstance;\n"
            "void main() {\n"
            "   gl_Position = vec4(float(gl_BaseInstance), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        CheckCompileFailure(
            "#version 300 es\n"
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "void main() {\n"
            "   int gl_BaseVertex = 0;\n"
            "   gl_Position = vec4(float(gl_BaseVertex), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    
        CheckCompileFailure(
            "#version 300 es\n"
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "void main() {\n"
            "   int gl_BaseInstance = 0;\n"
            "   gl_Position = vec4(float(gl_BaseInstance), 0.0, 0.0, 1.0);\n"
            "}\n",
            "reserved built-in name");
    }
    
    // gl_BaseVertex and gl_BaseInstance are translated to angle_BaseVertex and angle_BaseInstance
    // internally. Check that a user-defined angle_BaseVertex or angle_BaseInstance is permitted
    TEST_F(EmulateGLBaseVertexBaseInstanceTest, AllowsUserDefinedANGLEDrawID)
    {
        addOutputType(SH_GLSL_COMPATIBILITY_OUTPUT);
        addOutputType(SH_ESSL_OUTPUT);
    #ifdef ANGLE_ENABLE_VULKAN
        addOutputType(SH_GLSL_VULKAN_OUTPUT);
    #endif
    #ifdef ANGLE_ENABLE_HLSL
        addOutputType(SH_HLSL_3_0_OUTPUT);
        addOutputType(SH_HLSL_3_0_OUTPUT);
    #endif
    
        const std::string &shaderString =
            "#version 300 es\n"
            "#extension GL_ANGLE_base_vertex_base_instance : require\n"
            "uniform int angle_BaseVertex;\n"
            "uniform int angle_BaseInstance;\n"
            "void main() {\n"
            "   gl_Position = vec4(\n"
            "           float(angle_BaseVertex + gl_BaseVertex),\n"
            "           float(angle_BaseInstance + gl_BaseInstance),\n"
            "           0.0, 1.0);\n"
            "}\n";
    
        compile(shaderString, SH_OBJECT_CODE | SH_VARIABLES | SH_EMULATE_GL_BASE_VERTEX_BASE_INSTANCE);
    
        // " angle_BaseVertex" (note the space) should appear exactly twice:
        //    once in the declaration and once in the body.
        // The user-defined angle_BaseVertex should be decorated
        EXPECT_TRUE(foundInCode(" angle_BaseVertex", 2));
        EXPECT_TRUE(foundInCode(" angle_BaseInstance", 2));
    }