-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathqrhimetal.mm
6434 lines (5623 loc) · 248 KB
/
qrhimetal.mm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qrhimetal_p.h"
#include "qshader_p.h"
#include <QGuiApplication>
#include <QWindow>
#include <QUrl>
#include <QFile>
#include <QTemporaryFile>
#include <QFileInfo>
#include <qmath.h>
#include <QOperatingSystemVersion>
#include <QtCore/private/qcore_mac_p.h>
#ifdef Q_OS_MACOS
#include <AppKit/AppKit.h>
#else
#include <UIKit/UIKit.h>
#endif
#include <Metal/Metal.h>
#include <QuartzCore/CAMetalLayer.h>
QT_BEGIN_NAMESPACE
/*
Metal backend. Double buffers and throttles to vsync. "Dynamic" buffers are
Shared (host visible) and duplicated (to help having 2 frames in flight),
"static" and "immutable" are Managed on macOS and Shared on iOS/tvOS.
Textures are Private (device local) and a host visible staging buffer is
used to upload data to them. Does not rely on strong objects refs from
command buffers but does rely on the automatic resource tracking of the
command encoders. Assumes that an autorelease pool (ideally per frame) is
available on the thread on which QRhi is used.
*/
#if __has_feature(objc_arc)
#error ARC not supported
#endif
// Note: we expect everything here pass the Metal API validation when running
// in Debug mode in XCode (or with METAL_DEVICE_WRAPPER_TYPE=1). An exception
// is the nextDrawable Called Early blah blah warning, which is plain and
// simply false. This may not be present with newer XCode. There may also be
// warnings about threading (e.g. about accessing view.layer), those are
// expected for now.
/*!
\class QRhiMetalInitParams
\inmodule QtRhi
\since 6.6
\brief Metal specific initialization parameters.
\note This is a RHI API with limited compatibility guarantees, see \l QRhi
for details.
A Metal-based QRhi needs no special parameters for initialization.
\badcode
QRhiMetalInitParams params;
rhi = QRhi::create(QRhi::Metal, ¶ms);
\endcode
\note Metal API validation cannot be enabled programmatically by the QRhi.
Instead, either run the debug build of the application in XCode, by
generating a \c{.xcodeproj} file via \c{cmake -G Xcode}, or set the
environment variable \c{METAL_DEVICE_WRAPPER_TYPE=1}. The variable needs to
be set early on in the environment, perferably before starting the process;
attempting to set it at QRhi creation time is not functional in practice.
(too late probably)
\note QRhiSwapChain can only target QWindow instances that have their
surface type set to QSurface::MetalSurface.
\section2 Working with existing Metal devices
When interoperating with another graphics engine, it may be necessary to
get a QRhi instance that uses the same Metal device. This can be achieved
by passing a pointer to a QRhiMetalNativeHandles to QRhi::create(). The
device must be set to a non-null value then. Optionally, a command queue
object can be specified as well.
The QRhi does not take ownership of any of the external objects.
*/
/*!
\class QRhiMetalNativeHandles
\inmodule QtRhi
\since 6.6
\brief Holds the Metal device used by the QRhi.
\note This is a RHI API with limited compatibility guarantees, see \l QRhi
for details.
*/
/*!
\variable QRhiMetalNativeHandles::dev
*/
/*!
\variable QRhiMetalNativeHandles::cmdQueue
*/
/*!
\class QRhiMetalCommandBufferNativeHandles
\inmodule QtRhi
\since 6.6
\brief Holds the MTLCommandBuffer and MTLRenderCommandEncoder objects that are backing a QRhiCommandBuffer.
\note The command buffer object is only guaranteed to be valid while
recording a frame, that is, between a \l{QRhi::beginFrame()}{beginFrame()}
- \l{QRhi::endFrame()}{endFrame()} or
\l{QRhi::beginOffscreenFrame()}{beginOffscreenFrame()} -
\l{QRhi::endOffscreenFrame()}{endOffsrceenFrame()} pair.
\note The command encoder is only valid while recording a pass, that is,
between \l{QRhiCommandBuffer::beginPass()} -
\l{QRhiCommandBuffer::endPass()}.
\note This is a RHI API with limited compatibility guarantees, see \l QRhi
for details.
*/
/*!
\variable QRhiMetalCommandBufferNativeHandles::commandBuffer
*/
/*!
\variable QRhiMetalCommandBufferNativeHandles::encoder
*/
struct QMetalShader
{
id<MTLLibrary> lib = nil;
id<MTLFunction> func = nil;
std::array<uint, 3> localSize = {};
uint outputVertexCount = 0;
QShaderDescription desc;
QShader::NativeResourceBindingMap nativeResourceBindingMap;
QShader::NativeShaderInfo nativeShaderInfo;
void destroy() {
nativeResourceBindingMap.clear();
[lib release];
lib = nil;
[func release];
func = nil;
}
};
struct QRhiMetalData
{
QRhiMetalData(QRhiMetal *rhi) : q(rhi), ofr(rhi) { }
QRhiMetal *q;
id<MTLDevice> dev = nil;
id<MTLCommandQueue> cmdQueue = nil;
API_AVAILABLE(macosx(11.0), ios(14.0)) id<MTLBinaryArchive> binArch = nil;
bool binArchWasEmpty = false;
MTLRenderPassDescriptor *createDefaultRenderPass(bool hasDepthStencil,
const QColor &colorClearValue,
const QRhiDepthStencilClearValue &depthStencilClearValue,
int colorAttCount);
id<MTLLibrary> createMetalLib(const QShader &shader, QShader::Variant shaderVariant,
QString *error, QByteArray *entryPoint, QShaderKey *activeKey);
id<MTLFunction> createMSLShaderFunction(id<MTLLibrary> lib, const QByteArray &entryPoint);
bool setupBinaryArchive(NSURL *sourceFileUrl = nil);
void addRenderPipelineToBinaryArchive(MTLRenderPipelineDescriptor *rpDesc);
void trySeedingRenderPipelineFromBinaryArchive(MTLRenderPipelineDescriptor *rpDesc);
void addComputePipelineToBinaryArchive(MTLComputePipelineDescriptor *cpDesc);
void trySeedingComputePipelineFromBinaryArchive(MTLComputePipelineDescriptor *cpDesc);
struct DeferredReleaseEntry {
enum Type {
Buffer,
RenderBuffer,
Texture,
Sampler,
StagingBuffer,
GraphicsPipeline,
ComputePipeline
};
Type type;
int lastActiveFrameSlot; // -1 if not used otherwise 0..FRAMES_IN_FLIGHT-1
union {
struct {
id<MTLBuffer> buffers[QMTL_FRAMES_IN_FLIGHT];
} buffer;
struct {
id<MTLTexture> texture;
} renderbuffer;
struct {
id<MTLTexture> texture;
id<MTLBuffer> stagingBuffers[QMTL_FRAMES_IN_FLIGHT];
id<MTLTexture> views[QRhi::MAX_MIP_LEVELS];
} texture;
struct {
id<MTLSamplerState> samplerState;
} sampler;
struct {
id<MTLBuffer> buffer;
} stagingBuffer;
struct {
id<MTLRenderPipelineState> pipelineState;
id<MTLDepthStencilState> depthStencilState;
std::array<id<MTLComputePipelineState>, 3> tessVertexComputeState;
id<MTLComputePipelineState> tessTessControlComputeState;
} graphicsPipeline;
struct {
id<MTLComputePipelineState> pipelineState;
} computePipeline;
};
};
QVector<DeferredReleaseEntry> releaseQueue;
struct OffscreenFrame {
OffscreenFrame(QRhiImplementation *rhi) : cbWrapper(rhi) { }
bool active = false;
double lastGpuTime = 0;
QMetalCommandBuffer cbWrapper;
} ofr;
struct TextureReadback {
int activeFrameSlot = -1;
QRhiReadbackDescription desc;
QRhiReadbackResult *result;
id<MTLBuffer> buf;
quint32 bufSize;
QSize pixelSize;
QRhiTexture::Format format;
};
QVarLengthArray<TextureReadback, 2> activeTextureReadbacks;
struct BufferReadback
{
int activeFrameSlot = -1;
QRhiReadbackResult *result;
quint32 offset;
quint32 readSize;
id<MTLBuffer> buf;
};
QVarLengthArray<BufferReadback, 2> activeBufferReadbacks;
MTLCaptureManager *captureMgr;
id<MTLCaptureScope> captureScope = nil;
static const int TEXBUF_ALIGN = 256; // probably not accurate
QHash<QRhiShaderStage, QMetalShader> shaderCache;
};
Q_DECLARE_TYPEINFO(QRhiMetalData::DeferredReleaseEntry, Q_RELOCATABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiMetalData::TextureReadback, Q_RELOCATABLE_TYPE);
struct QMetalBufferData
{
bool managed;
bool slotted;
id<MTLBuffer> buf[QMTL_FRAMES_IN_FLIGHT];
struct BufferUpdate {
quint32 offset;
QRhiBufferData data;
};
QVarLengthArray<BufferUpdate, 16> pendingUpdates[QMTL_FRAMES_IN_FLIGHT];
};
struct QMetalRenderBufferData
{
MTLPixelFormat format;
id<MTLTexture> tex = nil;
};
struct QMetalTextureData
{
QMetalTextureData(QMetalTexture *t) : q(t) { }
QMetalTexture *q;
MTLPixelFormat format;
id<MTLTexture> tex = nil;
id<MTLBuffer> stagingBuf[QMTL_FRAMES_IN_FLIGHT];
bool owns = true;
id<MTLTexture> perLevelViews[QRhi::MAX_MIP_LEVELS];
id<MTLTexture> viewForLevel(int level);
};
struct QMetalSamplerData
{
id<MTLSamplerState> samplerState = nil;
};
struct QMetalShaderResourceBindingsData {
struct Stage {
struct Buffer {
int nativeBinding;
id<MTLBuffer> mtlbuf;
quint32 offset;
};
struct Texture {
int nativeBinding;
id<MTLTexture> mtltex;
};
struct Sampler {
int nativeBinding;
id<MTLSamplerState> mtlsampler;
};
QVarLengthArray<Buffer, 8> buffers;
QVarLengthArray<Texture, 8> textures;
QVarLengthArray<Sampler, 8> samplers;
QRhiBatchedBindings<id<MTLBuffer> > bufferBatches;
QRhiBatchedBindings<NSUInteger> bufferOffsetBatches;
QRhiBatchedBindings<id<MTLTexture> > textureBatches;
QRhiBatchedBindings<id<MTLSamplerState> > samplerBatches;
} res[QRhiMetal::SUPPORTED_STAGES];
enum { VERTEX = 0, FRAGMENT = 1, COMPUTE = 2, TESSCTRL = 3, TESSEVAL = 4 };
};
struct QMetalCommandBufferData
{
id<MTLCommandBuffer> cb;
double lastGpuTime = 0;
id<MTLRenderCommandEncoder> currentRenderPassEncoder;
id<MTLComputeCommandEncoder> currentComputePassEncoder;
id<MTLComputeCommandEncoder> tessellationComputeEncoder;
MTLRenderPassDescriptor *currentPassRpDesc;
int currentFirstVertexBinding;
QRhiBatchedBindings<id<MTLBuffer> > currentVertexInputsBuffers;
QRhiBatchedBindings<NSUInteger> currentVertexInputOffsets;
id<MTLDepthStencilState> currentDepthStencilState;
QMetalShaderResourceBindingsData currentShaderResourceBindingState;
};
struct QMetalRenderTargetData
{
QSize pixelSize;
float dpr = 1;
int sampleCount = 1;
int colorAttCount = 0;
int dsAttCount = 0;
struct ColorAtt {
bool needsDrawableForTex = false;
id<MTLTexture> tex = nil;
int arrayLayer = 0;
int slice = 0;
int level = 0;
bool needsDrawableForResolveTex = false;
id<MTLTexture> resolveTex = nil;
int resolveLayer = 0;
int resolveLevel = 0;
};
struct {
ColorAtt colorAtt[QMetalRenderPassDescriptor::MAX_COLOR_ATTACHMENTS];
id<MTLTexture> dsTex = nil;
bool hasStencil = false;
bool depthNeedsStore = false;
} fb;
QRhiRenderTargetAttachmentTracker::ResIdList currentResIdList;
};
struct QMetalGraphicsPipelineData
{
QMetalGraphicsPipeline *q = nullptr;
id<MTLRenderPipelineState> ps = nil;
id<MTLDepthStencilState> ds = nil;
MTLPrimitiveType primitiveType;
MTLWinding winding;
MTLCullMode cullMode;
MTLTriangleFillMode triangleFillMode;
float depthBias;
float slopeScaledDepthBias;
QMetalShader vs;
QMetalShader fs;
struct ExtraBufferManager {
enum class WorkBufType {
DeviceLocal,
HostVisible
};
QMetalBuffer *acquireWorkBuffer(QRhiMetal *rhiD, quint32 size, WorkBufType type = WorkBufType::DeviceLocal);
QVector<QMetalBuffer *> deviceLocalWorkBuffers;
QVector<QMetalBuffer *> hostVisibleWorkBuffers;
} extraBufMgr;
struct Tessellation {
QMetalGraphicsPipelineData *q = nullptr;
bool enabled = false;
bool failed = false;
uint inControlPointCount;
uint outControlPointCount;
QMetalShader compVs[3];
std::array<id<MTLComputePipelineState>, 3> vertexComputeState = {};
id<MTLComputePipelineState> tessControlComputeState = nil;
QMetalShader compTesc;
QMetalShader vertTese;
quint32 vsCompOutputBufferSize(quint32 vertexOrIndexCount, quint32 instanceCount) const
{
// max vertex output components = resourceLimit(MaxVertexOutputs) * 4 = 60
return vertexOrIndexCount * instanceCount * sizeof(float) * 60;
}
quint32 tescCompOutputBufferSize(quint32 patchCount) const
{
return outControlPointCount * patchCount * sizeof(float) * 60;
}
quint32 tescCompPatchOutputBufferSize(quint32 patchCount) const
{
// assume maxTessellationControlPerPatchOutputComponents is 128
return patchCount * sizeof(float) * 128;
}
quint32 patchCountForDrawCall(quint32 vertexOrIndexCount, quint32 instanceCount) const
{
return ((vertexOrIndexCount + inControlPointCount - 1) / inControlPointCount) * instanceCount;
}
static int vsCompVariantToIndex(QShader::Variant vertexCompVariant);
id<MTLComputePipelineState> vsCompPipeline(QRhiMetal *rhiD, QShader::Variant vertexCompVariant);
id<MTLComputePipelineState> tescCompPipeline(QRhiMetal *rhiD);
id<MTLRenderPipelineState> teseFragRenderPipeline(QRhiMetal *rhiD, QMetalGraphicsPipeline *pipeline);
} tess;
void setupVertexInputDescriptor(MTLVertexDescriptor *desc);
void setupStageInputDescriptor(MTLStageInputOutputDescriptor *desc);
// SPIRV-Cross buffer size buffers
QMetalBuffer *bufferSizeBuffer = nullptr;
};
struct QMetalComputePipelineData
{
id<MTLComputePipelineState> ps = nil;
QMetalShader cs;
MTLSize localSize;
// SPIRV-Cross buffer size buffers
QMetalBuffer *bufferSizeBuffer = nullptr;
};
struct QMetalSwapChainData
{
CAMetalLayer *layer = nullptr;
id<CAMetalDrawable> curDrawable = nil;
dispatch_semaphore_t sem[QMTL_FRAMES_IN_FLIGHT];
double lastGpuTime[QMTL_FRAMES_IN_FLIGHT];
MTLRenderPassDescriptor *rp = nullptr;
id<MTLTexture> msaaTex[QMTL_FRAMES_IN_FLIGHT];
QRhiTexture::Format rhiColorFormat;
MTLPixelFormat colorFormat;
#ifdef Q_OS_MACOS
bool liveResizeObserverSet = false;
QMacNotificationObserver liveResizeStartObserver;
QMacNotificationObserver liveResizeEndObserver;
#endif
};
QRhiMetal::QRhiMetal(QRhiMetalInitParams *params, QRhiMetalNativeHandles *importDevice)
{
Q_UNUSED(params);
d = new QRhiMetalData(this);
importedDevice = importDevice != nullptr;
if (importedDevice) {
if (d->dev) {
d->dev = (id<MTLDevice>) importDevice->dev;
importedCmdQueue = importDevice->cmdQueue != nullptr;
if (importedCmdQueue)
d->cmdQueue = (id<MTLCommandQueue>) importDevice->cmdQueue;
} else {
qWarning("No MTLDevice given, cannot import");
importedDevice = false;
}
}
}
QRhiMetal::~QRhiMetal()
{
delete d;
}
template <class Int>
inline Int aligned(Int v, Int byteAlign)
{
return (v + byteAlign - 1) & ~(byteAlign - 1);
}
bool QRhiMetal::probe(QRhiMetalInitParams *params)
{
Q_UNUSED(params);
id<MTLDevice> dev = MTLCreateSystemDefaultDevice();
if (dev) {
[dev release];
return true;
}
return false;
}
bool QRhiMetalData::setupBinaryArchive(NSURL *sourceFileUrl)
{
if (@available(macOS 11.0, iOS 14.0, *)) {
[binArch release];
MTLBinaryArchiveDescriptor *binArchDesc = [MTLBinaryArchiveDescriptor new];
binArchDesc.url = sourceFileUrl;
NSError *err = nil;
binArch = [dev newBinaryArchiveWithDescriptor: binArchDesc error: &err];
[binArchDesc release];
if (!binArch) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("newBinaryArchiveWithDescriptor failed: %s", qPrintable(msg));
return false;
}
binArchWasEmpty = sourceFileUrl == nil;
return true;
}
return false;
}
bool QRhiMetal::create(QRhi::Flags flags)
{
rhiFlags = flags;
if (importedDevice)
[d->dev retain];
else
d->dev = MTLCreateSystemDefaultDevice();
if (!d->dev) {
qWarning("No MTLDevice");
return false;
}
const QString deviceName = QString::fromNSString([d->dev name]);
qCDebug(QRHI_LOG_INFO, "Metal device: %s", qPrintable(deviceName));
driverInfoStruct.deviceName = deviceName.toUtf8();
// deviceId and vendorId stay unset for now. Note that registryID is not
// suitable as deviceId because it does not seem stable on macOS and can
// apparently change when the system is rebooted.
#ifdef Q_OS_IOS
driverInfoStruct.deviceType = QRhiDriverInfo::IntegratedDevice;
#else
if (@available(macOS 10.15, *)) {
const MTLDeviceLocation deviceLocation = [d->dev location];
switch (deviceLocation) {
case MTLDeviceLocationBuiltIn:
driverInfoStruct.deviceType = QRhiDriverInfo::IntegratedDevice;
break;
case MTLDeviceLocationSlot:
driverInfoStruct.deviceType = QRhiDriverInfo::DiscreteDevice;
break;
case MTLDeviceLocationExternal:
driverInfoStruct.deviceType = QRhiDriverInfo::ExternalDevice;
break;
default:
break;
}
}
#endif
const QOperatingSystemVersion ver = QOperatingSystemVersion::current();
osMajor = ver.majorVersion();
osMinor = ver.minorVersion();
if (importedCmdQueue)
[d->cmdQueue retain];
else
d->cmdQueue = [d->dev newCommandQueue];
d->captureMgr = [MTLCaptureManager sharedCaptureManager];
// Have a custom capture scope as well which then shows up in XCode as
// an option when capturing, and becomes especially useful when having
// multiple windows with multiple QRhis.
d->captureScope = [d->captureMgr newCaptureScopeWithCommandQueue: d->cmdQueue];
const QString label = QString::asprintf("Qt capture scope for QRhi %p", this);
d->captureScope.label = label.toNSString();
#if defined(Q_OS_MACOS)
caps.maxTextureSize = 16384;
caps.baseVertexAndInstance = true;
if (@available(macOS 10.15, *))
caps.isAppleGPU = [d->dev supportsFamily:MTLGPUFamilyApple7];
caps.maxThreadGroupSize = 1024;
caps.multiView = true;
#elif defined(Q_OS_TVOS)
if ([d->dev supportsFeatureSet: MTLFeatureSet(30003)]) // MTLFeatureSet_tvOS_GPUFamily2_v1
caps.maxTextureSize = 16384;
else
caps.maxTextureSize = 8192;
caps.baseVertexAndInstance = false;
caps.isAppleGPU = true;
#elif defined(Q_OS_IOS)
// welcome to feature set hell
if ([d->dev supportsFeatureSet: MTLFeatureSet(16)] // MTLFeatureSet_iOS_GPUFamily5_v1
|| [d->dev supportsFeatureSet: MTLFeatureSet(11)] // MTLFeatureSet_iOS_GPUFamily4_v1
|| [d->dev supportsFeatureSet: MTLFeatureSet(4)]) // MTLFeatureSet_iOS_GPUFamily3_v1
{
caps.maxTextureSize = 16384;
caps.baseVertexAndInstance = true;
} else if ([d->dev supportsFeatureSet: MTLFeatureSet(3)] // MTLFeatureSet_iOS_GPUFamily2_v2
|| [d->dev supportsFeatureSet: MTLFeatureSet(2)]) // MTLFeatureSet_iOS_GPUFamily1_v2
{
caps.maxTextureSize = 8192;
caps.baseVertexAndInstance = false;
} else {
caps.maxTextureSize = 4096;
caps.baseVertexAndInstance = false;
}
caps.isAppleGPU = true;
if (@available(iOS 13, *)) {
if ([d->dev supportsFamily: MTLGPUFamilyApple4])
caps.maxThreadGroupSize = 1024;
if ([d->dev supportsFamily: MTLGPUFamilyApple5])
caps.multiView = true;
}
#endif
caps.supportedSampleCounts = { 1 };
for (int sampleCount : { 2, 4, 8 }) {
if ([d->dev supportsTextureSampleCount: sampleCount])
caps.supportedSampleCounts.append(sampleCount);
}
if (rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
d->setupBinaryArchive();
nativeHandlesStruct.dev = (MTLDevice *) d->dev;
nativeHandlesStruct.cmdQueue = (MTLCommandQueue *) d->cmdQueue;
return true;
}
void QRhiMetal::destroy()
{
executeDeferredReleases(true);
finishActiveReadbacks(true);
for (QMetalShader &s : d->shaderCache)
s.destroy();
d->shaderCache.clear();
[d->captureScope release];
d->captureScope = nil;
if (@available(macOS 11.0, iOS 14.0, *)) {
[d->binArch release];
d->binArch = nil;
}
[d->cmdQueue release];
if (!importedCmdQueue)
d->cmdQueue = nil;
[d->dev release];
if (!importedDevice)
d->dev = nil;
}
QVector<int> QRhiMetal::supportedSampleCounts() const
{
return caps.supportedSampleCounts;
}
int QRhiMetal::effectiveSampleCount(int sampleCount) const
{
// Stay compatible with QSurfaceFormat and friends where samples == 0 means the same as 1.
const int s = qBound(1, sampleCount, 64);
if (!supportedSampleCounts().contains(s)) {
qWarning("Attempted to set unsupported sample count %d", sampleCount);
return 1;
}
return s;
}
QRhiSwapChain *QRhiMetal::createSwapChain()
{
return new QMetalSwapChain(this);
}
QRhiBuffer *QRhiMetal::createBuffer(QRhiBuffer::Type type, QRhiBuffer::UsageFlags usage, quint32 size)
{
return new QMetalBuffer(this, type, usage, size);
}
int QRhiMetal::ubufAlignment() const
{
return 256;
}
bool QRhiMetal::isYUpInFramebuffer() const
{
return false;
}
bool QRhiMetal::isYUpInNDC() const
{
return true;
}
bool QRhiMetal::isClipDepthZeroToOne() const
{
return true;
}
QMatrix4x4 QRhiMetal::clipSpaceCorrMatrix() const
{
// depth range 0..1
static QMatrix4x4 m;
if (m.isIdentity()) {
// NB the ctor takes row-major
m = QMatrix4x4(1.0f, 0.0f, 0.0f, 0.0f,
0.0f, 1.0f, 0.0f, 0.0f,
0.0f, 0.0f, 0.5f, 0.5f,
0.0f, 0.0f, 0.0f, 1.0f);
}
return m;
}
bool QRhiMetal::isTextureFormatSupported(QRhiTexture::Format format, QRhiTexture::Flags flags) const
{
Q_UNUSED(flags);
bool supportsFamilyMac2 = false; // needed for BC* formats
bool supportsFamilyApple3 = false;
#ifdef Q_OS_MACOS
supportsFamilyMac2 = true;
if (caps.isAppleGPU)
supportsFamilyApple3 = true;
#else
supportsFamilyApple3 = true;
#endif
// BC5 is not available for any Apple hardare
if (format == QRhiTexture::BC5)
return false;
if (!supportsFamilyApple3) {
if (format >= QRhiTexture::ETC2_RGB8 && format <= QRhiTexture::ETC2_RGBA8)
return false;
if (format >= QRhiTexture::ASTC_4x4 && format <= QRhiTexture::ASTC_12x12)
return false;
}
if (!supportsFamilyMac2)
if (format >= QRhiTexture::BC1 && format <= QRhiTexture::BC7)
return false;
return true;
}
bool QRhiMetal::isFeatureSupported(QRhi::Feature feature) const
{
switch (feature) {
case QRhi::MultisampleTexture:
return true;
case QRhi::MultisampleRenderBuffer:
return true;
case QRhi::DebugMarkers:
return true;
case QRhi::Timestamps:
return true;
case QRhi::Instancing:
return true;
case QRhi::CustomInstanceStepRate:
return true;
case QRhi::PrimitiveRestart:
return true;
case QRhi::NonDynamicUniformBuffers:
return true;
case QRhi::NonFourAlignedEffectiveIndexBufferOffset:
return false;
case QRhi::NPOTTextureRepeat:
return true;
case QRhi::RedOrAlpha8IsRed:
return true;
case QRhi::ElementIndexUint:
return true;
case QRhi::Compute:
return true;
case QRhi::WideLines:
return false;
case QRhi::VertexShaderPointSize:
return true;
case QRhi::BaseVertex:
return caps.baseVertexAndInstance;
case QRhi::BaseInstance:
return caps.baseVertexAndInstance;
case QRhi::TriangleFanTopology:
return false;
case QRhi::ReadBackNonUniformBuffer:
return true;
case QRhi::ReadBackNonBaseMipLevel:
return true;
case QRhi::TexelFetch:
return true;
case QRhi::RenderToNonBaseMipLevel:
return true;
case QRhi::IntAttributes:
return true;
case QRhi::ScreenSpaceDerivatives:
return true;
case QRhi::ReadBackAnyTextureFormat:
return true;
case QRhi::PipelineCacheDataLoadSave:
{
if (@available(macOS 11.0, iOS 14.0, *))
return true;
else
return false;
}
case QRhi::ImageDataStride:
return true;
case QRhi::RenderBufferImport:
return false;
case QRhi::ThreeDimensionalTextures:
return true;
case QRhi::RenderTo3DTextureSlice:
return true;
case QRhi::TextureArrays:
return true;
case QRhi::Tessellation:
return true;
case QRhi::GeometryShader:
return false;
case QRhi::TextureArrayRange:
return false;
case QRhi::NonFillPolygonMode:
return true;
case QRhi::OneDimensionalTextures:
return true;
case QRhi::OneDimensionalTextureMipmaps:
return false;
case QRhi::HalfAttributes:
return true;
case QRhi::RenderToOneDimensionalTexture:
return false;
case QRhi::ThreeDimensionalTextureMipmaps:
return true;
case QRhi::MultiView:
return caps.multiView;
default:
Q_UNREACHABLE();
return false;
}
}
int QRhiMetal::resourceLimit(QRhi::ResourceLimit limit) const
{
switch (limit) {
case QRhi::TextureSizeMin:
return 1;
case QRhi::TextureSizeMax:
return caps.maxTextureSize;
case QRhi::MaxColorAttachments:
return 8;
case QRhi::FramesInFlight:
return QMTL_FRAMES_IN_FLIGHT;
case QRhi::MaxAsyncReadbackFrames:
return QMTL_FRAMES_IN_FLIGHT;
case QRhi::MaxThreadGroupsPerDimension:
return 65535;
case QRhi::MaxThreadsPerThreadGroup:
Q_FALLTHROUGH();
case QRhi::MaxThreadGroupX:
Q_FALLTHROUGH();
case QRhi::MaxThreadGroupY:
Q_FALLTHROUGH();
case QRhi::MaxThreadGroupZ:
return caps.maxThreadGroupSize;
case QRhi::TextureArraySizeMax:
return 2048;
case QRhi::MaxUniformBufferRange:
return 65536;
case QRhi::MaxVertexInputs:
return 31;
case QRhi::MaxVertexOutputs:
return 15; // use the minimum from MTLGPUFamily1/2/3
default:
Q_UNREACHABLE();
return 0;
}
}
const QRhiNativeHandles *QRhiMetal::nativeHandles()
{
return &nativeHandlesStruct;
}
QRhiDriverInfo QRhiMetal::driverInfo() const
{
return driverInfoStruct;
}
QRhiStats QRhiMetal::statistics()
{
QRhiStats result;
result.totalPipelineCreationTime = totalPipelineCreationTime();
return result;
}
bool QRhiMetal::makeThreadLocalNativeContextCurrent()
{
// not applicable
return false;
}
void QRhiMetal::releaseCachedResources()
{
for (QMetalShader &s : d->shaderCache)
s.destroy();
d->shaderCache.clear();
}
bool QRhiMetal::isDeviceLost() const
{
return false;
}
struct QMetalPipelineCacheDataHeader
{
quint32 rhiId;
quint32 arch;
quint32 dataSize;
quint32 osMajor;
quint32 osMinor;
char driver[236];
};
QByteArray QRhiMetal::pipelineCacheData()
{
Q_STATIC_ASSERT(sizeof(QMetalPipelineCacheDataHeader) == 256);
QByteArray data;
if (@available(macOS 11.0, iOS 14.0, *)) {
if (!d->binArch || !rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
return data;
QTemporaryFile tmp;
if (!tmp.open()) {
qCDebug(QRHI_LOG_INFO, "pipelineCacheData: Failed to create temporary file for Metal");
return data;
}
tmp.close(); // the file exists until the tmp dtor runs
const QString fn = QFileInfo(tmp.fileName()).absoluteFilePath();
NSURL *url = QUrl::fromLocalFile(fn).toNSURL();
NSError *err = nil;
if (![d->binArch serializeToURL: url error: &err]) {
const QString msg = QString::fromNSString(err.localizedDescription);
// Some of these "errors" are not actual errors. (think of "Nothing to serialize")
qCDebug(QRHI_LOG_INFO, "Failed to serialize MTLBinaryArchive: %s", qPrintable(msg));
return data;
}
QFile f(fn);
if (!f.open(QIODevice::ReadOnly)) {
qCDebug(QRHI_LOG_INFO, "pipelineCacheData: Failed to reopen temporary file");
return data;
}
const QByteArray blob = f.readAll();
f.close();
const size_t headerSize = sizeof(QMetalPipelineCacheDataHeader);
const quint32 dataSize = quint32(blob.size());
data.resize(headerSize + dataSize);
QMetalPipelineCacheDataHeader header = {};
header.rhiId = pipelineCacheRhiId();
header.arch = quint32(sizeof(void*));
header.dataSize = quint32(dataSize);
header.osMajor = osMajor;
header.osMinor = osMinor;
const size_t driverStrLen = qMin(sizeof(header.driver) - 1, size_t(driverInfoStruct.deviceName.length()));
if (driverStrLen)
memcpy(header.driver, driverInfoStruct.deviceName.constData(), driverStrLen);
header.driver[driverStrLen] = '\0';
memcpy(data.data(), &header, headerSize);
memcpy(data.data() + headerSize, blob.constData(), dataSize);
}
return data;
}
void QRhiMetal::setPipelineCacheData(const QByteArray &data)
{
if (data.isEmpty())
return;
const size_t headerSize = sizeof(QMetalPipelineCacheDataHeader);
if (data.size() < qsizetype(headerSize)) {
qCDebug(QRHI_LOG_INFO, "setPipelineCacheData: Invalid blob size (header incomplete)");
return;
}
const size_t dataOffset = headerSize;
QMetalPipelineCacheDataHeader header;
memcpy(&header, data.constData(), headerSize);