Autodesk · hodoulp · Aug 27, 2025 · Jul 25, 2025 · Jul 25, 2025 · Jul 25, 2025
diff --git a/include/hvt/engine/framePass.h b/include/hvt/engine/framePass.h
@@ -22,7 +22,6 @@
 #include <hvt/engine/syncDelegate.h>
 #include <hvt/engine/taskManager.h>
 #include <hvt/engine/viewportEngine.h>
-#include <hvt/engine/viewportRect.h>
 
 // clang-format off
 #if defined(__clang__)
@@ -88,9 +87,25 @@ struct HVT_API ViewParams
 
     PXR_NS::GfVec3d cameraPosition;
 
-    /// The viewport dimensions including position and size.
-    /// \note viewport used in HdxRenderTaskParams is a right-down coordinate system
-    ViewportRect viewport;
+    /// Defines the framing.
+    PXR_NS::CameraUtilFraming framing;
+
+    /// Helper to get a default framing.
+    static PXR_NS::CameraUtilFraming GetDefaultFraming(int width, int height)
+    {
+        /// \note This is to display all the render buffer content into the screen.
+        return { { { 0, 0 }, { static_cast<float>(width), static_cast<float>(height) } },
+            { { 0, 0 }, { width, height } }, 1.0f };
+    }
+
+    /// Helper to get a default framing.
+    static PXR_NS::CameraUtilFraming GetDefaultFraming(int posX, int posY, int width, int height)
+    {
+        /// \note This is to display all the render buffer content into the screen potentially
+        /// moving its origin and resizing it.
+        return PXR_NS::CameraUtilFraming(
+            PXR_NS::GfRect2i(PXR_NS::GfVec2i(posX, posY), width, height));
+    }
 
     bool isOrtho { false };
     double cameraDistance { 0.0 };
@@ -309,10 +324,16 @@ class HVT_API FramePass
     /// \return A collection of parameters that can be set for this frame pass.
     inline const FramePassParams& params() const { return _passParams; }
 
-    /// Gets the viewport dimensions.
-    virtual const PXR_NS::GfVec4i GetViewport() const
+    /// Gets the display window position & dimension.
+    inline const PXR_NS::GfRange2f GetDisplayWindow() const
+    {
+        return params().viewInfo.framing.displayWindow;
+    }
+
+    /// Gets the data window dimension.
+    inline const PXR_NS::GfRect2i GetDataWindow() const
     {
-        return params().viewInfo.viewport.ConvertToVec4i();
+        return params().viewInfo.framing.dataWindow;
     }
 
     /// \name Shadows

diff --git a/include/hvt/engine/framePassUtils.h b/include/hvt/engine/framePassUtils.h
@@ -28,11 +28,11 @@ namespace HVT_NS
 /// Returns the first picked prim from a specific frame pass.
 /// \param pass The selected frame pass.
 /// \param pickingMatrix The picking matrix.
-/// \param viewport The viewport dimensions.
+/// \param framing The framing (i.e., data & display windows).
 /// \param viewMatrix The view matrix.
 /// \return Returns the first selected prim.
 HVT_API extern PXR_NS::SdfPath GetPickedPrim(FramePass* pass,
-    PXR_NS::GfMatrix4d const& pickingMatrix, ViewportRect const& viewport,
+    PXR_NS::GfMatrix4d const& pickingMatrix, PXR_NS::CameraUtilFraming const& framing,
     PXR_NS::GfMatrix4d const& viewMatrix);
 
 /// @}

diff --git a/include/hvt/engine/viewportRect.h b/include/hvt/engine/viewportRect.h
diff --git a/source/engine/CMakeLists.txt b/source/engine/CMakeLists.txt
@@ -57,7 +57,6 @@ set(_HEADER_FILES
     "${_ENGINE_INCLUDE_DIR}/usdStageUtils.h"
     "${_ENGINE_INCLUDE_DIR}/viewport.h"
     "${_ENGINE_INCLUDE_DIR}/viewportEngine.h"
-    "${_ENGINE_INCLUDE_DIR}/viewportRect.h"
 )
 
 # Define the library.

diff --git a/source/engine/framePass.cpp b/source/engine/framePass.cpp
@@ -270,9 +270,7 @@ HdTaskSharedPtrVector FramePass::GetRenderTasks(RenderBufferBindings const& inpu
 
     // Sets the framing.
     // Note: Do not set the viewport as it's deprecated.
-
-    const GfRect2i viewport4d = _passParams.viewInfo.viewport.ConvertToRect2i();
-    SetFraming(_passParams.renderParams, CameraUtilFraming(viewport4d), GetRenderIndex());
+    SetFraming(_passParams.renderParams, _passParams.viewInfo.framing, GetRenderIndex());
 
     // Set the specified AOV as the one to visualize using the color output. By default this is
     // the color AOV, with no special transformation performed. For any other AOV, the AOV data is

diff --git a/source/engine/framePassUtils.cpp b/source/engine/framePassUtils.cpp
@@ -20,7 +20,7 @@ namespace HVT_NS
 {
 
 SdfPath GetPickedPrim(FramePass* pass, GfMatrix4d const& pickingMatrix,
-    ViewportRect const& viewport, GfMatrix4d const& viewMatrix)
+    CameraUtilFraming const& framing, GfMatrix4d const& viewMatrix)
 {
     if (!pass || !pass->IsInitialized())
     {
@@ -30,7 +30,7 @@ SdfPath GetPickedPrim(FramePass* pass, GfMatrix4d const& pickingMatrix,
 
     SdfPath hitPrimPath;
 
-    pass->params().viewInfo.viewport         = viewport;
+    pass->params().viewInfo.framing          = framing;
     pass->params().viewInfo.viewMatrix       = viewMatrix;
     pass->params().viewInfo.projectionMatrix = pickingMatrix;
 

diff --git a/test/data/baselines/TestFramePasses_DisplayClipping1_osx.png b/test/data/baselines/TestFramePasses_DisplayClipping1_osx.png
diff --git a/test/data/baselines/TestFramePasses_DisplayClipping2_osx.png b/test/data/baselines/TestFramePasses_DisplayClipping2_osx.png
diff --git a/test/howTos/howTo02_CreateOneFramePass.cpp b/test/howTos/howTo02_CreateOneFramePass.cpp
@@ -71,8 +71,9 @@ TEST(howTo, createOneFramePass)
         auto& params = sceneFramePass->params();
 
         params.renderBufferSize = pxr::GfVec2i(context->width(), context->height());
+        params.viewInfo.framing =
+            hvt::ViewParams::GetDefaultFraming(context->width(), context->height());
 
-        params.viewInfo.viewport         = { { 0, 0 }, { context->width(), context->height() } };
         params.viewInfo.viewMatrix       = stage.viewMatrix();
         params.viewInfo.projectionMatrix = stage.projectionMatrix();
         params.viewInfo.lights           = stage.defaultLights();
@@ -96,8 +97,8 @@ TEST(howTo, createOneFramePass)
 
     // Validates the rendering result.
 
-    const std::string imageFile = std::string(test_info_->test_suite_name()) +
-        std::string("/") + std::string(test_info_->name());
+    const std::string imageFile = std::string(test_info_->test_suite_name()) + std::string("/") +
+        std::string(test_info_->name());
 
     ASSERT_TRUE(context->_backend->saveImage(imageFile));
 

diff --git a/test/howTos/howTo03_CreateTwoFramePasses.cpp b/test/howTos/howTo03_CreateTwoFramePasses.cpp
@@ -18,8 +18,8 @@
 
 #include <RenderingFramework/TestContextCreator.h>
 
-#include <hvt/tasks/resources.h>
 #include <hvt/engine/viewportEngine.h>
+#include <hvt/tasks/resources.h>
 
 #include <pxr/base/plug/registry.h>
 
@@ -72,10 +72,9 @@ TEST(howTo, createTwoFramePasses)
         // Creates the frame pass instance.
 
         hvt::FramePassDescriptor passDesc;
-        passDesc.renderIndex = mainFramePass.renderIndex->RenderIndex();
-        passDesc.uid         = pxr::SdfPath("/sceneFramePass");
-        mainFramePass.sceneFramePass =
-            hvt::ViewportEngine::CreateFramePass(passDesc);
+        passDesc.renderIndex         = mainFramePass.renderIndex->RenderIndex();
+        passDesc.uid                 = pxr::SdfPath("/sceneFramePass");
+        mainFramePass.sceneFramePass = hvt::ViewportEngine::CreateFramePass(passDesc);
     }
 
     // Defines a secondary frame pass containing a manipulator.
@@ -86,8 +85,7 @@ TEST(howTo, createTwoFramePasses)
         hvt::RendererDescriptor renderDesc;
         renderDesc.hgiDriver    = &context->_backend->hgiDriver();
         renderDesc.rendererName = "HdStormRendererPlugin";
-        hvt::ViewportEngine::CreateRenderer(
-            manipulatorFramePass.renderIndex, renderDesc);
+        hvt::ViewportEngine::CreateRenderer(manipulatorFramePass.renderIndex, renderDesc);
 
         // Loads an arbitrary USD asset e.g., a manipulator in this case.
 
@@ -104,24 +102,25 @@ TEST(howTo, createTwoFramePasses)
         // Creates the frame pass instance.
 
         hvt::FramePassDescriptor passDesc;
-        passDesc.renderIndex = manipulatorFramePass.renderIndex->RenderIndex();
-        passDesc.uid         = pxr::SdfPath("/sceneFramePass");
-        manipulatorFramePass.sceneFramePass =
-            hvt::ViewportEngine::CreateFramePass(passDesc);
+        passDesc.renderIndex                = manipulatorFramePass.renderIndex->RenderIndex();
+        passDesc.uid                        = pxr::SdfPath("/sceneFramePass");
+        manipulatorFramePass.sceneFramePass = hvt::ViewportEngine::CreateFramePass(passDesc);
     }
 
     // Renders 10 times (i.e., arbitrary number to guarantee best result).
     int frameCount = 10;
 
-    auto render = [&]() {
+    auto render = [&]()
+    {
         // Updates the main frame pass.
 
         {
             auto& params = mainFramePass.sceneFramePass->params();
 
             params.renderBufferSize = pxr::GfVec2i(context->width(), context->height());
+            params.viewInfo.framing =
+                hvt::ViewParams::GetDefaultFraming(context->width(), context->height());
 
-            params.viewInfo.viewport         = { { 0, 0 }, { context->width(), context->height() } };
             params.viewInfo.viewMatrix       = stage.viewMatrix();
             params.viewInfo.projectionMatrix = stage.projectionMatrix();
             params.viewInfo.lights           = stage.defaultLights();
@@ -166,8 +165,10 @@ TEST(howTo, createTwoFramePasses)
             auto& params = manipulatorFramePass.sceneFramePass->params();
 
             params.renderBufferSize = pxr::GfVec2i(context->width(), context->height());
+            params.viewInfo.framing = { { { posX, posY },
+                                  { static_cast<float>(width), static_cast<float>(height) } },
+                { { 0, 0 }, { width, height } }, 1.0f };
 
-            params.viewInfo.viewport         = { { posX, posY }, { width, height } };
             params.viewInfo.viewMatrix       = stage.viewMatrix();
             params.viewInfo.projectionMatrix = stage.projectionMatrix();
             params.viewInfo.lights           = stage.defaultLights();

diff --git a/test/howTos/howTo04_CreateACustomRenderTask.cpp b/test/howTos/howTo04_CreateACustomRenderTask.cpp
@@ -109,8 +109,9 @@ TEST(howTo, createACustomRenderTask)
         auto& params = sceneFramePass->params();
 
         params.renderBufferSize = pxr::GfVec2i(context->width(), context->height());
+        params.viewInfo.framing =
+            hvt::ViewParams::GetDefaultFraming(context->width(), context->height());
 
-        params.viewInfo.viewport         = { { 0, 0 }, { context->width(), context->height() } };
         params.viewInfo.viewMatrix       = stage.viewMatrix();
         params.viewInfo.projectionMatrix = stage.projectionMatrix();
         params.viewInfo.lights           = stage.defaultLights();

diff --git a/test/howTos/howTo05_UseSSAORenderTask.cpp b/test/howTos/howTo05_UseSSAORenderTask.cpp
@@ -120,8 +120,9 @@ TEST(howTo, useSSAORenderTask)
         {
             auto& params = sceneFramePass->params();
 
-            params.viewInfo.viewport = { { 0, 0 }, { context->width(), context->height() } };
             params.renderBufferSize  = GfVec2i(context->width(), context->height());
+            params.viewInfo.framing =
+                hvt::ViewParams::GetDefaultFraming(context->width(), context->height());
 
             params.viewInfo.viewMatrix       = stage.viewMatrix();
             params.viewInfo.projectionMatrix = stage.projectionMatrix();

diff --git a/test/howTos/howTo06_UseFXAARenderTask.cpp b/test/howTos/howTo06_UseFXAARenderTask.cpp
@@ -107,8 +107,9 @@ TEST(howTo, useFXAARenderTask)
 
         auto& params = sceneFramePass->params();
 
-        params.viewInfo.viewport = { { 0, 0 }, { context->width(), context->height() } };
         params.renderBufferSize  = GfVec2i(context->width(), context->height());
+        params.viewInfo.framing =
+            hvt::ViewParams::GetDefaultFraming(context->width(), context->height());
 
         params.viewInfo.viewMatrix       = stage.viewMatrix();
         params.viewInfo.projectionMatrix = stage.projectionMatrix();

diff --git a/test/howTos/howTo07_UseIncludeExclude.cpp b/test/howTos/howTo07_UseIncludeExclude.cpp
@@ -76,30 +76,29 @@ void CreateTest(const std::shared_ptr<TestHelpers::TestContext>& context,
     auto render = [&]() {
         // Updates the main frame pass.
 
-        {
-            auto& params = sceneFramePass->params();
+        auto& params = sceneFramePass->params();
 
-            params.renderBufferSize = GfVec2i(context->width(), context->height());
+        params.renderBufferSize = GfVec2i(context->width(), context->height());
+        params.viewInfo.framing =
+            hvt::ViewParams::GetDefaultFraming(context->width(), context->height());
 
-            params.viewInfo.viewport   = { { 0, 0 }, { context->width(), context->height() } };
-            params.viewInfo.viewMatrix = stage.viewMatrix();
-            params.viewInfo.projectionMatrix = stage.projectionMatrix();
-            params.viewInfo.lights           = stage.defaultLights();
-            params.viewInfo.material         = stage.defaultMaterial();
-            params.viewInfo.ambient          = stage.defaultAmbient();
+        params.viewInfo.viewMatrix = stage.viewMatrix();
+        params.viewInfo.projectionMatrix = stage.projectionMatrix();
+        params.viewInfo.lights           = stage.defaultLights();
+        params.viewInfo.material         = stage.defaultMaterial();
+        params.viewInfo.ambient          = stage.defaultAmbient();
 
-            params.colorspace      = HdxColorCorrectionTokens->sRGB;
-            params.backgroundColor = TestHelpers::ColorDarkGrey;
-            params.selectionColor  = TestHelpers::ColorYellow;
+        params.colorspace      = HdxColorCorrectionTokens->sRGB;
+        params.backgroundColor = TestHelpers::ColorDarkGrey;
+        params.selectionColor  = TestHelpers::ColorYellow;
 
-            params.enablePresentation = context->presentationEnabled();
+        params.enablePresentation = context->presentationEnabled();
 
-            // Selects what prims to render.
-            params.collection = collection;
+        // Selects what prims to render.
+        params.collection = collection;
 
-            // Renders.
-            sceneFramePass->Render();
-        }
+        // Renders.
+        sceneFramePass->Render();
 
         return --frameCount > 0;
     };