Allow explicit overlay alpha from scripts

interface/src/scripting/DesktopScriptingInterface.cpp

@@ -16,6 +16,7 @@
 
 #include "Application.h"
 #include "MainWindow.h"
+#include <display-plugins/CompositorHelper.h>
 
 int DesktopScriptingInterface::getWidth() {
     QSize size = qApp->getWindow()->windowHandle()->screen()->virtualSize();
@@ -25,3 +26,8 @@ int DesktopScriptingInterface::getHeight() {
     QSize size = qApp->getWindow()->windowHandle()->screen()->virtualSize();
     return size.height();
 }
+
+void DesktopScriptingInterface::setOverlayAlpha(float alpha) {
+    qApp->getApplicationCompositor().setAlpha(alpha);
+}
+

interface/src/scripting/DesktopScriptingInterface.h

@@ -22,6 +22,8 @@ class DesktopScriptingInterface : public QObject, public Dependency {
     Q_PROPERTY(int height READ getHeight)  // Physical height of screen(s) including task bars and system menus
 
 public:
+    Q_INVOKABLE void setOverlayAlpha(float alpha);
+
     int getWidth();
     int getHeight();
 };

libraries/display-plugins/src/display-plugins/CompositorHelper.h

@@ -38,6 +38,7 @@ const float MAGNIFY_MULT = 2.0f;
 class CompositorHelper : public QObject, public Dependency {
     Q_OBJECT
 
+    Q_PROPERTY(float alpha READ getAlpha WRITE setAlpha NOTIFY alphaChanged)
     Q_PROPERTY(bool reticleOverDesktop READ getReticleOverDesktop WRITE setReticleOverDesktop)
 public:
     static const uvec2 VIRTUAL_SCREEN_SIZE;
@@ -74,6 +75,9 @@ public:
     void setModelTransform(const Transform& transform) { _modelTransform = transform; }
     const Transform& getModelTransform() const { return _modelTransform; }
 
+    float getAlpha() const { return _alpha; }
+    void setAlpha(float alpha) { if (alpha != _alpha) { emit alphaChanged();  _alpha = alpha; } }
+
     bool getReticleVisible() const { return _reticleVisible; }
     void setReticleVisible(bool visible) { _reticleVisible = visible; }
 
@@ -109,6 +113,7 @@ public:
 
 signals:
     void allowMouseCaptureChanged();
+    void alphaChanged();
 
 protected slots:
     void sendFakeMouseEvent();
@@ -134,6 +139,7 @@ private:
     float _textureFov { VIRTUAL_UI_TARGET_FOV.y };
     float _textureAspectRatio { VIRTUAL_UI_ASPECT_RATIO };
 
+    float _alpha { 1.0f };
     float _hmdUIRadius { 1.0f };
 
     int _previousBorderWidth { -1 };

libraries/display-plugins/src/display-plugins/OpenGLDisplayPlugin.cpp

@@ -273,11 +273,23 @@ bool OpenGLDisplayPlugin::activate() {
     _container->makeRenderingContextCurrent();
 #endif
 
+    auto compositorHelper = DependencyManager::get<CompositorHelper>();
+    connect(compositorHelper.data(), &CompositorHelper::alphaChanged, [this] {
+        auto compositorHelper = DependencyManager::get<CompositorHelper>();
+        auto animation = new QPropertyAnimation(this, "overlayAlpha");
+        animation->setDuration(200);
+        animation->setEndValue(compositorHelper->getAlpha());
+        animation->start();
+    });
+
     return DisplayPlugin::activate();
 }
 
 void OpenGLDisplayPlugin::deactivate() {
     
+    auto compositorHelper = DependencyManager::get<CompositorHelper>();
+    disconnect(compositorHelper.data());
+
 #if THREADED_PRESENT
     auto presentThread = DependencyManager::get<PresentThread>();
     // Does not return until the GL transition has completeed
@@ -445,6 +457,8 @@ void OpenGLDisplayPlugin::compositeOverlay() {
     auto compositorHelper = DependencyManager::get<CompositorHelper>();
 
     useProgram(_program);
+    // set the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(_compositeOverlayAlpha);
     // check the alpha
     // Overlay draw
     if (isStereo()) {
@@ -458,6 +472,8 @@ void OpenGLDisplayPlugin::compositeOverlay() {
         Uniform<glm::mat4>(*_program, _mvpUniform).Set(mat4());
         drawUnitQuad();
     }
+    // restore the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(1.0);
 }
 
 void OpenGLDisplayPlugin::compositePointer() {
@@ -465,6 +481,8 @@ void OpenGLDisplayPlugin::compositePointer() {
     auto compositorHelper = DependencyManager::get<CompositorHelper>();
 
     useProgram(_program);
+    // set the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(_compositeOverlayAlpha);
     Uniform<glm::mat4>(*_program, _mvpUniform).Set(compositorHelper->getReticleTransform(glm::mat4()));
     if (isStereo()) {
         for_each_eye([&](Eye eye) {
@@ -475,6 +493,8 @@ void OpenGLDisplayPlugin::compositePointer() {
         drawUnitQuad();
     }
     Uniform<glm::mat4>(*_program, _mvpUniform).Set(mat4());
+    // restore the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(1.0);
 }
 
 void OpenGLDisplayPlugin::compositeScene() {
@@ -682,3 +702,10 @@ void OpenGLDisplayPlugin::assertIsRenderThread() const {
 void OpenGLDisplayPlugin::assertIsPresentThread() const {
     Q_ASSERT(QThread::currentThread() == _presentThread);
 }
+
+bool OpenGLDisplayPlugin::beginFrameRender(uint32_t frameIndex) {
+    withRenderThreadLock([&] {
+        _compositeOverlayAlpha = _overlayAlpha;
+    });
+    return Parent::beginFrameRender(frameIndex);
+}

libraries/display-plugins/src/display-plugins/OpenGLDisplayPlugin.h

@@ -24,6 +24,9 @@
 #define THREADED_PRESENT 1
 
 class OpenGLDisplayPlugin : public DisplayPlugin {
+    Q_OBJECT
+    Q_PROPERTY(float overlayAlpha MEMBER _overlayAlpha)
+    using Parent = DisplayPlugin;
 protected:
     using Mutex = std::mutex;
     using Lock = std::unique_lock<Mutex>;
@@ -60,6 +63,7 @@ public:
 
     float droppedFrameRate() const override;
 
+    bool beginFrameRender(uint32_t frameIndex) override;
 protected:
 #if THREADED_PRESENT
     friend class PresentThread;
@@ -115,7 +119,8 @@ protected:
     RateCounter<> _presentRate;
     QMap<gpu::TexturePointer, uint32_t> _sceneTextureToFrameIndexMap;
     uint32_t _currentPresentFrameIndex { 0 };
-
+    float _compositeOverlayAlpha{ 1.0f };
+    
     gpu::TexturePointer _currentSceneTexture;
     gpu::TexturePointer _currentOverlayTexture;
 
@@ -157,6 +162,7 @@ private:
     // be serialized through this mutex
     mutable Mutex _presentMutex;
     ProgramPtr _activeProgram;
+    float _overlayAlpha{ 1.0f };
 };
 
 

libraries/display-plugins/src/display-plugins/hmd/HmdDisplayPlugin.cpp

@@ -287,6 +287,8 @@ void HmdDisplayPlugin::compositeOverlay() {
     glm::mat4 modelMat = compositorHelper->getModelTransform().getMatrix();
 
     useProgram(_program);
+    // set the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(_compositeOverlayAlpha);
     _sphereSection->Use();
     for_each_eye([&](Eye eye) {
         eyeViewport(eye);
@@ -295,6 +297,8 @@ void HmdDisplayPlugin::compositeOverlay() {
         Uniform<glm::mat4>(*_program, _mvpUniform).Set(mvp);
         _sphereSection->Draw();
     });
+    // restore the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(1.0);
 }
 
 void HmdDisplayPlugin::compositePointer() {
@@ -302,8 +306,9 @@ void HmdDisplayPlugin::compositePointer() {
 
     auto compositorHelper = DependencyManager::get<CompositorHelper>();
 
-    // check the alpha
     useProgram(_program);
+    // set the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(_compositeOverlayAlpha);
 
     // Mouse pointer
     _plane->Use();
@@ -317,6 +322,8 @@ void HmdDisplayPlugin::compositePointer() {
         Uniform<glm::mat4>(*_program, _mvpUniform).Set(mvp);
         _plane->Draw();
     });
+    // restore the alpha
+    Uniform<float>(*_program, _alphaUniform).Set(1.0);
 }
 
 

plugins/oculus/src/OculusBaseDisplayPlugin.cpp

@@ -45,7 +45,7 @@ bool OculusBaseDisplayPlugin::beginFrameRender(uint32_t frameIndex) {
         _handPoses = handPoses;
         _frameInfos[frameIndex] = _currentRenderFrameInfo;
     });
-    return true;
+    return Parent::beginFrameRender(frameIndex);
 }
 
 bool OculusBaseDisplayPlugin::isSupported() const {

plugins/oculusLegacy/src/OculusLegacyDisplayPlugin.cpp

@@ -41,6 +41,7 @@ void OculusLegacyDisplayPlugin::resetSensors() {
 }
 
 bool OculusLegacyDisplayPlugin::beginFrameRender(uint32_t frameIndex) {
+
     _currentRenderFrameInfo = FrameInfo();
     _currentRenderFrameInfo.predictedDisplayTime = _currentRenderFrameInfo.sensorSampleTime = ovr_GetTimeInSeconds();
     _trackingState = ovrHmd_GetTrackingState(_hmd, _currentRenderFrameInfo.predictedDisplayTime);
@@ -48,7 +49,7 @@ bool OculusLegacyDisplayPlugin::beginFrameRender(uint32_t frameIndex) {
     withRenderThreadLock([&]{
         _frameInfos[frameIndex] = _currentRenderFrameInfo;
     });
-    return true;
+    return Parent::beginFrameRender(frameIndex);
 }
 
 bool OculusLegacyDisplayPlugin::isSupported() const {

plugins/openvr/src/OpenVrDisplayPlugin.cpp

@@ -204,7 +204,7 @@ bool OpenVrDisplayPlugin::beginFrameRender(uint32_t frameIndex) {
         _handPoses = handPoses;
         _frameInfos[frameIndex] = _currentRenderFrameInfo;
     });
-    return true;
+    return Parent::beginFrameRender(frameIndex);
 }
 
 void OpenVrDisplayPlugin::hmdPresent() {