Migrate Axmol shader workflow to HLSL-first axslcc 3.99

.gitignore

@@ -241,3 +241,5 @@ release_note_draft.txt
 
 1k/.env
 1k/llvm.sh
+
+.mimo*

1k/1kiss.ps1

@@ -661,6 +661,10 @@ function find_prog($name, $path = $null, $mode = 'ONLY', $cmd = $null, $params =
             $isRange = $verArr.Count -gt 1
             $minimalVer = $verArr[0]
             $preferredVer = $verArr[$isRange]
+            # strip pre-release suffix e.g. 3.99.0-rc1 -> 3.99.0
+            $stripSuffix = [regex]'\-[a-z0-9]+$'
+            $minimalVer = $stripSuffix.Replace($minimalVer, '')
+            $preferredVer = $stripSuffix.Replace($preferredVer, '')
             if ($preferredVer.EndsWith('+')) {
                 $preferredVer = $preferredVer.TrimEnd('+')
                 if ($minimalVer.EndsWith('+')) { $minimalVer = $minimalVer.TrimEnd('+') }
@@ -710,8 +714,8 @@ function find_prog($name, $path = $null, $mode = 'ONLY', $cmd = $null, $params =
                 $verStr = "$($verInfo.Major).$($verInfo.Minor).$($verInfo.Build)"
             }
 
-            # can match x.y.z-rc3 or x.y.z-65a239b
-            $matchInfo = [Regex]::Match($verStr, '(\d+\.)+(\*|\d+)(\-[a-z0-9]+)?')
+            # strip x.y.z-rc3 to x.y.z
+            $matchInfo = [Regex]::Match($verStr, '(\d+\.)+(\*|\d+)')
             $foundVer = $matchInfo.Value
         }
         else {
@@ -1004,29 +1008,33 @@ function setup_python3() {
 }
 
 # setup axslcc, not add to path
+# package layout: axslcc-<ver>-<os>-<arch>/axslcc (flat)
+# expected layout: axslcc/bin/axslcc, axslcc/<license files>
 function setup_axslcc() {
     if (!$manifest['axslcc']) { return $null }
-    $axslcc_bin = Join-Path $install_prefix 'axslcc'
+    $axslcc_root = Join-Path $install_prefix 'axslcc'
+    $axslcc_bin = Join-Path $axslcc_root 'bin'
     $axslcc_prog, $axslcc_ver = find_prog -name 'axslcc' -path $axslcc_bin -mode 'BOTH'
     if ($axslcc_prog) {
         return $axslcc_prog
     }
 
+    $requiredVer = $manifest['axslcc']
     $axslcc_prog = (Join-Path $axslcc_bin "axslcc$EXE_SUFFIX")
     if ($1k.isfile($axslcc_prog)) {
         $1k.del($axslcc_prog)
     }
 
-    $pkg_url = devtool_url 'axslcc' $axslcc_ver
+    $pkg_url = devtool_url 'axslcc' $requiredVer
+    fetch_pkg $pkg_url -exrep "axslcc-$requiredVer-*=axslcc"
 
-    fetch_pkg $pkg_url -exrep "axslcc"
-
-    if ($1k.isfile($axslcc_prog)) {
+    $axslcc_prog, $axslcc_ver = find_prog -name 'axslcc' -path $axslcc_bin -mode 'BOTH' -silent $true
+    if ($axslcc_prog) {
         $1k.println("Using axslcc: $axslcc_prog, version: $axslcc_ver")
+        return $axslcc_prog
     }
-    else {
-        throw "Install axslcc fail"
-    }
+
+    throw "Install axslcc fail"
 }
 
 function setup_ninja() {

1k/build.profiles

@@ -5,8 +5,8 @@
 
 # --- region platfom:common
 
-# The axmol shader compiler, legacy name is 'glslcc' before axmol-2.3.0
-axslcc=3.6.0
+# The Axmol HLSL-first cross-platform shader compiler
+axslcc=3.99.0
 
 # The cmake, @gradle @axmol-cmdline
 # as latest as possible

3rdparty/CMakeLists.txt

@@ -139,7 +139,7 @@ if(ANDROID)
   )
 endif()
 
-ax_add_3rd(fmt)
+ax_add_3rd(fmt OPTIONS "FMT_MODULE OFF")
 if (TARGET fmt-c)
   set_target_properties(fmt-c PROPERTIES FOLDER "3rdparty")
 endif()

3rdparty/openal/CMakeLists.txt

@@ -1802,11 +1802,15 @@ else()
     add_library(${IMPL_TARGET} SHARED)
     if(CMAKE_VERSION GREATER_EQUAL 3.23)
         target_sources(${IMPL_TARGET}
-            PRIVATE ${OPENAL_SRCS} ${ALC_SRCS} ${CORE_SRCS} ${RC_CONFIG}
-            PRIVATE FILE_SET internal_headers TYPE HEADERS
-                FILES ${OPENAL_HDRS} ${ALC_HDRS} ${CORE_HDRS}
-            PUBLIC FILE_SET public_headers TYPE HEADERS
-                BASE_DIRS "${OpenAL_SOURCE_DIR}/include" FILES ${TARGET_PUBLIC_HEADERS})
+            PRIVATE ${OPENAL_SRCS} ${ALC_SRCS} ${CORE_SRCS} ${RC_CONFIG})
+        # FILE_SET of type HEADERS is incompatible with FRAMEWORK targets in CMake >= 4.4
+        if(NOT (APPLE AND ALSOFT_OSX_FRAMEWORK))
+            target_sources(${IMPL_TARGET}
+                PRIVATE FILE_SET internal_headers TYPE HEADERS
+                    FILES ${OPENAL_HDRS} ${ALC_HDRS} ${CORE_HDRS}
+                PUBLIC FILE_SET public_headers TYPE HEADERS
+                    BASE_DIRS "${OpenAL_SOURCE_DIR}/include" FILES ${TARGET_PUBLIC_HEADERS})
+        endif()
         # FIXME: Why can't I do this without CMake complaining that the private
         # alsoft.common and alsoft.fmt libs aren't in some export set? Yet
         # adding alsoft.core-modules as another lib that has the modules works
@@ -1882,6 +1886,9 @@ else()
         endif()
 
         set(_alsoft_bundle_id "org.openal-soft.openal")
+        # FILE_SET of type HEADERS is incompatible with FRAMEWORK targets in CMake >= 4.4,
+        # so use PUBLIC_HEADER and PRIVATE_HEADER properties instead
+        set(_alsoft_private_headers ${OPENAL_HDRS} ${ALC_HDRS} ${CORE_HDRS})
         set_target_properties(${IMPL_TARGET} PROPERTIES
             FRAMEWORK TRUE
             FRAMEWORK_VERSION C
@@ -1899,7 +1906,9 @@ else()
             XCODE_ATTRIBUTE_CONFIGURATION_BUILD_DIR "$(inherited)"
             XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER "${_alsoft_bundle_id}"
             PUBLIC_HEADER "${TARGET_PUBLIC_HEADERS}"
+            PRIVATE_HEADER "${_alsoft_private_headers}"
             MACOSX_RPATH TRUE)
+        unset(_alsoft_private_headers)
     endif()
 endif()
 

README.md

@@ -168,11 +168,11 @@ If you find **Axmol Engine** helpful, please consider donating in [https://axmol
 
 ## Sponsors
 
-#### Platinum Sponsors
+#### Corporate Diamond
 
 <p align="left">
   <a href="https://scorewarrior.com/?ad=axmol" target=_blank><img
-    src="https://cdn.prod.website-files.com/633da33305ac754156026dd8/63566f1edf5f0712f94f7f1b_sw-triangle-821890.svg" height="120"
+    src="https://cdn.prod.website-files.com/633da33305ac754156026dd8/63566f1edf5f0712f94f7f1b_sw-triangle-821890.svg" height="160"
   /></a>
 </p>
 
@@ -194,7 +194,7 @@ In order to see some of our community works, please check our Axmol Showcase: [M
 ## Reference links
 
 - [1kiss](https://github.com/simdsoft/1kiss): A cross-platform one step build powershell script, with auto setup general dependent tools.
-- [axslcc](https://github.com/axmolengine/axslcc): The axmol new shader workflow tool, forked from `glslcc`.
+- [axslcc](https://github.com/axmolengine/axslcc): The Axmol v3 HLSL-first shader compiler and cross-platform shader workflow tool.
 - [Official Cocos2d-x](https://github.com/cocos2d/cocos2d-x)
 
 ## Axmol Stats

README_CN.md

@@ -168,10 +168,10 @@ Axmol 引擎在 Cocos2d-x v4.0 的基础上进行迭代和改进。现在速度
 
 ## Sponsors
 
-#### Platinum Sponsors
+#### Corporate Diamond
 <p align="left">
   <a href="https://scorewarrior.com/?ad=axmol" target=_blank><img
-    src="https://cdn.prod.website-files.com/633da33305ac754156026dd8/63566f1edf5f0712f94f7f1b_sw-triangle-821890.svg" height="120"
+    src="https://cdn.prod.website-files.com/633da33305ac754156026dd8/63566f1edf5f0712f94f7f1b_sw-triangle-821890.svg" height="160"
   /></a>
 </p>
 
@@ -194,7 +194,7 @@ Please visit: [https://axmol.dev/donate](https://axmol.dev/donate)
 ## 参考链接
 
 - [1kiss](https://github.com/simdsoft/1kiss): 一个由 PowerShell 编写的能够自动配置各平台编译工具链的跨平台构建工具。
-- [axslcc](https://github.com/axmolengine/axslcc): Axmol 引擎专用跨平台 Shader 编译器（fork 自 `glslcc`)。
+- [axslcc](https://github.com/axmolengine/axslcc): Axmol v3 的 HLSL-first 跨平台 shader 编译工具，为 Axmol RHI 提供统一 shader 工作流。
 - [Cocos2d-x](https://github.com/cocos2d/cocos2d-x)：原 Cocos2d-x 官方引擎仓库。
 
 ## Axmol 活跃状态

axmol/2d/ProgressTimer.cpp

@@ -58,11 +58,11 @@ rhi::ProgramState* initPipelineDesc(ax::CustomCommand& command,
     // set custom vertexLayout according to V2F_T2F_C4F structure
     VertexLayoutDesc desc = axvlm->allocateVertexLayoutDesc();
     desc.startLayout(3);
-    desc.addAttrib("a_position", program->getVertexInputDesc(rhi::VertexInputKind::POSITION),
-                   rhi::VertexElementType::FLOAT2, 0, false);
-    desc.addAttrib("a_texCoord", program->getVertexInputDesc(rhi::VertexInputKind::TEXCOORD),
-                   rhi::VertexElementType::FLOAT2, offsetof(V2F_T2F_C4F, texCoord), false);
-    desc.addAttrib("a_color", program->getVertexInputDesc(rhi::VertexInputKind::COLOR), rhi::VertexElementType::FLOAT4,
+    desc.addAttrib(program->getVertexInputDesc(rhi::VertexSemantic::POSITION), rhi::VertexElementType::FLOAT2, 0,
+                   false);
+    desc.addAttrib(program->getVertexInputDesc(rhi::VertexSemantic::TEXCOORD0), rhi::VertexElementType::FLOAT2,
+                   offsetof(V2F_T2F_C4F, texCoord), false);
+    desc.addAttrib(program->getVertexInputDesc(rhi::VertexSemantic::COLOR0), rhi::VertexElementType::FLOAT4,
                    offsetof(V2F_T2F_C4F, color), false);
     desc.endLayout();
 

axmol/3d/Bundle3D.cpp

@@ -257,21 +257,21 @@ bool Bundle3D::loadObj(MeshDatas& meshdatas,
 
             if (mesh.positions.size())
             {
-                attrib.vertexAttrib = shaderinfos::VertexKey::VERTEX_ATTRIB_POSITION;
+                attrib.vertexAttrib = MeshVertexAttribute::POSITION;
                 meshdata->attribs.emplace_back(attrib);
             }
             bool hasnormal = false, hastex = false;
             if (mesh.normals.size())
             {
                 hasnormal           = true;
-                attrib.vertexAttrib = shaderinfos::VertexKey::VERTEX_ATTRIB_NORMAL;
+                attrib.vertexAttrib = MeshVertexAttribute::NORMAL;
                 meshdata->attribs.emplace_back(attrib);
             }
             if (mesh.texcoords.size())
             {
                 hastex              = true;
                 attrib.type         = parseGLDataType("GL_FLOAT", 2);
-                attrib.vertexAttrib = shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD;
+                attrib.vertexAttrib = MeshVertexAttribute::TEXCOORD0;
                 meshdata->attribs.emplace_back(attrib);
             }
 
@@ -513,29 +513,29 @@ bool Bundle3D::loadMeshDatasBinary_0_1(MeshDatas& meshdatas)
         {
             auto vUsage = _binaryReader.read<unsigned int>();
             auto vSize  = _binaryReader.read<unsigned int>();
-            shaderinfos::VertexKey usage;
+            MeshVertexAttribute usage;
 
             MeshVertexAttrib meshVertexAttribute;
             meshVertexAttribute.type = parseGLDataType("GL_FLOAT", vSize);
             if (vUsage == VERTEX_ATTRIB_NORMAL)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_NORMAL;
+                usage = MeshVertexAttribute::NORMAL;
             }
             else if (vUsage == VERTEX_ATTRIB_BLEND_WEIGHT)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_BLEND_WEIGHT;
+                usage = MeshVertexAttribute::BLENDWEIGHT;
             }
             else if (vUsage == VERTEX_ATTRIB_BLEND_INDEX)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_BLEND_INDEX;
+                usage = MeshVertexAttribute::BLENDINDICES;
             }
             else if (vUsage == VERTEX_ATTRIB_POSITION)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_POSITION;
+                usage = MeshVertexAttribute::POSITION;
             }
             else if (vUsage == VERTEX_ATTRIB_TEX_COORD)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD;
+                usage = MeshVertexAttribute::TEXCOORD0;
             }
             else
             {
@@ -620,7 +620,7 @@ bool Bundle3D::loadMeshDatasBinary_0_2(MeshDatas& meshdatas)
         for (unsigned int i = 0; i < attribSize; ++i)
         {
             unsigned int vUsage, vSize;
-            shaderinfos::VertexKey usage = shaderinfos::VertexKey::VERTEX_ATTRIB_ERROR;
+            MeshVertexAttribute usage = MeshVertexAttribute::INVALID;
             if (_binaryReader.read_blob(vUsage) != 1 || _binaryReader.read_blob(vSize) != 1)
             {
                 AXLOGW("warning: Failed to read meshdata: usage or size '{}'.", _path);
@@ -632,23 +632,23 @@ bool Bundle3D::loadMeshDatasBinary_0_2(MeshDatas& meshdatas)
             meshVertexAttribute.type = parseGLDataType("GL_FLOAT", vSize);
             if (vUsage == VERTEX_ATTRIB_NORMAL)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_NORMAL;
+                usage = MeshVertexAttribute::NORMAL;
             }
             else if (vUsage == VERTEX_ATTRIB_BLEND_WEIGHT)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_BLEND_WEIGHT;
+                usage = MeshVertexAttribute::BLENDWEIGHT;
             }
             else if (vUsage == VERTEX_ATTRIB_BLEND_INDEX)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_BLEND_INDEX;
+                usage = MeshVertexAttribute::BLENDINDICES;
             }
             else if (vUsage == VERTEX_ATTRIB_POSITION)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_POSITION;
+                usage = MeshVertexAttribute::POSITION;
             }
             else if (vUsage == VERTEX_ATTRIB_TEX_COORD)
             {
-                usage = shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD;
+                usage = MeshVertexAttribute::TEXCOORD0;
             }
             meshVertexAttribute.vertexAttrib = usage;
 
@@ -2181,73 +2181,73 @@ NTextureData::Usage Bundle3D::parseGLTextureType(std::string_view str)
         return NTextureData::Usage::Unknown;
     }
 }
-shaderinfos::VertexKey Bundle3D::parseProgramAttribute(std::string_view str)
+MeshVertexAttribute Bundle3D::parseProgramAttribute(std::string_view str)
 {
     if (str == "VERTEX_ATTRIB_POSITION"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_POSITION;
+        return MeshVertexAttribute::POSITION;
     }
     else if (str == "VERTEX_ATTRIB_COLOR"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_COLOR;
+        return MeshVertexAttribute::COLOR;
     }
     else if (str == "VERTEX_ATTRIB_TEX_COORD"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD;
+        return MeshVertexAttribute::TEXCOORD0;
     }
     else if (str == "VERTEX_ATTRIB_TEX_COORD1"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD1;
+        return MeshVertexAttribute::TEXCOORD1;
     }
     else if (str == "VERTEX_ATTRIB_TEX_COORD2"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD2;
+        return MeshVertexAttribute::TEXCOORD2;
     }
     else if (str == "VERTEX_ATTRIB_TEX_COORD3"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD3;
+        return MeshVertexAttribute::TEXCOORD3;
     }
     // comment out them
     //    else if (str == "VERTEX_ATTRIB_TEX_COORD4")
     //    {
-    //        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD4;
+    //        return MeshVertexAttribute::TEXCOORD4;
     //    }
     //    else if (str == "VERTEX_ATTRIB_TEX_COORD5")
     //    {
-    //        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD5;
+    //        return MeshVertexAttribute::TEXCOORD5;
     //    }
     //    else if (str == "VERTEX_ATTRIB_TEX_COORD6")
     //    {
-    //        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD6;
+    //        return MeshVertexAttribute::TEXCOORD6;
     //    }
     //    else if (str == "VERTEX_ATTRIB_TEX_COORD7")
     //    {
-    //        return shaderinfos::VertexKey::VERTEX_ATTRIB_TEX_COORD7;
+    //        return MeshVertexAttribute::TEXCOORD7;
     //    }
     else if (str == "VERTEX_ATTRIB_NORMAL"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_NORMAL;
+        return MeshVertexAttribute::NORMAL;
     }
     else if (str == "VERTEX_ATTRIB_BLEND_WEIGHT"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_BLEND_WEIGHT;
+        return MeshVertexAttribute::BLENDWEIGHT;
     }
     else if (str == "VERTEX_ATTRIB_BLEND_INDEX"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_BLEND_INDEX;
+        return MeshVertexAttribute::BLENDINDICES;
     }
     else if (str == "VERTEX_ATTRIB_TANGENT"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_TANGENT;
+        return MeshVertexAttribute::TANGENT;
     }
     else if (str == "VERTEX_ATTRIB_BINORMAL"sv)
     {
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_BINORMAL;
+        return MeshVertexAttribute::BINORMAL;
     }
     else
     {
         AXASSERT(false, "Wrong Attribute type");
-        return shaderinfos::VertexKey::VERTEX_ATTRIB_ERROR;
+        return MeshVertexAttribute::INVALID;
     }
 }
 

axmol/3d/Bundle3D.h

@@ -165,7 +165,7 @@ class AX_DLL Bundle3D
      * get vertex attribute type
      * @param str The type in string
      */
-    shaderinfos::VertexKey parseProgramAttribute(std::string_view str);
+    MeshVertexAttribute parseProgramAttribute(std::string_view str);
 
     /*
      * get model path