Fix invalid enum errors with OpenGL core profile and Storm

Point smooth and line width are only available with the compatibility
profile. NVIDIA drivers report errors when trying to use these with the
core profile.

Author: brechtvl

pxr/imaging/hdSt/renderPassState.cpp

@@ -769,7 +769,9 @@ HdStRenderPassState::Bind(HgiCapabilities const &hgiCapabilities)
         // If not using GL_MULTISAMPLE, use GL_POINT_SMOOTH to render points as 
         // circles instead of square.
         // XXX Switch points rendering to emit quad with FS that draws circle.
-        glEnable(GL_POINT_SMOOTH);
+        if (!hgiCapabilities.GetCoreProfile()) {
+            glEnable(GL_POINT_SMOOTH);
+        }
     }
 }
 
@@ -813,7 +815,9 @@ HdStRenderPassState::Unbind(HgiCapabilities const &hgiCapabilities)
     }
 
     glEnable(GL_MULTISAMPLE);
-    glDisable(GL_POINT_SMOOTH);
+    if (!hgiCapabilities.GetCoreProfile()) {
+        glDisable(GL_POINT_SMOOTH);
+    }
 }
 
 void

pxr/imaging/hgi/capabilities.h

@@ -52,6 +52,11 @@ class HgiCapabilities
     HGI_API
     virtual int GetShaderVersion() const = 0;
 
+    HGI_API
+    virtual bool GetCoreProfile() const {
+        return false;
+    }
+
     HGI_API
     size_t GetMaxUniformBlockSize() const {
         return _maxUniformBlockSize;

pxr/imaging/hgiGL/blitCmds.cpp

@@ -136,7 +136,7 @@ HgiGLBlitCmds::_Submit(Hgi* hgi, HgiSubmitWaitType wait)
     // Capture OpenGL state before executing the 'ops' and restore it when this
     // function ends. We do this defensively because parts of our pipeline may
     // not set and restore all relevant gl state.
-    HgiGL_ScopedStateHolder openglStateGuard;
+    HgiGL_ScopedStateHolder openglStateGuard(*hgi->GetCapabilities());
 
     HgiGL* hgiGL = static_cast<HgiGL*>(hgi);
     HgiGLDevice* device = hgiGL->GetPrimaryDevice();

pxr/imaging/hgiGL/capabilities.cpp

@@ -57,6 +57,7 @@ static const int _DefaultMaxClipDistances             = 8;
 HgiGLCapabilities::HgiGLCapabilities()
     : _glVersion(0)
     , _glslVersion(_DefaultGLSLVersion)
+    , _coreProfile(false)
 {
     _LoadCapabilities();
 }
@@ -131,6 +132,11 @@ HgiGLCapabilities::_LoadCapabilities()
                       &uniformBufferOffsetAlignment);
         _uniformBufferOffsetAlignment = uniformBufferOffsetAlignment;
     }
+    if (_glVersion >= 320) {
+        GLint profileMask = 0;
+        glGetIntegerv(GL_CONTEXT_PROFILE_MASK, &profileMask);
+        _coreProfile = (profileMask & GL_CONTEXT_CORE_PROFILE_BIT);
+    }
     if (_glVersion >= 430) {
         GLint maxShaderStorageBlockSize = 0;
         glGetIntegerv(GL_MAX_SHADER_STORAGE_BLOCK_SIZE,
@@ -259,4 +265,9 @@ HgiGLCapabilities::GetShaderVersion() const {
     return _glslVersion;
 }
 
+bool
+HgiGLCapabilities::GetCoreProfile() const {
+    return _coreProfile;
+}
+
 PXR_NAMESPACE_CLOSE_SCOPE

pxr/imaging/hgiGL/capabilities.h

@@ -52,6 +52,9 @@ class HgiGLCapabilities final : public HgiCapabilities
     HGIGL_API
     int GetShaderVersion() const override;
 
+    HGIGL_API
+    bool GetCoreProfile() const override;
+
 private:
     void _LoadCapabilities();
 
@@ -60,6 +63,9 @@ class HgiGLCapabilities final : public HgiCapabilities
 
     // GLSL version 
     int _glslVersion; // 400, 410, ...
+
+    // Core Profile
+    bool _coreProfile;
 };
 
 PXR_NAMESPACE_CLOSE_SCOPE

pxr/imaging/hgiGL/graphicsCmds.cpp

@@ -249,7 +249,7 @@ HgiGLGraphicsCmds::_Submit(Hgi* hgi, HgiSubmitWaitType wait)
     // Capture OpenGL state before executing the 'ops' and restore it when this
     // function ends. We do this defensively because parts of our pipeline may
     // not set and restore all relevant gl state.
-    HgiGL_ScopedStateHolder openglStateGuard;
+    HgiGL_ScopedStateHolder openglStateGuard(*hgi->GetCapabilities());
 
     // Resolve multisample textures
     HgiGL* hgiGL = static_cast<HgiGL*>(hgi);

pxr/imaging/hgiGL/graphicsPipeline.cpp

@@ -114,6 +114,8 @@ HgiGLGraphicsPipeline::BindPipeline()
         glBindVertexArray(_vao);
     }
 
+    const bool coreProfile = _hgi->GetCapabilities()->GetCoreProfile();
+
     //
     // Depth Stencil State
     //
@@ -178,7 +180,9 @@ HgiGLGraphicsPipeline::BindPipeline()
         // If not using GL_MULTISAMPLE, use GL_POINT_SMOOTH to render points as 
         // circles instead of square.
         // XXX Switch points rendering to emit quad with FS that draws circle.
-        glEnable(GL_POINT_SMOOTH);
+        if (!coreProfile) {
+            glEnable(GL_POINT_SMOOTH);
+        }
     }
     if (_descriptor.multiSampleState.alphaToCoverageEnable) {
         glEnable(GL_SAMPLE_ALPHA_TO_COVERAGE);
@@ -213,7 +217,7 @@ HgiGLGraphicsPipeline::BindPipeline()
         glFrontFace(GL_CCW);
     }
 
-    if (_descriptor.rasterizationState.lineWidth != 1.0f) {
+    if (!coreProfile && _descriptor.rasterizationState.lineWidth != 1.0f) {
         glLineWidth(_descriptor.rasterizationState.lineWidth);
     }
 

pxr/imaging/hgiGL/scopedStateHolder.cpp

@@ -26,15 +26,18 @@
 #include "pxr/imaging/hgiGL/scopedStateHolder.h"
 #include "pxr/imaging/hgiGL/conversions.h"
 #include "pxr/imaging/hgiGL/diagnostic.h"
+#include "pxr/imaging/hgiGL/hgi.h"
 
 #include "pxr/base/trace/trace.h"
 #include "pxr/base/tf/diagnostic.h"
 #include "pxr/base/tf/iterator.h"
 
 PXR_NAMESPACE_OPEN_SCOPE
 
-HgiGL_ScopedStateHolder::HgiGL_ScopedStateHolder()
-    : _restoreRenderBuffer(0)
+HgiGL_ScopedStateHolder::HgiGL_ScopedStateHolder(
+    HgiCapabilities const& capabilities)
+    : _coreProfile(capabilities.GetCoreProfile())
+    , _restoreRenderBuffer(0)
     , _restoreVao(0)
     , _restoreDepthTest(false)
     , _restoreDepthWriteMask(false)
@@ -115,7 +118,9 @@ HgiGL_ScopedStateHolder::HgiGL_ScopedStateHolder()
     glGetBooleanv(
         GL_SAMPLE_ALPHA_TO_ONE,
         (GLboolean*)&_restoreSampleAlphaToOne);
-    glGetFloatv(GL_LINE_WIDTH, &_lineWidth);
+    if (!_coreProfile) {
+        glGetFloatv(GL_LINE_WIDTH, &_lineWidth);
+    }
     glGetBooleanv(GL_CULL_FACE, (GLboolean*)&_cullFace);
     glGetIntegerv(GL_CULL_FACE_MODE, &_cullMode);
     glGetIntegerv(GL_FRONT_FACE, &_frontFace);
@@ -139,7 +144,9 @@ HgiGL_ScopedStateHolder::HgiGL_ScopedStateHolder()
     }
 
     glGetBooleanv(GL_MULTISAMPLE, (GLboolean*)&_restoreMultiSample);
-    glGetBooleanv(GL_POINT_SMOOTH, (GLboolean*)&_restorePointSmooth);
+    if (!_coreProfile) {
+        glGetBooleanv(GL_POINT_SMOOTH, (GLboolean*)&_restorePointSmooth);
+    }
 
     HGIGL_POST_PENDING_GL_ERRORS();
     #if defined(GL_KHR_debug)
@@ -235,7 +242,9 @@ HgiGL_ScopedStateHolder::~HgiGL_ScopedStateHolder()
                _restoreViewport[2], _restoreViewport[3]);
     glBindVertexArray(_restoreVao);
     glBindRenderbuffer(GL_RENDERBUFFER, _restoreRenderBuffer);
-    glLineWidth(_lineWidth);
+    if (!_coreProfile) {
+        glLineWidth(_lineWidth);
+    }
     if (_cullFace) {
         glEnable(GL_CULL_FACE);
     } else {
@@ -285,10 +294,12 @@ HgiGL_ScopedStateHolder::~HgiGL_ScopedStateHolder()
         glDisable(GL_MULTISAMPLE);
     }
 
-    if (_restorePointSmooth) {
-        glEnable(GL_POINT_SMOOTH);
-    } else {
-        glDisable(GL_POINT_SMOOTH);
+    if (!_coreProfile) {
+        if (_restorePointSmooth) {
+            glEnable(GL_POINT_SMOOTH);
+        } else {
+            glDisable(GL_POINT_SMOOTH);
+        }
     }
 
     static const GLuint samplers[8] = {0};

pxr/imaging/hgiGL/scopedStateHolder.h

@@ -32,6 +32,7 @@
 
 PXR_NAMESPACE_OPEN_SCOPE
 
+class HgiCapabilities;
 
 /// \class HgiGLScopedStateHolder
 ///
@@ -50,7 +51,7 @@ class HgiGL_ScopedStateHolder final
 {
 public:
     HGIGL_API
-    HgiGL_ScopedStateHolder();
+    HgiGL_ScopedStateHolder(HgiCapabilities const& capabilities);
 
     HGIGL_API
     ~HgiGL_ScopedStateHolder();
@@ -59,6 +60,8 @@ class HgiGL_ScopedStateHolder final
     HgiGL_ScopedStateHolder& operator=(const HgiGL_ScopedStateHolder&) = delete;
     HgiGL_ScopedStateHolder(const HgiGL_ScopedStateHolder&) = delete;
 
+    bool _coreProfile;
+
     int32_t _restoreRenderBuffer;
     int32_t _restoreVao;