feat: base visionOS bgfx implementation (#3289)

Co-authored-by: mani3xis <[email protected]> fix: properly set storageMode cleanup: remove unused variables fix crash while releasing m_drawable on visionOS fix: remove unused timing variable fix: file name cases, cleanup feat: integrate visionOS into bgfx examples
bkaradzic · Jun 3, 2024 · 3195593 · 3195593
1 parent 00fa5ad
commit 3195593
Show file tree

Hide file tree

Showing 8 changed files with 110 additions and 30 deletions.
diff --git a/examples/common/entry/dialog.cpp b/examples/common/entry/dialog.cpp
@@ -68,7 +68,7 @@ void openUrl(const bx::StringView& _url)
 #if BX_PLATFORM_WINDOWS
 	void* result = ShellExecuteA(NULL, NULL, tmp, NULL, NULL, false);
 	BX_UNUSED(result);
-#elif !BX_PLATFORM_IOS
+#elif !BX_PLATFORM_IOS && !BX_PLATFORM_VISIONOS
 	int32_t result = system(tmp);
 	BX_UNUSED(result);
 #endif // BX_PLATFORM_*

diff --git a/examples/common/entry/entry_sdl.cpp b/examples/common/entry/entry_sdl.cpp
@@ -68,7 +68,7 @@ namespace entry
 			else
 #		endif // ENTRY_CONFIG_USE_WAYLAND
 				return (void*)wmi.info.x11.window;
-#	elif BX_PLATFORM_OSX || BX_PLATFORM_IOS
+#	elif BX_PLATFORM_OSX || BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 		return wmi.info.cocoa.window;
 #	elif BX_PLATFORM_WINDOWS
 		return wmi.info.win.window;

diff --git a/include/bgfx/embedded_shader.h b/include/bgfx/embedded_shader.h
@@ -34,6 +34,7 @@
 	|| BX_PLATFORM_LINUX                \
 	|| BX_PLATFORM_OSX                  \
 	|| BX_PLATFORM_RPI                  \
+	|| BX_PLATFORM_VISIONOS             \
 	|| BX_PLATFORM_WINDOWS              \
 	)
 #define BGFX_PLATFORM_SUPPORTS_GLSL (0  \
@@ -44,6 +45,7 @@
 #define BGFX_PLATFORM_SUPPORTS_METAL (0 \
 	|| BX_PLATFORM_IOS                  \
 	|| BX_PLATFORM_OSX                  \
+	|| BX_PLATFORM_VISIONOS             \
 	)
 #define BGFX_PLATFORM_SUPPORTS_NVN (0   \
 	|| BX_PLATFORM_NX                   \

diff --git a/src/bgfx.cpp b/src/bgfx.cpp
@@ -12,7 +12,7 @@
 
 #include "topology.h"
 
-#if BX_PLATFORM_OSX || BX_PLATFORM_IOS
+#if BX_PLATFORM_OSX || BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 #	include <objc/message.h>
 #elif BX_PLATFORM_WINDOWS
 #	ifndef WIN32_LEAN_AND_MEAN
@@ -2413,7 +2413,7 @@ namespace bgfx
 		}
 	}
 
-#if BX_PLATFORM_OSX || BX_PLATFORM_IOS
+#if BX_PLATFORM_OSX || BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 	struct NSAutoreleasePoolScope
 	{
 		NSAutoreleasePoolScope()
@@ -2437,7 +2437,7 @@ namespace bgfx
 	{
 		BGFX_PROFILER_SCOPE("bgfx::renderFrame", 0xff2040ff);
 
-#if BX_PLATFORM_OSX || BX_PLATFORM_IOS
+#if BX_PLATFORM_OSX || BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 		NSAutoreleasePoolScope pool;
 #endif // BX_PLATFORM_OSX
 
@@ -2635,11 +2635,11 @@ namespace bgfx
 		{ d3d11::rendererCreate,  d3d11::rendererDestroy,  BGFX_RENDERER_DIRECT3D11_NAME, !!BGFX_CONFIG_RENDERER_DIRECT3D11 }, // Direct3D11
 		{ d3d12::rendererCreate,  d3d12::rendererDestroy,  BGFX_RENDERER_DIRECT3D12_NAME, !!BGFX_CONFIG_RENDERER_DIRECT3D12 }, // Direct3D12
 		{ gnm::rendererCreate,    gnm::rendererDestroy,    BGFX_RENDERER_GNM_NAME,        !!BGFX_CONFIG_RENDERER_GNM        }, // GNM
-#if BX_PLATFORM_OSX || BX_PLATFORM_IOS
+#if BX_PLATFORM_OSX || BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 		{ mtl::rendererCreate,    mtl::rendererDestroy,    BGFX_RENDERER_METAL_NAME,      !!BGFX_CONFIG_RENDERER_METAL      }, // Metal
 #else
 		{ noop::rendererCreate,   noop::rendererDestroy,   BGFX_RENDERER_NOOP_NAME,       false                             }, // Noop
-#endif // BX_PLATFORM_OSX || BX_PLATFORM_IOS
+#endif // BX_PLATFORM_OSX || BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 		{ nvn::rendererCreate,    nvn::rendererDestroy,    BGFX_RENDERER_NVN_NAME,        !!BGFX_CONFIG_RENDERER_NVN        }, // NVN
 		{ gl::rendererCreate,     gl::rendererDestroy,     BGFX_RENDERER_OPENGL_NAME,     !!BGFX_CONFIG_RENDERER_OPENGLES   }, // OpenGLES
 		{ gl::rendererCreate,     gl::rendererDestroy,     BGFX_RENDERER_OPENGL_NAME,     !!BGFX_CONFIG_RENDERER_OPENGL     }, // OpenGL
@@ -2737,7 +2737,7 @@ namespace bgfx
 					score += RendererType::Metal    == renderer ? 20 : 0;
 					score += RendererType::Vulkan   == renderer ? 10 : 0;
 				}
-				else if (BX_ENABLED(BX_PLATFORM_IOS) )
+				else if (BX_ENABLED(BX_PLATFORM_IOS) || BX_ENABLED(BX_PLATFORM_VISIONOS))
 				{
 					score += RendererType::Metal    == renderer ? 20 : 0;
 				}

diff --git a/src/config.h b/src/config.h
@@ -63,6 +63,7 @@
 #		define BGFX_CONFIG_RENDERER_METAL (0 \
 					|| BX_PLATFORM_IOS       \
 					|| BX_PLATFORM_OSX       \
+					|| BX_PLATFORM_VISIONOS \
 					? 1 : 0)
 #	endif // BGFX_CONFIG_RENDERER_METAL
 

diff --git a/src/renderer_mtl.h b/src/renderer_mtl.h
@@ -14,10 +14,14 @@
 #import <Metal/Metal.h>
 #import <MetalKit/MetalKit.h>
 
-#if BX_PLATFORM_IOS
+#if BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 #	import <UIKit/UIKit.h>
 #endif // BX_PLATFORM_*
 
+#if BX_PLATFORM_VISIONOS
+#import <CompositorServices/CompositorServices.h>
+#endif
+
 #define BGFX_MTL_PROFILER_BEGIN(_view, _abgr)         \
 	BX_MACRO_BLOCK_BEGIN                              \
 		BGFX_PROFILER_BEGIN(s_viewName[view], _abgr); \
@@ -38,7 +42,7 @@ namespace bgfx { namespace mtl
 	//runtime os check
 	inline bool iOSVersionEqualOrGreater(const char* _version)
 	{
-#if BX_PLATFORM_IOS
+#if BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 		return ([[[UIDevice currentDevice] systemVersion] compare:@(_version) options:NSNumericSearch] != NSOrderedAscending);
 #else
 		BX_UNUSED(_version);
@@ -386,19 +390,19 @@ namespace bgfx { namespace mtl
 
 		bool supportsTextureSampleCount(int sampleCount)
 		{
-			if (BX_ENABLED(BX_PLATFORM_IOS) && !iOSVersionEqualOrGreater("9.0.0") )
+			if (BX_ENABLED(BX_PLATFORM_VISIONOS) || (BX_ENABLED(BX_PLATFORM_IOS) && !iOSVersionEqualOrGreater("9.0.0")) )
 				return sampleCount == 1 || sampleCount == 2 ||  sampleCount == 4;
 			else
 				return [m_obj supportsTextureSampleCount:sampleCount];
 		}
 
 		bool depth24Stencil8PixelFormatSupported()
 		{
-#if BX_PLATFORM_IOS
+#if BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 			return false;
 #else
 			return m_obj.depth24Stencil8PixelFormatSupported;
-#endif // BX_PLATFORM_IOS
+#endif // BX_PLATFORM_IOS || BX_PLATFORM_VISIONOS
 		}
 	MTL_CLASS_END
 
@@ -1032,7 +1036,12 @@ namespace bgfx { namespace mtl
 	struct SwapChainMtl
 	{
 		SwapChainMtl()
+#if BX_PLATFORM_VISIONOS
+            : m_layerRenderer(NULL)
+            , m_frame(NULL)
+#else
 			: m_metalLayer(nil)
+#endif
 			, m_drawable(nil)
 			, m_drawableTexture(nil)
 			, m_backBufferColorMsaa()
@@ -1049,8 +1058,15 @@ namespace bgfx { namespace mtl
 
 		id <MTLTexture> 	currentDrawableTexture();
 
+
+#if BX_PLATFORM_VISIONOS
+        cp_layer_renderer_t m_layerRenderer;
+        cp_frame_t m_frame;
+        cp_drawable_t m_drawable;
+#else
 		CAMetalLayer* m_metalLayer;
-		id <CAMetalDrawable> m_drawable;
+        id <CAMetalDrawable> m_drawable;
+#endif
 		id <MTLTexture> 	 m_drawableTexture;
 		Texture m_backBufferColorMsaa;
 		Texture m_backBufferDepth;