allow OpenGL on MacOS when possible

Author: slomp

public/tracy/TracyOpenGL.hpp

@@ -1,7 +1,7 @@
 #ifndef __TRACYOPENGL_HPP__
 #define __TRACYOPENGL_HPP__
 
-#if !defined TRACY_ENABLE || defined __APPLE__
+#if !defined TRACY_ENABLE
 
 #define TracyGpuContext
 #define TracyGpuContextName(x,y)
@@ -31,6 +31,10 @@ class GpuCtxScope
 
 #else
 
+#if (defined __APPLE__ && !TARGET_OS_OSX)
+#error Apple devices do not support OpenGL (except on MacOS where it's deprecated).
+#endif
+
 #include <atomic>
 #include <assert.h>
 #include <stdlib.h>
@@ -94,21 +98,30 @@ class GpuCtx
 
 public:
     GpuCtx()
-        : m_context( GetGpuCtxCounter().fetch_add( 1, std::memory_order_relaxed ) )
+        : m_context( 255 )
         , m_head( 0 )
         , m_tail( 0 )
     {
-        assert( m_context != 255 );
+        ZoneScopedC( Color::Red4 );
+
+        GLint bits = 0;
+        glGetQueryiv( GL_TIMESTAMP, GL_QUERY_COUNTER_BITS, &bits );
+        assert( bits > 0 );
+        if( bits == 0 )
+        {
+            // all timestamp queries would resolve to 0 (and produce 0ns GPU zones).
+            // (this is the case for many TBDR GPUs, including Apple Silicon)
+            Profiler::LogString( MessageSourceType::Tracy, MessageSeverity::Error, Color::Red4, 0,
+                "OpenGL driver does not implement GL_TIMESTAMP precision." );
+            return;
+        }
 
         glGenQueries( QueryCount, m_query );
 
         int64_t tgpu;
         glGetInteger64v( GL_TIMESTAMP, &tgpu );
         int64_t tcpu = Profiler::GetTime();
 
-        GLint bits;
-        glGetQueryiv( GL_TIMESTAMP, GL_QUERY_COUNTER_BITS, &bits );
-
 #ifdef TRACY_OPENGL_AUTO_CALIBRATION
         // The anchor above is never refreshed; advertise calibration and emit periodic
         // GpuCalibration events to correct CPU/GPU drift (see Recalibrate). Opt-in,
@@ -117,6 +130,9 @@ class GpuCtx
         m_prevCalibration = GetHostTimeNs();
 #endif
 
+        assert( m_context != 255 );
+        m_context = GetGpuCtxCounter().fetch_add( 1, std::memory_order_relaxed );
+
         const float period = 1.f;
         const auto thread = GetThreadHandle();
         TracyLfqPrepare( QueueType::GpuNewContext );
@@ -141,6 +157,8 @@ class GpuCtx
 
     void Name( const char* name, uint16_t len )
     {
+        if ( !Valid() ) return;
+
         auto ptr = (char*)tracy_malloc( len );
         memcpy( ptr, name, len );
 
@@ -156,6 +174,8 @@ class GpuCtx
 
     void Collect()
     {
+        if ( !Valid() ) return;
+
         ZoneScopedC( Color::Red4 );
 
 #ifdef TRACY_ON_DEMAND
@@ -244,6 +264,11 @@ class GpuCtx
         return m_context;
     }
 
+    tracy_force_inline bool Valid() const
+    {
+        return m_context != 255;
+    }
+
     unsigned int m_query[QueryCount];
     uint8_t m_context;
 
@@ -265,7 +290,7 @@ class GpuCtxScope
         : m_active( is_active )
 #endif
     {
-        if( !m_active ) return;
+        if( !m_active || !Valid() ) return;
 
         const auto queryId = GetGpuCtx().ptr->NextQueryId();
         glQueryCounter( GetGpuCtx().ptr->TranslateOpenGlQueryId( queryId ), GL_TIMESTAMP );
@@ -286,7 +311,7 @@ class GpuCtxScope
         : m_active( is_active )
 #endif
     {
-        if( !m_active ) return;
+        if( !m_active || !Valid() ) return;
 
         const auto queryId = GetGpuCtx().ptr->NextQueryId();
         glQueryCounter( GetGpuCtx().ptr->TranslateOpenGlQueryId( queryId ), GL_TIMESTAMP );
@@ -313,7 +338,7 @@ class GpuCtxScope
         : m_active( is_active )
 #endif
     {
-        if( !m_active ) return;
+        if( !m_active || !Valid() ) return;
 
         const auto queryId = GetGpuCtx().ptr->NextQueryId();
         glQueryCounter( GetGpuCtx().ptr->TranslateOpenGlQueryId( queryId ), GL_TIMESTAMP );
@@ -335,7 +360,7 @@ class GpuCtxScope
         : m_active( is_active )
 #endif
     {
-        if( !m_active ) return;
+        if( !m_active || !Valid() ) return;
 
         const auto queryId = GetGpuCtx().ptr->NextQueryId();
         glQueryCounter( GetGpuCtx().ptr->TranslateOpenGlQueryId( queryId ), GL_TIMESTAMP );
@@ -358,7 +383,7 @@ class GpuCtxScope
 
     tracy_force_inline ~GpuCtxScope()
     {
-        if( !m_active ) return;
+        if( !m_active || !Valid() ) return;
 
         const auto queryId = GetGpuCtx().ptr->NextQueryId();
         glQueryCounter( GetGpuCtx().ptr->TranslateOpenGlQueryId( queryId ), GL_TIMESTAMP );
@@ -371,6 +396,11 @@ class GpuCtxScope
         TracyLfqCommit;
     }
 
+    tracy_force_inline bool Valid()
+    {
+        return GetGpuCtx().ptr->Valid();
+    }
+
 private:
     const bool m_active;
 };