After review, rename exposureCompensation -> exposure.

The term "compensation" was found to be misleading, since we are not metering the scene and compensating for that. Furthermore, the bare term "exposure" aligns with the precedent within Katana, the similar "exposure" attributes on RenderMan lights, and even the "exposure" attribute used by Arnold in Maya. (Internal change: 2102095)
zakkar · Oct 5, 2020 · ce84b95 · ce84b95
1 parent 66f59e9
commit ce84b95
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 41 deletions.
diff --git a/pxr/imaging/hd/camera.h b/pxr/imaging/hd/camera.h
@@ -62,7 +62,7 @@ PXR_NAMESPACE_OPEN_SCOPE
                                                 \
     (shutterOpen)                               \
     (shutterClose)                              \
-    (exposureCompensation)
+    (exposure)
 
 
 TF_DECLARE_PUBLIC_TOKENS(HdCameraTokens, HD_API, HD_CAMERA_TOKENS);

diff --git a/pxr/usd/usdGeom/camera.cpp b/pxr/usd/usdGeom/camera.cpp
@@ -324,15 +324,15 @@ UsdGeomCamera::CreateShutterCloseAttr(VtValue const &defaultValue, bool writeSpa
 }
 
 UsdAttribute
-UsdGeomCamera::GetExposureCompensationAttr() const
+UsdGeomCamera::GetExposureAttr() const
 {
-    return GetPrim().GetAttribute(UsdGeomTokens->exposureCompensation);
+    return GetPrim().GetAttribute(UsdGeomTokens->exposure);
 }
 
 UsdAttribute
-UsdGeomCamera::CreateExposureCompensationAttr(VtValue const &defaultValue, bool writeSparsely) const
+UsdGeomCamera::CreateExposureAttr(VtValue const &defaultValue, bool writeSparsely) const
 {
-    return UsdSchemaBase::_CreateAttr(UsdGeomTokens->exposureCompensation,
+    return UsdSchemaBase::_CreateAttr(UsdGeomTokens->exposure,
                        SdfValueTypeNames->Float,
                        /* custom = */ false,
                        SdfVariabilityVarying,
@@ -370,7 +370,7 @@ UsdGeomCamera::GetSchemaAttributeNames(bool includeInherited)
         UsdGeomTokens->stereoRole,
         UsdGeomTokens->shutterOpen,
         UsdGeomTokens->shutterClose,
-        UsdGeomTokens->exposureCompensation,
+        UsdGeomTokens->exposure,
     };
     static TfTokenVector allNames =
         _ConcatenateAttributeNames(

diff --git a/pxr/usd/usdGeom/camera.h b/pxr/usd/usdGeom/camera.h
@@ -490,27 +490,28 @@ class UsdGeomCamera : public UsdGeomXformable
 
 public:
     // --------------------------------------------------------------------- //
-    // EXPOSURECOMPENSATION 
+    // EXPOSURE 
     // --------------------------------------------------------------------- //
-    /// Exposure compensation, as a log base-2 value.  The default
-    /// of 0.0 has no effect.  A value of 1.0 will double the image-plane
-    /// intensities in a rendered image; a value of -1.0 will halve them.
+    /// Exposure adjustment, as a log base-2 value.  The default
+    /// of 0.0 has no effect.  A value of 1.0 will double the
+    /// image-plane intensities in a rendered image; a value of
+    /// -1.0 will halve them.
     ///
     /// | ||
     /// | -- | -- |
-    /// | Declaration | `float exposureCompensation = 0` |
+    /// | Declaration | `float exposure = 0` |
     /// | C++ Type | float |
     /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
     USDGEOM_API
-    UsdAttribute GetExposureCompensationAttr() const;
+    UsdAttribute GetExposureAttr() const;
 
-    /// See GetExposureCompensationAttr(), and also 
+    /// See GetExposureAttr(), and also 
     /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
     /// If specified, author \p defaultValue as the attribute's default,
     /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
     /// the default for \p writeSparsely is \c false.
     USDGEOM_API
-    UsdAttribute CreateExposureCompensationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
+    UsdAttribute CreateExposureAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
 public:
     // ===================================================================== //

diff --git a/pxr/usd/usdGeom/generatedSchema.usda b/pxr/usd/usdGeom/generatedSchema.usda
@@ -3411,10 +3411,11 @@ class Camera "Camera" (
         doc = """Near and far clipping distances in centimeters (or, more
                  general, world units)."""
     )
-    float exposureCompensation = 0 (
-        doc = """Exposure compensation, as a log base-2 value.  The default
-                 of 0.0 has no effect.  A value of 1.0 will double the image-plane
-                 intensities in a rendered image; a value of -1.0 will halve them."""
+    float exposure = 0 (
+        doc = """Exposure adjustment, as a log base-2 value.  The default
+                 of 0.0 has no effect.  A value of 1.0 will double the
+                 image-plane intensities in a rendered image; a value of
+                 -1.0 will halve them."""
     )
     float focalLength = 50 (
         doc = """Perspective focal length in millimeters (or, more general,

diff --git a/pxr/usd/usdGeom/schema.usda b/pxr/usd/usdGeom/schema.usda
@@ -1958,12 +1958,13 @@ class Camera "Camera" (
                  should be authored, otherwise there is no exposure and a
                  renderer should produce a black image."""
     )
-
-    # exposure compensation
-    float exposureCompensation = 0.0 (
-        doc = """Exposure compensation, as a log base-2 value.  The default
-                 of 0.0 has no effect.  A value of 1.0 will double the image-plane
-                 intensities in a rendered image; a value of -1.0 will halve them."""
+
+    # exposure adjustment
+    float exposure = 0.0 (
+        doc = """Exposure adjustment, as a log base-2 value.  The default
+                 of 0.0 has no effect.  A value of 1.0 will double the
+                 image-plane intensities in a rendered image; a value of
+                 -1.0 will halve them."""
     )
 }
 

diff --git a/pxr/usd/usdGeom/tokens.cpp b/pxr/usd/usdGeom/tokens.cpp
@@ -61,7 +61,7 @@ UsdGeomTokensType::UsdGeomTokensType() :
     edgeOnly("edgeOnly", TfToken::Immortal),
     elementSize("elementSize", TfToken::Immortal),
     elementType("elementType", TfToken::Immortal),
-    exposureCompensation("exposureCompensation", TfToken::Immortal),
+    exposure("exposure", TfToken::Immortal),
     extent("extent", TfToken::Immortal),
     extentsHint("extentsHint", TfToken::Immortal),
     face("face", TfToken::Immortal),
@@ -216,7 +216,7 @@ UsdGeomTokensType::UsdGeomTokensType() :
         edgeOnly,
         elementSize,
         elementType,
-        exposureCompensation,
+        exposure,
         extent,
         extentsHint,
         face,

diff --git a/pxr/usd/usdGeom/tokens.h b/pxr/usd/usdGeom/tokens.h
@@ -202,10 +202,10 @@ struct UsdGeomTokensType {
     /// 
     /// UsdGeomSubset
     const TfToken elementType;
-    /// \brief "exposureCompensation"
+    /// \brief "exposure"
     /// 
     /// UsdGeomCamera
-    const TfToken exposureCompensation;
+    const TfToken exposure;
     /// \brief "extent"
     /// 
     /// UsdGeomCone, UsdGeomCapsule, UsdGeomCylinder, UsdGeomSphere, UsdGeomCube, UsdGeomBoundable

diff --git a/pxr/usd/usdGeom/wrapCamera.cpp b/pxr/usd/usdGeom/wrapCamera.cpp
@@ -141,9 +141,9 @@ _CreateShutterCloseAttr(UsdGeomCamera &self,
 }
 
 static UsdAttribute
-_CreateExposureCompensationAttr(UsdGeomCamera &self,
+_CreateExposureAttr(UsdGeomCamera &self,
                                       object defaultVal, bool writeSparsely) {
-    return self.CreateExposureCompensationAttr(
+    return self.CreateExposureAttr(
         UsdPythonToSdfType(defaultVal, SdfValueTypeNames->Float), writeSparsely);
 }
 
@@ -280,10 +280,10 @@ void wrapUsdGeomCamera()
              (arg("defaultValue")=object(),
               arg("writeSparsely")=false))
 
-        .def("GetExposureCompensationAttr",
-             &This::GetExposureCompensationAttr)
-        .def("CreateExposureCompensationAttr",
-             &_CreateExposureCompensationAttr,
+        .def("GetExposureAttr",
+             &This::GetExposureAttr)
+        .def("CreateExposureAttr",
+             &_CreateExposureAttr,
              (arg("defaultValue")=object(),
               arg("writeSparsely")=false))
 

diff --git a/pxr/usd/usdGeom/wrapTokens.cpp b/pxr/usd/usdGeom/wrapTokens.cpp
@@ -99,7 +99,7 @@ void wrapUsdGeomTokens()
     _AddToken(cls, "edgeOnly", UsdGeomTokens->edgeOnly);
     _AddToken(cls, "elementSize", UsdGeomTokens->elementSize);
     _AddToken(cls, "elementType", UsdGeomTokens->elementType);
-    _AddToken(cls, "exposureCompensation", UsdGeomTokens->exposureCompensation);
+    _AddToken(cls, "exposure", UsdGeomTokens->exposure);
     _AddToken(cls, "extent", UsdGeomTokens->extent);
     _AddToken(cls, "extentsHint", UsdGeomTokens->extentsHint);
     _AddToken(cls, "face", UsdGeomTokens->face);

diff --git a/pxr/usdImaging/usdImaging/cameraAdapter.cpp b/pxr/usdImaging/usdImaging/cameraAdapter.cpp
@@ -182,9 +182,9 @@ UsdImagingCameraAdapter::TrackVariability(UsdPrim const& prim,
         }
         if ((*timeVaryingBits & HdCamera::DirtyParams) == 0) {
             _IsVarying(prim,
-                UsdGeomTokens->exposureCompensation,
+                UsdGeomTokens->exposure,
                 HdCamera::DirtyParams,
-                HdCameraTokens->exposureCompensation,
+                HdCameraTokens->exposure,
                 timeVaryingBits,
                 false);
         }
@@ -284,9 +284,9 @@ UsdImagingCameraAdapter::Get(UsdPrim const& prim,
         cam.GetShutterCloseAttr().Get(&vShutterClose, time); // conversion n/a
         return vShutterClose;
 
-    } else if (key == HdCameraTokens->exposureCompensation) {
+    } else if (key == HdCameraTokens->exposure) {
         VtValue v;
-        cam.GetExposureCompensationAttr().Get(&v, time); // conversion n/a
+        cam.GetExposureAttr().Get(&v, time); // conversion n/a
         return v;
     }
 
@@ -320,7 +320,7 @@ UsdImagingCameraAdapter::ProcessPropertyChange(UsdPrim const& prim,
              propertyName == UsdGeomTokens->focusDistance ||
              propertyName == UsdGeomTokens->shutterOpen ||
              propertyName == UsdGeomTokens->shutterClose ||
-             propertyName == UsdGeomTokens->exposureCompensation)
+             propertyName == UsdGeomTokens->exposure)
         return HdCamera::DirtyParams;
 
     // XXX: There's no catch-all dirty bit for weird camera params.

diff --git a/third_party/renderman-23/plugin/hdPrman/camera.cpp b/third_party/renderman-23/plugin/hdPrman/camera.cpp
@@ -75,7 +75,7 @@ HdPrmanCamera::Sync(HdSceneDelegate *sceneDelegate,
             HdCameraTokens->focusDistance,
             HdCameraTokens->shutterOpen,
             HdCameraTokens->shutterClose,
-            HdCameraTokens->exposureCompensation
+            HdCameraTokens->exposure
         };
 
         for (TfToken const& param : params) {