Add public API for transparent picking

google · Oct 17, 2024 · f12d701 · f12d701
1 parent e9f8085
commit f12d701
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/filament/include/filament/View.h b/filament/include/filament/View.h
@@ -668,6 +668,26 @@ class UTILS_PUBLIC View : public FilamentAPI {
      */
     bool isFrontFaceWindingInverted() const noexcept;
 
+    /**
+     * Enables or disables transparent picking. Disabled by default.
+     *
+     * When transparent picking is enabled, View::pick() will pick from both
+     * transparent and opaque renderables. When disabled, View::pick() will only
+     * pick from opaque renderables.
+     *
+     * @param enabled true enables transparent picking, false disables it.
+     *
+     * @note Transparent picking will create an extra pass for rendering depth
+     *       from both transparent and opaque renderables. 
+     */
+    void setTransparentPickingEnabled(bool enabled) noexcept;
+
+    /**
+     * Returns true if transparent picking is enabled.
+     * See setTransparentPickingEnabled() for more information.
+     */
+    bool isTransparentPickingEnabled() const noexcept;
+
     /**
      * Enables use of the stencil buffer.
      *

diff --git a/filament/src/View.cpp b/filament/src/View.cpp
@@ -185,6 +185,14 @@ bool View::isFrontFaceWindingInverted() const noexcept {
     return downcast(this)->isFrontFaceWindingInverted();
 }
 
+void View::setTransparentPickingEnabled(bool enabled) noexcept {
+    downcast(this)->setTransparentPickingEnabled(enabled);
+}
+
+bool View::isTransparentPickingEnabled() const noexcept {
+    return downcast(this)->isTransparentPickingEnabled();
+}
+
 void View::setDynamicLightingOptions(float zLightNear, float zLightFar) noexcept {
     downcast(this)->setDynamicLightingOptions(zLightNear, zLightFar);
 }