A fast 2D and 3D game engine — TypeScript SDK, C++/WebAssembly core, visual editor. Ship one project to web, desktop, WeChat MiniGames, playable ads, and native Android / iOS.
TypeScript 2d-game-engine3d3d-game-engineandroidcppecsgame-editorgame-enginegamedeviostypescriptwebassemblywebglwebgpuwechat-minigame
fix(render): a vertex stage names gl_InstanceID only after its attributes
esenginea7234be19039
diff --git a/src/esengine/resource/ShaderParser.cpp b/src/esengine/resource/ShaderParser.cppindex 1e38a0ed4..e38e0c191 100644--- a/src/esengine/resource/ShaderParser.cpp+++ b/src/esengine/resource/ShaderParser.cpp@@ -40,7 +40,7 @@ namespace {* `esInstance*` is the name a stage reaches for; a stage that names one* gets this header, the way a stage that names `tN` gets that unit.*/-/** @brief The same record, for a WGSL vertex stage. @see instanceRecordGLSL */+/** @brief The same record, for a WGSL vertex stage. @see instanceRecordGLSLDecls */std::string instanceRecordWGSL() {const std::string texels = std::to_string(MESH_INSTANCE_TEXELS);const std::string width = std::to_string(MESH_INSTANCE_TEXTURE_WIDTH);@@ -74,14 +74,31 @@ std::string instanceRecordWGSL() {+ std::to_string(MESH_INSTANCE_TEXEL_LIGHTMAP) + "); }\n";}-std::string instanceRecordGLSL() {- const std::string texels = std::to_string(MESH_INSTANCE_TEXELS);- const std::string width = std::to_string(MESH_INSTANCE_TEXTURE_WIDTH);+/**+ * @brief What a GLSL stage sees of the record before its own source: the block, the+ * texture and prototypes, none of which name a system value.+ * @details The bodies follow the stage (instanceRecordGLSLBodies). ANGLE on D3D11 puts+ * SV_InstanceID into the input signature where gl_InstanceID first appears and+ * caches input layouts without the signature, so one stage naming it before its+ * attributes shifts the attributes of every program drawn with that layout.+ */+std::string instanceRecordGLSLDecls() {return"layout(std140) uniform InstanceConstants {\n"" highp uvec4 u_instanceBase;\n""};\n""uniform highp sampler2D u_instanceData;\n"+ "highp vec4 esInstanceTexel(int texel);\n"+ "highp mat4 esInstanceModel();\n"+ "highp mat3 esInstanceNormalMatrix();\n"+ "highp vec4 esInstanceTint();\n"+ "highp vec4 esInstanceLightmapRect();\n";+}++std::string instanceRecordGLSLBodies() {+ const std::string texels = std::to_string(MESH_INSTANCE_TEXELS);+ const std::string width = std::to_string(MESH_INSTANCE_TEXTURE_WIDTH);+ return"highp vec4 esInstanceTexel(int texel) {\n"" int at = (int(u_instanceBase.x) + ES_INSTANCE_ID) * " + texels + " + texel;\n"" return texelFetch(u_instanceData, ivec2(at % " + width + ", at / " + width + "), 0);\n"@@ -1798,7 +1815,7 @@ ShaderParser::AssembledStage ShaderParser::assembleStageEx(const ParsedShader& p// is how wgslReachedTextureDecls decides the same question: one author for// the declaration, rather than a copy in every shader that reads a record.if (stageIt->second.find("esInstance") != std::string::npos) {- const std::string decl = instanceRecordGLSL();+ const std::string decl = instanceRecordGLSLDecls();assembled << decl;headerLines += static_cast<u32>(std::count(decl.begin(), decl.end(), '\n'));}@@ -2365,6 +2382,9 @@ ShaderParser::AssembledStage ShaderParser::assembleStageEx(const ParsedShader& p}assembled << blankUniformBlock(stageIt->second, "FrameConstants");+ if (stage == ShaderStage::Vertex && stageIt->second.find("esInstance") != std::string::npos) {+ assembled << instanceRecordGLSLBodies();+ }result.source = assembled.str();result.headerLineCount = headerLines;diff --git a/tests/renderer/test_shader_variant.cpp b/tests/renderer/test_shader_variant.cppindex edc776a75..5e0c562c0 100644--- a/tests/renderer/test_shader_variant.cpp+++ b/tests/renderer/test_shader_variant.cpp@@ -6,9 +6,11 @@// shader body can #ifdef them), and variantKey is an order-independent cache key.#include "esengine/resource/ShaderParser.hpp"+#include "esengine/renderer/rhi/ShaderEmbeds.generated.hpp"#include <algorithm>#include <cstdio>+#include <sstream>#include <string>static int g_failures = 0;@@ -484,6 +486,61 @@ static void testHandWrittenFrameBlock() {"blanking keeps the line count, so compile-log remapping still lands");}+/**+ * True when no line before the last vertex attribute uses a system value. ANGLE on+ * D3D11 places SV_InstanceID / SV_VertexID in the input signature where the stage first+ * names them and caches input layouts without the signature, so one stage naming one+ * early breaks every program sharing its layout. Textual, so every variant is covered.+ */+static bool systemValuesTrailAttributes(const std::string& src) {+ int line = 0, lastAttribute = -1, firstSystemValue = -1;+ std::istringstream in(src);+ for (std::string text; std::getline(in, text); ++line) {+ const std::size_t lead = text.find_first_not_of(" \t");+ if (lead == std::string::npos || text[lead] == '#' || text.compare(lead, 2, "//") == 0) continue;+ const std::string t = text.substr(lead);+ if (t.rfind("in ", 0) == 0 || (t.rfind("layout", 0) == 0 && t.find(") in ") != std::string::npos)) {+ lastAttribute = line;+ }+ const bool names = t.find("gl_InstanceID") != std::string::npos ||+ t.find("gl_VertexID") != std::string::npos ||+ t.find("ES_INSTANCE_ID") != std::string::npos;+ if (names && firstSystemValue < 0) firstSystemValue = line;+ }+ return firstSystemValue < 0 || firstSystemValue > lastAttribute;+}++static void testSystemValuesTrailAttributes() {+ ParsedShader early = ShaderParser::parse(+ "#pragma shader \"Early\"\n#pragma version 300 es\n"+ "#pragma vertex\nint id() { return gl_InstanceID; }\n"+ "layout(location = 0) in vec3 a_position;\n"+ "void main() { gl_Position = vec4(a_position, float(id())); }\n#pragma end\n"+ "#pragma fragment\nout vec4 o;\nvoid main() { o = vec4(1.0); }\n#pragma end\n");+ CHECK(!systemValuesTrailAttributes(ShaderParser::assembleStage(early, ShaderStage::Vertex)),+ "a stage naming gl_InstanceID before its attributes is caught");++ ParsedShader mesh = ShaderParser::parse(esengine::ShaderEmbeds::MESH);+ ParsedShader lit = ShaderParser::parse(FRAG_ONLY_LIT);+ const std::vector<std::vector<std::string>> variants = {+ {}, {"MESH_NORMALS", "LIT"}, {"MESH_NORMALS", "LIT", "SKINNED"}, {"SHADOW_DEPTH"},+ {"MESH_NORMALS", "LIT", "MESH_LIGHTMAP", "ES_RECEIVE_SHADOW", "ES_ENV_MAP"}};+ bool meshTrails = true;+ for (const auto& features : variants) {+ meshTrails = meshTrails && systemValuesTrailAttributes(+ ShaderParser::assembleStage(mesh, ShaderStage::Vertex, "", features));+ }+ CHECK(meshTrails, "mesh.esshader names no system value before its attributes");++ bool canonicalTrails = true;+ for (const auto& features : std::vector<std::vector<std::string>>{+ {"MESH"}, {"MESH", "MESH_NORMALS", "SKINNED"}, {"MESH", "MESH_LIGHTMAP"}, {"PARTICLE"}}) {+ canonicalTrails = canonicalTrails && systemValuesTrailAttributes(+ ShaderParser::assembleStage(lit, ShaderStage::Vertex, "", features));+ }+ CHECK(canonicalTrails, "the canonical material vertex names no system value before its attributes");+}+int main() {ParsedShader p = ShaderParser::parse(SRC);CHECK(p.valid, "shader parses");@@ -505,6 +562,7 @@ int main() {testFragmentOnly();testHandWrittenFrameBlock();testWGSLEmission();+ testSystemValuesTrailAttributes();if (g_failures == 0) {std::printf("\nALL SHADER-VARIANT TESTS PASSED\n");