Remove HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES

In 23.11, we introduced new names for the internal instancer primvars Hydra uses for instance transforms. The rename was important to avoid accidental collisions between custom authored primvars and the internal ones. At the same time, we introduced the TfEnvSetting HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES to allow authors of Hydra render delegates time to update their implementations. We announced that the setting would be removed in 24.05.

This change effects that removal and finally removes the tokens for the deprecated names. Render delegate authors who need more time to update their code should not adopt 24.05 until they have completed the transition.

(Internal change: 2321970)

Author: tgvarik

pxr/imaging/hd/CMakeLists.txt

@@ -364,14 +364,6 @@ pxr_build_test(testHdTypes
        testenv/testHdTypes.cpp
 )
 
-pxr_build_test(testHdInstancerDeprecatedPrimvars
-    LIBRARIES
-        hd
-        
-    CPPFILES
-        testenv/testHdInstancerDeprecatedPrimvars.cpp
-)
-
 pxr_build_test(testHdCollectionExpressionEvaluator
     LIBRARIES
         hd
@@ -446,12 +438,6 @@ pxr_register_test(testHdTypes
     COMMAND "${CMAKE_INSTALL_PREFIX}/tests/testHdTypes"
 )
 
-pxr_register_test(testHdInstancerDeprecatedPrimvars
-    COMMAND "${CMAKE_INSTALL_PREFIX}/tests/testHdInstancerDeprecatedPrimvars"
-    ENV
-        HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES=true
-)
-
 pxr_register_test(testHdCollectionExpressionEvaluator
     COMMAND "${CMAKE_INSTALL_PREFIX}/tests/testHdCollectionExpressionEvaluator"
 )

pxr/imaging/hd/instancer.cpp

@@ -64,15 +64,6 @@ HdInstancer::GetInstancerNumLevels(HdRenderIndex& index,
 TfTokenVector const &
 HdInstancer::GetBuiltinPrimvarNames()
 {
-    if (TfGetEnvSetting(HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES)) {
-        static const TfTokenVector primvarNames = {
-            HdInstancerTokens->instanceTransform,
-            HdInstancerTokens->rotate,
-            HdInstancerTokens->scale,
-            HdInstancerTokens->translate
-        };
-        return primvarNames;
-    }
     static const TfTokenVector primvarNames = {
         HdInstancerTokens->instanceTransforms,
         HdInstancerTokens->instanceRotations,

pxr/imaging/hd/testenv/testHdInstancerDeprecatedPrimvars.cpp

@@ -25,12 +25,6 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-// XXX: Remove this in 24.05. Until then, external users may
-// set this to true to maintain compatability with hydra backends that have
-// not yet been updated to use the new hydra-namespaced names.
-TF_DEFINE_ENV_SETTING(HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES, false,
-    "enable to use pre-23.11 internal instancer primvar names");
-
 TF_DEFINE_PUBLIC_TOKENS(HdTokens, HD_TOKENS);
 
 TF_DEFINE_PUBLIC_TOKENS(HdInstancerTokens, HD_INSTANCER_TOKENS);

pxr/imaging/hd/tokens.cpp

@@ -32,8 +32,6 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-extern HD_API TfEnvSetting<bool> HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES;
-
 #define HD_TOKENS                               \
     (accelerations)                             \
     (adjacency)                                 \
@@ -141,15 +139,7 @@ extern HD_API TfEnvSetting<bool> HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES;
     ((instanceTransforms,   "hydra:instanceTransforms"))   \
     ((instanceRotations,    "hydra:instanceRotations"))    \
     ((instanceScales,       "hydra:instanceScales"))       \
-    ((instanceTranslations, "hydra:instanceTranslations")) \
-                                                           \
-    /* Deprecated versions of the above */                 \
-    /* To be removed in 2024, along with the */            \
-    /* HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES env var*/ \
-    (instanceTransform)                                    \
-    (rotate)                                               \
-    (scale)                                                \
-    (translate)
+    ((instanceTranslations, "hydra:instanceTranslations"))
 
 #define HD_REPR_TOKENS                          \
     (disabled)                                  \

pxr/imaging/hd/tokens.h

@@ -1077,18 +1077,15 @@ HdUnitTestDelegate::Get(SdfPath const& id, TfToken const& key)
         else if(_points.find(id) != _points.end()) {
             return VtValue(_points[id].points);
         }
-    } else if (key == HdInstancerTokens->instanceScales ||
-               key == HdInstancerTokens->scale) {
+    } else if (key == HdInstancerTokens->instanceScales) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].scale);
         }
-    } else if (key == HdInstancerTokens->instanceRotations ||
-               key == HdInstancerTokens->rotate) {
+    } else if (key == HdInstancerTokens->instanceRotations) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].rotate);
         }
-    } else if (key == HdInstancerTokens->instanceTranslations ||
-               key == HdInstancerTokens->translate) {
+    } else if (key == HdInstancerTokens->instanceTranslations) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].translate);
         }
@@ -1126,18 +1123,15 @@ HdUnitTestDelegate::GetIndexedPrimvar(SdfPath const& id, TfToken const& key,
         else if(_points.find(id) != _points.end()) {
             return VtValue(_points[id].points);
         }
-    } else if (key == HdInstancerTokens->instanceScales ||
-               key == HdInstancerTokens->scale) {
+    } else if (key == HdInstancerTokens->instanceScales) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].scale);
         }
-    } else if (key == HdInstancerTokens->instanceRotations ||
-               key == HdInstancerTokens->rotate) {
+    } else if (key == HdInstancerTokens->instanceRotations) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].rotate);
         }
-    } else if (key == HdInstancerTokens->instanceTranslations ||
-               key == HdInstancerTokens->translate) {
+    } else if (key == HdInstancerTokens->instanceTranslations) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].translate);
         }
@@ -1181,18 +1175,12 @@ HdUnitTestDelegate::GetPrimvarDescriptors(SdfPath const& id,
     }
     if (interpolation == HdInterpolationInstance && _hasInstancePrimvars &&
         _instancers.find(id) != _instancers.end()) {
-        if (TfGetEnvSetting(HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES)) {
-            primvars.emplace_back(HdInstancerTokens->scale, interpolation);
-            primvars.emplace_back(HdInstancerTokens->rotate, interpolation);
-            primvars.emplace_back(HdInstancerTokens->translate, interpolation);
-        } else {
-            primvars.emplace_back(HdInstancerTokens->instanceScales,
-                interpolation);
-            primvars.emplace_back(HdInstancerTokens->instanceRotations,
-                interpolation);
-            primvars.emplace_back(HdInstancerTokens->instanceTranslations,
-                interpolation);
-        }
+        primvars.emplace_back(HdInstancerTokens->instanceScales,
+            interpolation);
+        primvars.emplace_back(HdInstancerTokens->instanceRotations,
+            interpolation);
+        primvars.emplace_back(HdInstancerTokens->instanceTranslations,
+            interpolation);
     }
 
     auto const cit = _primvars.find(id);

pxr/imaging/hd/unitTestDelegate.cpp

@@ -100,9 +100,11 @@
 //           scene index prims.
 // 65 -> 66: Make HdSchema::_GetTypedDataSource and getters in generated
 //           hydra schemas const.
+// 66 -> 67: Removes legacy internal instancer primvar names and the
+//           TfEnvSetting for using them (see 56).
 //
 
-#define HD_API_VERSION 66
+#define HD_API_VERSION 67
 
 // 1  ->  2: SimpleLighting -> FallbackLighting
 #define HD_SHADER_API 2

pxr/imaging/hd/version.h

@@ -83,8 +83,7 @@ HdStInstancer::_SyncPrimvars(HdSceneDelegate *sceneDelegate,
         VtValue value = sceneDelegate->Get(instancerId, primvar.name);
         if (!value.IsEmpty()) {
             HdBufferSourceSharedPtr source;
-            if ((primvar.name == HdInstancerTokens->instanceTransform ||
-                 primvar.name == HdInstancerTokens->instanceTransforms)) {
+            if (primvar.name == HdInstancerTokens->instanceTransforms) {
                 if (value.IsHolding<VtArray<GfMatrix4d>>()) {
                     // Explicitly invoke the c'tor taking a
                     // VtArray<GfMatrix4d> to ensure we properly convert to

pxr/imaging/hdSt/instancer.cpp

@@ -223,9 +223,7 @@ CodeGenTest(HdSt_ShaderKey const &key, bool useBindlessBuffer,
         {
             HdBufferSpecVector bufferSpecs;
             bufferSpecs.emplace_back(
-                (TfGetEnvSetting(HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES)
-                ? HdInstancerTokens->translate
-                : HdInstancerTokens->instanceTranslations),
+                HdInstancerTokens->instanceTranslations,
                 HdTupleType { HdTypeFloatVec3, 1 });
             HdBufferArrayRangeSharedPtr range =
                 registry->AllocateNonUniformBufferArrayRange(

pxr/imaging/hdSt/testenv/testHdStCodeGen.cpp

@@ -851,18 +851,15 @@ Hdx_UnitTestDelegate::Get(SdfPath const& id, TfToken const& key)
         if(_meshes.find(id) != _meshes.end()) {
             return VtValue(_meshes[id].opacity);
         }
-    } else if (key == HdInstancerTokens->instanceScales ||
-               key == HdInstancerTokens->scale) {
+    } else if (key == HdInstancerTokens->instanceScales) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].scale);
         }
-    } else if (key == HdInstancerTokens->instanceRotations ||
-               key == HdInstancerTokens->rotate) {
+    } else if (key == HdInstancerTokens->instanceRotations) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].rotate);
         }
-    } else if (key == HdInstancerTokens->instanceTranslations ||
-               key == HdInstancerTokens->translate) {
+    } else if (key == HdInstancerTokens->instanceTranslations) {
         if (_instancers.find(id) != _instancers.end()) {
             return VtValue(_instancers[id].translate);
         }
@@ -951,18 +948,12 @@ Hdx_UnitTestDelegate::GetPrimvarDescriptors(SdfPath const& id,
     }
     if (interpolation == HdInterpolationInstance &&
         _instancers.find(id) != _instancers.end()) {
-        if (TfGetEnvSetting(HD_USE_DEPRECATED_INSTANCER_PRIMVAR_NAMES)) {
-            primvars.emplace_back(HdInstancerTokens->scale, interpolation);
-            primvars.emplace_back(HdInstancerTokens->rotate, interpolation);
-            primvars.emplace_back(HdInstancerTokens->translate, interpolation);
-        } else {
-            primvars.emplace_back(HdInstancerTokens->instanceScales,
-                interpolation);
-            primvars.emplace_back(HdInstancerTokens->instanceRotations,
-                interpolation);
-            primvars.emplace_back(HdInstancerTokens->instanceTranslations,
-                interpolation);
-        }
+        primvars.emplace_back(HdInstancerTokens->instanceScales,
+            interpolation);
+        primvars.emplace_back(HdInstancerTokens->instanceRotations,
+            interpolation);
+        primvars.emplace_back(HdInstancerTokens->instanceTranslations,
+            interpolation);
     }
     return primvars;
 }