14# pragma clang diagnostic ignored "-Wdeprecated-declarations"
19#import <Cocoa/Cocoa.h>
20#import <Metal/Metal.h>
21#import <QuartzCore/QuartzCore.h>
32 NSString *message = [NSString stringWithFormat:
@"Error opening window:\n%s", msg];
34 NSAlert *alert = [[NSAlert alloc]
init];
36 alert.messageText =
@"Blender";
37 alert.informativeText = message;
38 alert.alertStyle = NSAlertStyleCritical;
40 [alert addButtonWithTitle:
@"Quit"];
47MTLCommandQueue *GHOST_ContextMTL::s_sharedMetalCommandQueue = nil;
48int GHOST_ContextMTL::s_sharedCount = 0;
52 CAMetalLayer *metalLayer)
54 metal_view_(metalView),
55 metal_layer_(metalLayer),
56 metal_render_pipeline_(nil)
60 current_swapchain_index = 0;
61 for (
int i = 0; i < METAL_SWAPCHAIN_SIZE; i++) {
62 default_framebuffer_metal_texture_[i].texture = nil;
63 default_framebuffer_metal_texture_[i].index = i;
67 owns_metal_device_ =
false;
72 id<MTLDevice>
metalDevice = MTLCreateSystemDefaultDevice();
78 owns_metal_device_ =
true;
80 metal_layer_ = [[CAMetalLayer alloc]
init];
81 metal_layer_.edgeAntialiasingMask = 0;
82 metal_layer_.masksToBounds = NO;
83 metal_layer_.opaque = YES;
84 metal_layer_.framebufferOnly = YES;
85 metal_layer_.presentsWithTransaction = NO;
86 [metal_layer_ removeAllAnimations];
88 metal_layer_.allowsNextDrawableTimeout = NO;
103 metal_layer_.wantsExtendedDynamicRangeContent = YES;
105 const CFStringRef name = kCGColorSpaceExtendedSRGB;
106 CGColorSpaceRef
colorspace = CGColorSpaceCreateWithName(name);
114 "[ERROR] Failed to create Metal device for offscreen GHOST Context.\n");
119 mtl_SwapInterval = 60;
126 static std::mutex mutex;
127 std::scoped_lock
lock(mutex);
131 if (owns_metal_device_) {
133 [metal_layer_ release];
140 [s_sharedMetalCommandQueue release];
141 if (s_sharedCount == 0) {
142 s_sharedMetalCommandQueue = nil;
156 mtl_SwapInterval = interval;
162 interval_out = mtl_SwapInterval;
187 metalUpdateFramebuffer();
196 current_swapchain_index = (current_swapchain_index + 1) % METAL_SWAPCHAIN_SIZE;
202 return default_framebuffer_metal_texture_[current_swapchain_index].texture;
207 return s_sharedMetalCommandQueue;
211 id<MTLDevice> device = metal_layer_.device;
212 return (MTLDevice *)device;
216 MTLRenderPassDescriptor *, id<MTLRenderPipelineState>, id<MTLTexture>, id<CAMetalDrawable>))
218 this->contextPresentCallback = callback;
222 void (*callback)(id<MTLTexture>,
int,
int,
int,
int))
224 this->xrBlitCallback = callback;
231 metalInitFramebuffer();
245void GHOST_ContextMTL::metalInit()
248 id<MTLDevice> device = metal_layer_.device;
253 if (s_sharedMetalCommandQueue == nil) {
254 s_sharedMetalCommandQueue = (MTLCommandQueue *)[device
258 [s_sharedMetalCommandQueue retain];
262 NSString *source = @R
"msl(
263 using namespace metal;
266 float4 position [[position]];
267 float2 texCoord [[attribute(0)]];
270 vertex Vertex vertex_shader(uint v_id [[vertex_id]]) {
273 vtx.position.x = float(v_id & 1) * 4.0 - 1.0;
274 vtx.position.y = float(v_id >> 1) * 4.0 - 1.0;
275 vtx.position.z = 0.0;
276 vtx.position.w = 1.0;
278 vtx.texCoord = vtx.position.xy * 0.5 + 0.5;
283 constexpr sampler s {};
285 fragment float4 fragment_shader(Vertex v [[stage_in]],
286 texture2d<float> t [[texture(0)]]) {
288 /* Final blit should ensure alpha is 1.0. This resolves
289 * rendering artifacts for blitting of final back-buffer.
290 * Also clamp the RGB values to avoid artifacts. */
291 float4 out_tex = t.sample(s, v.texCoord);
292 out_tex.rgb = min(out_tex.rgb, 16384.0);
298 MTLCompileOptions *options = [[[MTLCompileOptions alloc] init] autorelease];
299 options.languageVersion = MTLLanguageVersion1_1;
301 NSError *error = nil;
302 id<MTLLibrary> library = [device newLibraryWithSource:source options:options error:&error];
305 "GHOST_ContextMTL::metalInit: newLibraryWithSource:options:error: failed!");
309 MTLRenderPipelineDescriptor *desc = [[[MTLRenderPipelineDescriptor alloc]
init] autorelease];
311 desc.fragmentFunction = [library newFunctionWithName:
@"fragment_shader"];
312 desc.vertexFunction = [library newFunctionWithName:
@"vertex_shader"];
313 [desc.colorAttachments objectAtIndexedSubscript:0].pixelFormat =
317 [library autorelease];
319 metal_render_pipeline_ = (MTLRenderPipelineState *)[device
320 newRenderPipelineStateWithDescriptor:desc
324 "GHOST_ContextMTL::metalInit: newRenderPipelineStateWithDescriptor:error: failed!");
327 [desc.fragmentFunction release];
328 [desc.vertexFunction release];
332void GHOST_ContextMTL::metalFree()
334 if (metal_render_pipeline_) {
335 [metal_render_pipeline_ release];
336 metal_render_pipeline_ = nil;
339 for (
int i = 0; i < METAL_SWAPCHAIN_SIZE; i++) {
340 if (default_framebuffer_metal_texture_[i].
texture) {
341 [default_framebuffer_metal_texture_[i].texture release];
342 default_framebuffer_metal_texture_[i].texture = nil;
347void GHOST_ContextMTL::metalInitFramebuffer()
352void GHOST_ContextMTL::metalUpdateFramebuffer()
355 const NSSize drawableSize = metal_layer_.drawableSize;
356 const size_t width = size_t(drawableSize.width);
357 const size_t height = size_t(drawableSize.height);
359 if (default_framebuffer_metal_texture_[current_swapchain_index].
texture &&
360 default_framebuffer_metal_texture_[current_swapchain_index].
texture.width == width &&
361 default_framebuffer_metal_texture_[current_swapchain_index].texture.height == height)
367 [default_framebuffer_metal_texture_[current_swapchain_index].texture release];
369 id<MTLDevice> device = metal_layer_.device;
370 MTLTextureDescriptor *overlayDesc = [MTLTextureDescriptor
375 overlayDesc.storageMode = MTLStorageModePrivate;
376 overlayDesc.usage = MTLTextureUsageRenderTarget | MTLTextureUsageShaderRead;
378 id<MTLTexture> overlayTex = [device newTextureWithDescriptor:overlayDesc];
381 "GHOST_ContextMTL::metalUpdateFramebuffer: failed to create Metal overlay texture!");
384 overlayTex.label = [NSString
385 stringWithFormat:
@"Metal Overlay for GHOST Context %p",
this];
388 default_framebuffer_metal_texture_[current_swapchain_index].texture = overlayTex;
391 id<MTLCommandBuffer> cmdBuffer = [s_sharedMetalCommandQueue commandBuffer];
392 MTLRenderPassDescriptor *passDescriptor = [MTLRenderPassDescriptor renderPassDescriptor];
394 auto attachment = [passDescriptor.colorAttachments objectAtIndexedSubscript:0];
395 attachment.texture = default_framebuffer_metal_texture_[current_swapchain_index].texture;
396 attachment.loadAction = MTLLoadActionClear;
397 attachment.clearColor = MTLClearColorMake(0.294, 0.294, 0.294, 1.000);
398 attachment.storeAction = MTLStoreActionStore;
401 id<MTLRenderCommandEncoder> enc = [cmdBuffer
402 renderCommandEncoderWithDescriptor:passDescriptor];
407 metal_layer_.drawableSize = CGSizeMake(CGFloat(width), CGFloat(height));
411void GHOST_ContextMTL::metalSwapBuffers()
416 id<CAMetalDrawable> drawable = [metal_layer_ nextDrawable];
421 MTLRenderPassDescriptor *passDescriptor = [MTLRenderPassDescriptor renderPassDescriptor];
423 auto attachment = [passDescriptor.colorAttachments objectAtIndexedSubscript:0];
424 attachment.texture = drawable.texture;
425 attachment.loadAction = MTLLoadActionClear;
426 attachment.clearColor = MTLClearColorMake(1.0, 0.294, 0.294, 1.000);
427 attachment.storeAction = MTLStoreActionStore;
430 assert(contextPresentCallback);
431 assert(default_framebuffer_metal_texture_[current_swapchain_index].
texture != nil);
432 (*contextPresentCallback)(passDescriptor,
433 (id<MTLRenderPipelineState>)metal_render_pipeline_,
434 default_framebuffer_metal_texture_[current_swapchain_index].texture,
static const MTLPixelFormat METAL_FRAMEBUFFERPIXEL_FORMAT_EDR
static void ghost_fatal_error_dialog(const char *msg)
GHOST_TSuccess releaseDrawingContext() override
static const int max_command_buffer_count
void metalRegisterXrBlitCallback(void(*callback)(id< MTLTexture >, int, int, int, int))
MTLCommandQueue * metalCommandQueue()
MTLDevice * metalDevice()
GHOST_TSuccess activateDrawingContext() override
void metalRegisterPresentCallback(void(*callback)(MTLRenderPassDescriptor *, id< MTLRenderPipelineState >, id< MTLTexture >, id< CAMetalDrawable >))
GHOST_TSuccess setSwapInterval(int interval) override
GHOST_ContextMTL(const GHOST_ContextParams &context_params, NSView *metalView, CAMetalLayer *metalLayer)
GHOST_TSuccess swapBufferRelease() override
GHOST_TSuccess updateDrawingContext() override
GHOST_TSuccess initializeDrawingContext() override
GHOST_TSuccess releaseNativeHandles() override
id< MTLTexture > metalOverlayTexture()
~GHOST_ContextMTL() override
unsigned int getDefaultFramebuffer() override
GHOST_TSuccess getSwapInterval(int &interval_out) override
GHOST_Context(const GHOST_ContextParams &context_params)
static GHOST_Context * active_context_
virtual GHOST_TVSyncModes getVSync()
GHOST_ContextParams context_params_
CCL_NAMESPACE_BEGIN struct Options options
#define assert(assertion)
TEX_TEMPLATE DataVec texture(T, FltCoord, float=0.0f) RET