qt/qtbase/src/gui/rhi/qrhimetal.mm

Revision control

Copy as Markdown

// 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
// Qt-Security score:significant reason:default
#include "qrhimetal_p.h"
#include "qrhimetal_icb_p.h"
#include "qshader_p.h"
#include <QGuiApplication>
#include <QWindow>
#include <QUrl>
#include <QFile>
#include <QTemporaryFile>
#include <QFileInfo>
#include <qmath.h>
#include <QtCore/qendian.h>
#include <QOperatingSystemVersion>
#include <QtCore/private/qcore_mac_p.h>
#include <QtGui/private/qmetallayer_p.h>
#include <QtGui/qpa/qplatformwindow_p.h>
#ifdef Q_OS_MACOS
#include <AppKit/AppKit.h>
#else
#include <UIKit/UIKit.h>
#endif
#include <QuartzCore/CATransaction.h>
#include <Metal/Metal.h>
#include <utility> // for std::pair
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
// Even though the macOS 13 MTLBinaryArchive problem (QTBUG-106703) seems
// to be solved in later 13.x releases, we have reports from old Intel hardware
// and older macOS versions where this causes problems (QTBUG-114338).
// Thus we no longer do OS version based differentiation, but rather have a
// single toggle that is currently on, and so QRhi::(set)pipelineCache()
// does nothing with Metal.
#define QRHI_METAL_DISABLE_BINARY_ARCHIVE
// We should be able to operate with command buffers that do not automatically
// retain/release the resources used by them. (since we have logic that mirrors
// other backends such as the Vulkan one anyway)
#define QRHI_METAL_COMMAND_BUFFERS_WITH_UNRETAINED_REFERENCES
/*!
\class QRhiMetalInitParams
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\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, &params);
\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, preferably 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 QtGuiPrivate
\inheaderfile rhi/qrhi.h
\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
Set to a valid MTLDevice to import an existing device.
*/
/*!
\variable QRhiMetalNativeHandles::cmdQueue
Set to a valid MTLCommandQueue when importing an existing command queue.
When \nullptr, QRhi will create a new command queue.
*/
/*!
\class QRhiMetalCommandBufferNativeHandles
\inmodule QtGuiPrivate
\inheaderfile rhi/qrhi.h
\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()}{endOffscreenFrame()} 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;
id<MTLArgumentEncoder> argumentEncoder = nil;
int argumentBufferIndex = -1;
void destroy() {
nativeResourceBindingMap.clear();
[lib release];
lib = nil;
[func release];
func = nil;
[argumentEncoder release];
argumentEncoder = nil;
argumentBufferIndex = -1;
}
};
struct QRhiMetalData
{
QRhiMetalData(QRhiMetal *rhi) : q(rhi), ofr(rhi) { }
QRhiMetal *q;
id<MTLDevice> dev = nil;
id<MTLCommandQueue> cmdQueue = nil;
id<MTLBinaryArchive> binArch = nil;
id<MTLCommandBuffer> newCommandBuffer();
MTLRenderPassDescriptor *createDefaultRenderPass(bool hasDepthStencil,
const QColor &colorClearValue,
const QRhiDepthStencilClearValue &depthStencilClearValue,
int colorAttCount,
QRhiShadingRateMap *shadingRateMap);
id<MTLLibrary> createMetalLib(const QShader &shader, QShader::Variant shaderVariant,
bool preferArgumentBuffers,
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,
ShadingRateMap,
StagingIcbBuffer
};
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];
id<MTLTexture> samplingView;
id<MTLTexture> writeView;
} 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;
struct {
id<MTLRasterizationRateMap> rateMap;
} shadingRateMap;
struct {
id<MTLIndirectCommandBuffer> icb;
id<MTLBuffer> argBuffer;
} stagingIcbBuffer;
};
};
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;
// Only used for depth(-stencil) textures whose Metal pixel format does
// not match the layout of the readback result, where the staging
// buffer holds a densely packed depth plane, followed by a densely
// packed stencil plane when the format has stencil. See
// enqueueResourceUpdates() and finishActiveReadbacks().
quint32 depthPlaneByteSize = 0;
quint32 stencilPlaneByteSize = 0;
// Whether the depth plane holds 32-bit floats (as opposed to a
// 24-bit unorm value in the low bits of each 32-bit word).
bool depthPlaneIsFloat = false;
};
QVarLengthArray<TextureReadback, 2> activeTextureReadbacks;
struct BufferReadback
{
int activeFrameSlot = -1;
QRhiReadbackResult *result;
quint32 readSize;
id<MTLBuffer> buf;
};
QVarLengthArray<BufferReadback, 2> activeBufferReadbacks;
MTLCaptureManager *captureMgr;
id<MTLCaptureScope> captureScope = nil;
// Indirect Command Buffer (ICB) infrastructure for GPU-driven multi-draw
id<MTLIndirectCommandBuffer> icb = nil;
NSUInteger icbCapacity = 0;
id<MTLComputePipelineState> icbEncodePipeline = nil;
id<MTLComputePipelineState> icbEncodePipelineU32 = nil;
id<MTLComputePipelineState> icbEncodePipelineU16 = nil;
id<MTLFunction> icbEncodeFunction = nil;
id<MTLFunction> icbEncodeFunctionU32 = nil;
id<MTLFunction> icbEncodeFunctionU16 = nil;
id<MTLBuffer> icbArgumentBuffer = nil;
// Written by the encode kernel, consumed by executeCommandsInBuffer.
id<MTLBuffer> icbRangeBuffer = nil;
// Holds 0xFFFFFFFF, stands in for the count buffer when there is none.
id<MTLBuffer> icbNoCountBuffer = nil;
bool icbSetupFailed = false;
static const int TEXBUF_ALIGN = 256; // probably not accurate
using ShaderCacheKey = std::pair<QRhiShaderStage, bool>; // stage, argument_buffers
QHash<ShaderCacheKey, QMetalShader> shaderCache;
struct StagingArea {
id<MTLBuffer> buf = nil;
quint32 offset = 0;
quint32 capacity = 0;
quint32 bytesNeeded = 0;
int lowDemandFrames = 0;
int highDemandFrames = 0;
};
StagingArea argBufPool[QMTL_FRAMES_IN_FLIGHT];
StagingArea bufStagingPool[QMTL_FRAMES_IN_FLIGHT];
id<MTLBuffer> allocFromStagingArea(StagingArea *area, quint32 size, quint32 alignment,
int frameSlot, quint32 minBlockSize, quint32 *offset);
id<MTLBuffer> allocArgumentBuffer(quint32 size, quint32 alignment, int frameSlot, quint32 *offset);
id<MTLBuffer> allocBufferStaging(quint32 size, int frameSlot, quint32 *offset);
id<MTLBuffer> newOneShotStagingBuffer(quint32 size, int frameSlot);
void resetAndResizeBufferStagingArea(int frameSlot);
// Uploads larger than this always get their own one-shot MTLBuffer and do
// not count towards the area's size, so that a one-off large upload cannot
// inflate it.
static constexpr quint32 LARGE_STAGING_ALLOC = 512 * 1024;
static constexpr quint32 STAGING_AREA_MIN = 64 * 1024;
static constexpr quint32 STAGING_AREA_MAX = 16 * 1024 * 1024;
static constexpr int STAGING_AREA_LOW_DEMAND_FRAMES = 60;
static constexpr int STAGING_AREA_HIGH_DEMAND_FRAMES = 3;
// Counts both swapchain and offscreen frames. Never 0 once a frame started,
// so that a default-initialized "used in frame" cannot match.
quint64 globalFrameId = 0;
};
Q_DECLARE_TYPEINFO(QRhiMetalData::DeferredReleaseEntry, Q_RELOCATABLE_TYPE);
Q_DECLARE_TYPEINFO(QRhiMetalData::TextureReadback, Q_RELOCATABLE_TYPE);
struct QMetalBufferData
{
bool managed = false;
bool slotted = false;
bool isDeviceLocal = false; // true = MTLResourceStorageModePrivate buf[0], no slotting, non-host visible
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;
MTLPixelFormat viewFormat = MTLPixelFormatInvalid;
MTLPixelFormat viewFormatForSampling = MTLPixelFormatInvalid;
id<MTLTexture> tex = nil;
id<MTLTexture> samplingView = nil;
id<MTLTexture> writeView = nil;
id<MTLBuffer> stagingBuf[QMTL_FRAMES_IN_FLIGHT];
bool owns = true;
id<MTLTexture> perLevelViews[QRhi::MAX_MIP_LEVELS];
id<MTLTexture> textureForSampling() const { return samplingView ? samplingView : tex; }
id<MTLTexture> textureForWrite() const { return writeView ? writeView : tex; }
bool createViews();
id<MTLTexture> viewForLevel(int level);
};
struct QMetalSamplerData
{
id<MTLSamplerState> samplerState = nil;
};
struct QMetalShadingRateMapData
{
id<MTLRasterizationRateMap> rateMap = nil;
};
struct QMetalShaderResourceBindingsData {
struct Stage {
struct Buffer {
int nativeBinding;
id<MTLBuffer> mtlbuf;
quint32 offset;
};
struct Texture {
int nativeBinding;
id<MTLTexture> mtltex;
MTLResourceUsage usage;
};
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;
bool usesArgumentBuffer = false; // relevant for textures
} 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;
QVarLengthArray<QByteArray, 4> openDebugGroups;
// Intended final store actions for the attachments whose store action is
// deferred. MTLStoreActionUnknown for depth and stencil means not deferred.
// See beginPass().
QVarLengthArray<std::pair<uint, MTLStoreAction>, 4> deferredColorStoreActions;
MTLStoreAction deferredDepthStoreAction;
MTLStoreAction deferredStencilStoreAction;
};
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;
id<MTLTexture> dsResolveTex = nil;
bool hasStencil = false;
bool depthNeedsStore = false;
bool preserveColor = false;
bool preserveDs = false;
} fb;
QRhiRenderTargetAttachmentTracker::ResIdList currentResIdList;
};
struct QMetalGraphicsPipelineData
{
QMetalGraphicsPipeline *q = nullptr;
id<MTLRenderPipelineState> ps = nil;
id<MTLDepthStencilState> ds = nil;
bool icbCapable = false;
MTLPrimitiveType primitiveType;
MTLWinding winding;
MTLCullMode cullMode;
MTLTriangleFillMode triangleFillMode;
MTLDepthClipMode depthClipMode;
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;
};
QRhiMetal::QRhiMetal(QRhiMetalInitParams *params, QRhiMetalNativeHandles *importDevice)
{
Q_UNUSED(params);
d = new QRhiMetalData(this);
importedDevice = importDevice != nullptr;
if (importedDevice) {
if (importDevice->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)
{
QMacAutoReleasePool pool;
Q_UNUSED(params);
id<MTLDevice> dev = MTLCreateSystemDefaultDevice();
if (dev) {
[dev release];
return true;
}
return false;
}
id<MTLCommandBuffer> QRhiMetalData::newCommandBuffer()
{
#ifdef QRHI_METAL_COMMAND_BUFFERS_WITH_UNRETAINED_REFERENCES
// Do not let the command buffer mess with the refcount of objects. We do
// have a proper render loop and will manage lifetimes similarly to other
// backends (Vulkan).
return [cmdQueue commandBufferWithUnretainedReferences];
#else
return [cmdQueue commandBuffer];
#endif
}
bool QRhiMetalData::setupBinaryArchive(NSURL *sourceFileUrl)
{
#ifdef QRHI_METAL_DISABLE_BINARY_ARCHIVE
return false;
#endif
[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;
}
return true;
}
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_MACOS
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;
}
#else
driverInfoStruct.deviceType = QRhiDriverInfo::IntegratedDevice;
#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) || defined(Q_OS_VISIONOS)
caps.maxTextureSize = 16384;
caps.baseVertexAndInstance = true;
caps.isAppleGPU = [d->dev supportsFamily:MTLGPUFamilyApple7];
caps.maxThreadGroupSize = 1024;
caps.multiView = true;
#elif defined(Q_OS_TVOS)
if ([d->dev supportsFamily:MTLGPUFamilyApple3])
caps.maxTextureSize = 16384;
else
caps.maxTextureSize = 8192;
caps.baseVertexAndInstance = false;
caps.isAppleGPU = true;
#elif defined(Q_OS_IOS)
if ([d->dev supportsFamily:MTLGPUFamilyApple3]) {
caps.maxTextureSize = 16384;
caps.baseVertexAndInstance = true;
} else if ([d->dev supportsFamily:MTLGPUFamilyApple2]) {
caps.maxTextureSize = 8192;
caps.baseVertexAndInstance = false;
} else {
caps.maxTextureSize = 4096;
caps.baseVertexAndInstance = false;
}
caps.isAppleGPU = true;
if ([d->dev supportsFamily:MTLGPUFamilyApple4])
caps.maxThreadGroupSize = 1024;
if ([d->dev supportsFamily:MTLGPUFamilyApple5])
caps.multiView = true;
#endif
// MTLBlitCommandEncoder's buffer-to-buffer copy requires 4 byte aligned
// offsets and size on non-Apple GPUs, whereas uploadStaticBuffer() takes
// any offset and size. Keep the legacy host-write path there.
caps.usePrivateStaticBuffers = caps.isAppleGPU;
if (qEnvironmentVariableIntValue("QT_METAL_NO_PRIVATE_STATIC_BUFFERS"))
caps.usePrivateStaticBuffers = false;
caps.supportedSampleCounts = { 1 };
for (int sampleCount : { 2, 4, 8 }) {
if ([d->dev supportsTextureSampleCount: sampleCount])
caps.supportedSampleCounts.append(sampleCount);
}
caps.indirectCommandBuffers = ([d->dev supportsFamily:MTLGPUFamilyApple5]
|| [d->dev supportsFamily:MTLGPUFamilyMac2])
&& [d->dev supportsFamily:MTLGPUFamilyMetal3];
caps.shadingRateMap = [d->dev supportsRasterizationRateMapWithLayerCount: 1];
if (caps.shadingRateMap && caps.multiView)
caps.shadingRateMap = [d->dev supportsRasterizationRateMapWithLayerCount: 2];
// QTBUG-144444: setDepthClipMode is not available on the Simulator
caps.depthClamp = [d->dev supportsFamily:MTLGPUFamilyApple3];
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;
for (auto *pools : { d->argBufPool, d->bufStagingPool }) {
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
[pools[i].buf release];
pools[i].buf = nil;
pools[i].capacity = 0;
pools[i].offset = 0;
}
}
[d->icbArgumentBuffer release];
d->icbArgumentBuffer = nil;
[d->icbRangeBuffer release];
d->icbRangeBuffer = nil;
[d->icbNoCountBuffer release];
d->icbNoCountBuffer = nil;
[d->icbEncodeFunction release];
d->icbEncodeFunction = nil;
[d->icbEncodeFunctionU32 release];
d->icbEncodeFunctionU32 = nil;
[d->icbEncodeFunctionU16 release];
d->icbEncodeFunctionU16 = nil;
[d->icbEncodePipeline release];
d->icbEncodePipeline = nil;
[d->icbEncodePipelineU32 release];
d->icbEncodePipelineU32 = nil;
[d->icbEncodePipelineU16 release];
d->icbEncodePipelineU16 = nil;
[d->icb release];
d->icb = nil;
d->icbCapacity = 0;
d->icbSetupFailed = false;
[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;
}
QVector<QSize> QRhiMetal::supportedShadingRates(int sampleCount) const
{
Q_UNUSED(sampleCount);
return { QSize(1, 1) };
}
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
// NB the ctor takes row-major
static constexpr QMatrix4x4 m(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:
#ifdef QRHI_METAL_DISABLE_BINARY_ARCHIVE
return false;
#else
return true;
#endif
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 true;
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;
case QRhi::TextureViewFormat:
return true;
case QRhi::ResolveDepthStencil:
return true;
case QRhi::VariableRateShading:
return false;
case QRhi::VariableRateShadingMap:
return caps.shadingRateMap;
case QRhi::VariableRateShadingMapWithTexture:
return false;
case QRhi::PerRenderTargetBlending:
case QRhi::SampleVariables:
return true;
case QRhi::InstanceIndexIncludesBaseInstance:
return true;
case QRhi::DepthClamp:
return caps.depthClamp;
case QRhi::DrawIndirect:
return true;
case QRhi::DrawIndirectMulti:
return caps.indirectCommandBuffers;
case QRhi::ShaderDrawParameters:
return false;
case QRhi::PushConstants:
return true;
case QRhi::DrawIndirectCount:
return caps.indirectCommandBuffers;
case QRhi::DispatchIndirect:
return true;
case QRhi::BufferToBufferCopy:
return true;
case QRhi::StaticBuffersOnGpuTimeline:
return caps.usePrivateStaticBuffers;
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
case QRhi::MaxPushConstantsSize:
return 4096; // the limit for setVertexBytes() and friends
case QRhi::MaxVertexStorageBuffers:
case QRhi::MaxFragmentStorageBuffers:
return 31;
case QRhi::ShadingRateImageTileSize:
return 0;
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::setQueueSubmitParams(QRhiNativeHandles *)
{
// not applicable
}
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 (!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);
const quint32 rhiId = pipelineCacheRhiId();
if (header.rhiId != rhiId) {
qCDebug(QRHI_LOG_INFO, "setPipelineCacheData: The data is for a different QRhi version or backend (%u, %u)",
rhiId, header.rhiId);
return;
}
const quint32 arch = quint32(sizeof(void*));
if (header.arch != arch) {
qCDebug(QRHI_LOG_INFO, "setPipelineCacheData: Architecture does not match (%u, %u)",
arch, header.arch);
return;
}
if (header.osMajor != osMajor || header.osMinor != osMinor) {
qCDebug(QRHI_LOG_INFO, "setPipelineCacheData: OS version does not match (%u.%u, %u.%u)",
osMajor, osMinor, header.osMajor, header.osMinor);
return;
}
const size_t driverStrLen = qMin(sizeof(header.driver) - 1, size_t(driverInfoStruct.deviceName.length()));
if (strncmp(header.driver, driverInfoStruct.deviceName.constData(), driverStrLen)) {
qCDebug(QRHI_LOG_INFO, "setPipelineCacheData: Metal device name does not match");
return;
}
if (quint64(data.size()) < quint64(dataOffset) + header.dataSize) {
qCDebug(QRHI_LOG_INFO, "setPipelineCacheData: Invalid blob size (data incomplete)");
return;
}
const char *p = data.constData() + dataOffset;
QTemporaryFile tmp;
if (!tmp.open()) {
qCDebug(QRHI_LOG_INFO, "pipelineCacheData: Failed to create temporary file for Metal");
return;
}
tmp.write(p, header.dataSize);
tmp.close(); // the file exists until the tmp dtor runs
const QString fn = QFileInfo(tmp.fileName()).absoluteFilePath();
NSURL *url = QUrl::fromLocalFile(fn).toNSURL();
if (d->setupBinaryArchive(url))
qCDebug(QRHI_LOG_INFO, "Created MTLBinaryArchive with initial data of %u bytes", header.dataSize);
}
QRhiRenderBuffer *QRhiMetal::createRenderBuffer(QRhiRenderBuffer::Type type, const QSize &pixelSize,
int sampleCount, QRhiRenderBuffer::Flags flags,
QRhiTexture::Format backingFormatHint)
{
return new QMetalRenderBuffer(this, type, pixelSize, sampleCount, flags, backingFormatHint);
}
QRhiTexture *QRhiMetal::createTexture(QRhiTexture::Format format,
const QSize &pixelSize, int depth, int arraySize,
int sampleCount, QRhiTexture::Flags flags)
{
return new QMetalTexture(this, format, pixelSize, depth, arraySize, sampleCount, flags);
}
QRhiSampler *QRhiMetal::createSampler(QRhiSampler::Filter magFilter, QRhiSampler::Filter minFilter,
QRhiSampler::Filter mipmapMode,
QRhiSampler::AddressMode u, QRhiSampler::AddressMode v, QRhiSampler::AddressMode w)
{
return new QMetalSampler(this, magFilter, minFilter, mipmapMode, u, v, w);
}
QRhiShadingRateMap *QRhiMetal::createShadingRateMap()
{
return new QMetalShadingRateMap(this);
}
QRhiTextureRenderTarget *QRhiMetal::createTextureRenderTarget(const QRhiTextureRenderTargetDescription &desc,
QRhiTextureRenderTarget::Flags flags)
{
return new QMetalTextureRenderTarget(this, desc, flags);
}
QRhiGraphicsPipeline *QRhiMetal::createGraphicsPipeline()
{
return new QMetalGraphicsPipeline(this);
}
QRhiComputePipeline *QRhiMetal::createComputePipeline()
{
return new QMetalComputePipeline(this);
}
QRhiShaderResourceBindings *QRhiMetal::createShaderResourceBindings()
{
return new QMetalShaderResourceBindings(this);
}
enum class BindingType {
Buffer,
Texture,
Sampler
};
static inline int mapBinding(int binding,
int stageIndex,
const QShader::NativeResourceBindingMap *nativeResourceBindingMaps[],
BindingType type)
{
const QShader::NativeResourceBindingMap *map = nativeResourceBindingMaps[stageIndex];
if (!map || map->isEmpty())
return binding; // old QShader versions do not have this map, assume 1:1 mapping then
auto it = map->constFind(binding);
if (it != map->cend())
return type == BindingType::Sampler ? it->second : it->first; // may be -1, if the resource is inactive
// Hitting this path is normal too. It is not given that the resource (for
// example, a uniform block) is present in the shaders for all the stages
// specified by the visibility mask in the QRhiShaderResourceBinding.
return -1;
}
static inline MTLResourceUsage storageImageUsage(QRhiShaderResourceBinding::Type type)
{
switch (type) {
case QRhiShaderResourceBinding::ImageLoad:
return MTLResourceUsageRead;
case QRhiShaderResourceBinding::ImageStore:
return MTLResourceUsageWrite;
default:
return MTLResourceUsageRead | MTLResourceUsageWrite;
}
}
static inline void declareStageArgumentBufferResources(QMetalCommandBuffer *cbD,
int encoderStage,
const QMetalShaderResourceBindingsData::Stage &res)
{
for (const QMetalShaderResourceBindingsData::Stage::Texture &t : res.textures) {
switch (encoderStage) {
case QMetalShaderResourceBindingsData::VERTEX:
[cbD->d->currentRenderPassEncoder useResource: t.mtltex usage: t.usage stages: MTLRenderStageVertex];
break;
case QMetalShaderResourceBindingsData::FRAGMENT:
[cbD->d->currentRenderPassEncoder useResource: t.mtltex usage: t.usage stages: MTLRenderStageFragment];
break;
case QMetalShaderResourceBindingsData::COMPUTE:
[cbD->d->currentComputePassEncoder useResource: t.mtltex usage: t.usage];
break;
default:
break;
}
}
}
static inline void bindStageBuffers(QMetalCommandBuffer *cbD,
int stage,
const QRhiBatchedBindings<id<MTLBuffer>>::Batch &bufferBatch,
const QRhiBatchedBindings<NSUInteger>::Batch &offsetBatch)
{
switch (stage) {
case QMetalShaderResourceBindingsData::VERTEX:
[cbD->d->currentRenderPassEncoder setVertexBuffers: bufferBatch.resources.constData()
offsets: offsetBatch.resources.constData()
withRange: NSMakeRange(bufferBatch.startBinding, NSUInteger(bufferBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::FRAGMENT:
[cbD->d->currentRenderPassEncoder setFragmentBuffers: bufferBatch.resources.constData()
offsets: offsetBatch.resources.constData()
withRange: NSMakeRange(bufferBatch.startBinding, NSUInteger(bufferBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::COMPUTE:
[cbD->d->currentComputePassEncoder setBuffers: bufferBatch.resources.constData()
offsets: offsetBatch.resources.constData()
withRange: NSMakeRange(bufferBatch.startBinding, NSUInteger(bufferBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::TESSCTRL:
case QMetalShaderResourceBindingsData::TESSEVAL:
// do nothing. These are used later for tessellation
break;
default:
Q_UNREACHABLE();
break;
}
}
static inline void bindStageTextures(QMetalCommandBuffer *cbD,
int stage,
const QRhiBatchedBindings<id<MTLTexture>>::Batch &textureBatch)
{
switch (stage) {
case QMetalShaderResourceBindingsData::VERTEX:
[cbD->d->currentRenderPassEncoder setVertexTextures: textureBatch.resources.constData()
withRange: NSMakeRange(textureBatch.startBinding, NSUInteger(textureBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::FRAGMENT:
[cbD->d->currentRenderPassEncoder setFragmentTextures: textureBatch.resources.constData()
withRange: NSMakeRange(textureBatch.startBinding, NSUInteger(textureBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::COMPUTE:
[cbD->d->currentComputePassEncoder setTextures: textureBatch.resources.constData()
withRange: NSMakeRange(textureBatch.startBinding, NSUInteger(textureBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::TESSCTRL:
case QMetalShaderResourceBindingsData::TESSEVAL:
// do nothing. These are used later for tessellation
break;
default:
Q_UNREACHABLE();
break;
}
}
static inline void bindStageSamplers(QMetalCommandBuffer *cbD,
int encoderStage,
const QRhiBatchedBindings<id<MTLSamplerState>>::Batch &samplerBatch)
{
switch (encoderStage) {
case QMetalShaderResourceBindingsData::VERTEX:
[cbD->d->currentRenderPassEncoder setVertexSamplerStates: samplerBatch.resources.constData()
withRange: NSMakeRange(samplerBatch.startBinding, NSUInteger(samplerBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::FRAGMENT:
[cbD->d->currentRenderPassEncoder setFragmentSamplerStates: samplerBatch.resources.constData()
withRange: NSMakeRange(samplerBatch.startBinding, NSUInteger(samplerBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::COMPUTE:
[cbD->d->currentComputePassEncoder setSamplerStates: samplerBatch.resources.constData()
withRange: NSMakeRange(samplerBatch.startBinding, NSUInteger(samplerBatch.resources.count()))];
break;
case QMetalShaderResourceBindingsData::TESSCTRL:
case QMetalShaderResourceBindingsData::TESSEVAL:
// do nothing. These are used later for tessellation
break;
default:
Q_UNREACHABLE();
break;
}
}
// Helper that is not used during the common vertex+fragment and compute
// pipelines, but is necessary when tessellation is involved and so the
// graphics pipeline is under the hood a combination of multiple compute and
// render pipelines. We need to be able to set the buffers, textures, samplers
// when a switching between render and compute encoders.
static inline void rebindShaderResources(QMetalCommandBuffer *cbD, int resourceStage, int encoderStage,
const QMetalShaderResourceBindingsData *customBindingState = nullptr)
{
const QMetalShaderResourceBindingsData *bindingData = customBindingState ? customBindingState : &cbD->d->currentShaderResourceBindingState;
for (int i = 0, ie = bindingData->res[resourceStage].bufferBatches.batches.count(); i != ie; ++i) {
const auto &bufferBatch(bindingData->res[resourceStage].bufferBatches.batches[i]);
const auto &offsetBatch(bindingData->res[resourceStage].bufferOffsetBatches.batches[i]);
bindStageBuffers(cbD, encoderStage, bufferBatch, offsetBatch);
}
for (int i = 0, ie = bindingData->res[resourceStage].textureBatches.batches.count(); i != ie; ++i) {
const auto &batch(bindingData->res[resourceStage].textureBatches.batches[i]);
bindStageTextures(cbD, encoderStage, batch);
}
for (int i = 0, ie = bindingData->res[resourceStage].samplerBatches.batches.count(); i != ie; ++i) {
const auto &batch(bindingData->res[resourceStage].samplerBatches.batches[i]);
bindStageSamplers(cbD, encoderStage, batch);
}
if (bindingData->res[resourceStage].usesArgumentBuffer)
declareStageArgumentBufferResources(cbD, encoderStage, bindingData->res[resourceStage]);
}
static inline QRhiShaderResourceBinding::StageFlag toRhiSrbStage(int stage)
{
switch (stage) {
case QMetalShaderResourceBindingsData::VERTEX:
return QRhiShaderResourceBinding::StageFlag::VertexStage;
case QMetalShaderResourceBindingsData::TESSCTRL:
return QRhiShaderResourceBinding::StageFlag::TessellationControlStage;
case QMetalShaderResourceBindingsData::TESSEVAL:
return QRhiShaderResourceBinding::StageFlag::TessellationEvaluationStage;
case QMetalShaderResourceBindingsData::FRAGMENT:
return QRhiShaderResourceBinding::StageFlag::FragmentStage;
case QMetalShaderResourceBindingsData::COMPUTE:
return QRhiShaderResourceBinding::StageFlag::ComputeStage;
}
Q_UNREACHABLE_RETURN(QRhiShaderResourceBinding::StageFlag::VertexStage);
}
void QRhiMetal::enqueueShaderResourceBindings(QMetalShaderResourceBindings *srbD,
QMetalCommandBuffer *cbD,
int dynamicOffsetCount,
const QRhiCommandBuffer::DynamicOffset *dynamicOffsets,
bool offsetOnlyChange,
const QShader::NativeResourceBindingMap *nativeResourceBindingMaps[SUPPORTED_STAGES],
const QMetalShader *shaders[SUPPORTED_STAGES])
{
QMetalShaderResourceBindingsData bindingData;
for (const QRhiShaderResourceBinding &binding : std::as_const(srbD->sortedBindings)) {
const QRhiShaderResourceBinding::Data *b = shaderResourceBindingData(binding);
switch (b->type) {
case QRhiShaderResourceBinding::UniformBuffer:
{
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, b->u.ubuf.buf);
id<MTLBuffer> mtlbuf = bufD->d->buf[bufD->d->slotted ? currentFrameSlot : 0];
quint32 offset = b->u.ubuf.offset;
for (int i = 0; i < dynamicOffsetCount; ++i) {
const QRhiCommandBuffer::DynamicOffset &dynOfs(dynamicOffsets[i]);
if (dynOfs.first == b->binding) {
offset = dynOfs.second;
break;
}
}
for (int stage = 0; stage < SUPPORTED_STAGES; ++stage) {
if (b->stage.testFlag(toRhiSrbStage(stage))) {
const int nativeBinding = mapBinding(b->binding, stage, nativeResourceBindingMaps, BindingType::Buffer);
if (nativeBinding >= 0)
bindingData.res[stage].buffers.append({ nativeBinding, mtlbuf, offset });
}
}
}
break;
case QRhiShaderResourceBinding::SampledTexture:
case QRhiShaderResourceBinding::Texture:
case QRhiShaderResourceBinding::Sampler:
{
const QRhiShaderResourceBinding::Data::TextureAndOrSamplerData *data = &b->stex;
for (int elem = 0; elem < data->count(); ++elem) {
QMetalTexture *texD = QRHI_RES(QMetalTexture, b->stex.texSamplers[elem].tex);
QMetalSampler *samplerD = QRHI_RES(QMetalSampler, b->stex.texSamplers[elem].sampler);
for (int stage = 0; stage < SUPPORTED_STAGES; ++stage) {
if (b->stage.testFlag(toRhiSrbStage(stage))) {
// Must handle all three cases (combined, separate, separate):
// first = texture binding, second = sampler binding
// first = texture binding
// first = sampler binding (i.e. BindingType::Texture...)
const int textureBinding = mapBinding(b->binding, stage, nativeResourceBindingMaps, BindingType::Texture);
const int samplerBinding = texD && samplerD ? mapBinding(b->binding, stage, nativeResourceBindingMaps, BindingType::Sampler)
: (samplerD ? mapBinding(b->binding, stage, nativeResourceBindingMaps, BindingType::Texture) : -1);
if (textureBinding >= 0 && texD)
bindingData.res[stage].textures.append({ textureBinding + elem, texD->d->textureForSampling(), MTLResourceUsageRead });
if (samplerBinding >= 0)
bindingData.res[stage].samplers.append({ samplerBinding + elem, samplerD->d->samplerState });
}
}
}
}
break;
case QRhiShaderResourceBinding::ImageLoad:
case QRhiShaderResourceBinding::ImageStore:
case QRhiShaderResourceBinding::ImageLoadStore:
{
QMetalTexture *texD = QRHI_RES(QMetalTexture, b->u.simage.tex);
id<MTLTexture> t = texD->d->viewForLevel(b->u.simage.level);
for (int stage = 0; stage < SUPPORTED_STAGES; ++stage) {
if (b->stage.testFlag(toRhiSrbStage(stage))) {
const int nativeBinding = mapBinding(b->binding, stage, nativeResourceBindingMaps, BindingType::Texture);
if (nativeBinding >= 0)
bindingData.res[stage].textures.append({ nativeBinding, t, storageImageUsage(b->type) });
}
}
}
break;
case QRhiShaderResourceBinding::BufferLoad:
case QRhiShaderResourceBinding::BufferStore:
case QRhiShaderResourceBinding::BufferLoadStore:
{
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, b->u.sbuf.buf);
id<MTLBuffer> mtlbuf = bufD->d->buf[bufD->d->slotted ? currentFrameSlot : 0];
quint32 offset = b->u.sbuf.offset;
for (int stage = 0; stage < SUPPORTED_STAGES; ++stage) {
if (b->stage.testFlag(toRhiSrbStage(stage))) {
const int nativeBinding = mapBinding(b->binding, stage, nativeResourceBindingMaps, BindingType::Buffer);
if (nativeBinding >= 0)
bindingData.res[stage].buffers.append({ nativeBinding, mtlbuf, offset });
}
}
}
break;
default:
Q_UNREACHABLE();
break;
}
}
// With the argument buffer shader variant the texture and sampler values
// collected above are ids within the argument buffer, so encode them into
// one and bind that instead of binding them individually.
for (int stage = 0; stage < SUPPORTED_STAGES; ++stage) {
const QMetalShader *shader = shaders[stage];
if (!shader || !shader->argumentEncoder)
continue;
QMetalShaderResourceBindingsData::Stage &res(bindingData.res[stage]);
// offsetOnlyChange means same srb, same pipeline, and no resource
// changed, so what is in the argument buffer cannot have changed
// either. Carry the encoded one over instead of building it again.
if (offsetOnlyChange) {
const QMetalShaderResourceBindingsData::Stage &prev(
cbD->d->currentShaderResourceBindingState.res[stage]);
if (prev.usesArgumentBuffer) {
for (const QMetalShaderResourceBindingsData::Stage::Buffer &b : prev.buffers) {
if (b.nativeBinding == shader->argumentBufferIndex) {
res.samplers.clear();
res.buffers.append(b);
res.usesArgumentBuffer = true;
break;
}
}
if (res.usesArgumentBuffer)
continue;
}
}
// The argument buffer is in the constant address space, and it is bound
// like any other buffer, so the offset must satisfy the same 256 byte
// requirement on macOS that makes ubufAlignment() 256. The encoder's
// own alignment is typically well below that.
const quint32 argBufAlignment = qMax(quint32(shader->argumentEncoder.alignment),
quint32(ubufAlignment()));
quint32 argBufOffset = 0;
id<MTLBuffer> argBuf = d->allocArgumentBuffer(quint32(shader->argumentEncoder.encodedLength),
argBufAlignment, currentFrameSlot, &argBufOffset);
if (!argBuf) {
// Nothing gets bound at the argument buffer's index then, so the
// shader will dereference garbage. Acceptable: failing to
// sub-allocate from a small shared memory buffer means the process
// is out of memory anyway.
qWarning("Failed to allocate Metal argument buffer");
res.textures.clear();
res.samplers.clear();
continue;
}
[shader->argumentEncoder setArgumentBuffer: argBuf offset: argBufOffset];
for (const QMetalShaderResourceBindingsData::Stage::Texture &t : std::as_const(res.textures))
[shader->argumentEncoder setTexture: t.mtltex atIndex: NSUInteger(t.nativeBinding)];
for (const QMetalShaderResourceBindingsData::Stage::Sampler &sm : std::as_const(res.samplers))
[shader->argumentEncoder setSamplerState: sm.mtlsampler atIndex: NSUInteger(sm.nativeBinding)];
res.samplers.clear();
res.buffers.append({ shader->argumentBufferIndex, argBuf, argBufOffset });
res.usesArgumentBuffer = true;
}
for (int stage = 0; stage < SUPPORTED_STAGES; ++stage) {
if (cbD->recordingPass != QMetalCommandBuffer::RenderPass && (stage == QMetalShaderResourceBindingsData::VERTEX || stage == QMetalShaderResourceBindingsData::FRAGMENT
|| stage == QMetalShaderResourceBindingsData::TESSCTRL || stage == QMetalShaderResourceBindingsData::TESSEVAL))
continue;
if (cbD->recordingPass != QMetalCommandBuffer::ComputePass && (stage == QMetalShaderResourceBindingsData::COMPUTE))
continue;
// QRhiBatchedBindings works with the native bindings and expects
// sorted input. The pre-sorted QRhiShaderResourceBinding list (based
// on the QRhi (SPIR-V) binding) is not helpful in this regard, so we
// have to sort here every time.
std::sort(bindingData.res[stage].buffers.begin(), bindingData.res[stage].buffers.end(), [](const QMetalShaderResourceBindingsData::Stage::Buffer &a, const QMetalShaderResourceBindingsData::Stage::Buffer &b) {
return a.nativeBinding < b.nativeBinding;
});
for (const QMetalShaderResourceBindingsData::Stage::Buffer &buf : std::as_const(bindingData.res[stage].buffers)) {
bindingData.res[stage].bufferBatches.feed(buf.nativeBinding, buf.mtlbuf);
bindingData.res[stage].bufferOffsetBatches.feed(buf.nativeBinding, buf.offset);
}
bindingData.res[stage].bufferBatches.finish();
bindingData.res[stage].bufferOffsetBatches.finish();
for (int i = 0, ie = bindingData.res[stage].bufferBatches.batches.count(); i != ie; ++i) {
const auto &bufferBatch(bindingData.res[stage].bufferBatches.batches[i]);
const auto &offsetBatch(bindingData.res[stage].bufferOffsetBatches.batches[i]);
// skip setting Buffer binding if the current state is already correct
if (cbD->d->currentShaderResourceBindingState.res[stage].bufferBatches.batches.count() > i
&& cbD->d->currentShaderResourceBindingState.res[stage].bufferOffsetBatches.batches.count() > i
&& bufferBatch == cbD->d->currentShaderResourceBindingState.res[stage].bufferBatches.batches[i]
&& offsetBatch == cbD->d->currentShaderResourceBindingState.res[stage].bufferOffsetBatches.batches[i])
{
continue;
}
bindStageBuffers(cbD, stage, bufferBatch, offsetBatch);
}
if (offsetOnlyChange)
continue;
if (bindingData.res[stage].usesArgumentBuffer) {
declareStageArgumentBufferResources(cbD, stage, bindingData.res[stage]);
continue;
}
std::sort(bindingData.res[stage].textures.begin(), bindingData.res[stage].textures.end(), [](const QMetalShaderResourceBindingsData::Stage::Texture &a, const QMetalShaderResourceBindingsData::Stage::Texture &b) {
return a.nativeBinding < b.nativeBinding;
});
std::sort(bindingData.res[stage].samplers.begin(), bindingData.res[stage].samplers.end(), [](const QMetalShaderResourceBindingsData::Stage::Sampler &a, const QMetalShaderResourceBindingsData::Stage::Sampler &b) {
return a.nativeBinding < b.nativeBinding;
});
for (const QMetalShaderResourceBindingsData::Stage::Texture &t : std::as_const(bindingData.res[stage].textures))
bindingData.res[stage].textureBatches.feed(t.nativeBinding, t.mtltex);
for (const QMetalShaderResourceBindingsData::Stage::Sampler &s : std::as_const(bindingData.res[stage].samplers))
bindingData.res[stage].samplerBatches.feed(s.nativeBinding, s.mtlsampler);
bindingData.res[stage].textureBatches.finish();
bindingData.res[stage].samplerBatches.finish();
for (int i = 0, ie = bindingData.res[stage].textureBatches.batches.count(); i != ie; ++i) {
const auto &batch(bindingData.res[stage].textureBatches.batches[i]);
// skip setting Texture binding if the current state is already correct
if (cbD->d->currentShaderResourceBindingState.res[stage].textureBatches.batches.count() > i
&& batch == cbD->d->currentShaderResourceBindingState.res[stage].textureBatches.batches[i])
{
continue;
}
bindStageTextures(cbD, stage, batch);
}
for (int i = 0, ie = bindingData.res[stage].samplerBatches.batches.count(); i != ie; ++i) {
const auto &batch(bindingData.res[stage].samplerBatches.batches[i]);
// skip setting Sampler State if the current state is already correct
if (cbD->d->currentShaderResourceBindingState.res[stage].samplerBatches.batches.count() > i
&& batch == cbD->d->currentShaderResourceBindingState.res[stage].samplerBatches.batches[i])
{
continue;
}
bindStageSamplers(cbD, stage, batch);
}
}
cbD->d->currentShaderResourceBindingState = bindingData;
}
static inline quint32 mtlPushConstantBlockSize(const QMetalShader &s)
{
const QList<QShaderDescription::PushConstantBlock> blocks = s.desc.pushConstantBlocks();
return blocks.isEmpty() ? 0 : quint32(blocks.first().size);
}
static inline int mtlPushConstantBufferIndex(const QMetalShader &s)
{
return s.nativeShaderInfo.extraBufferBindings.value(QShaderPrivate::MslPushConstantBufferBinding, -1);
}
void QMetalGraphicsPipeline::makeActiveForCurrentRenderPassEncoder(QMetalCommandBuffer *cbD)
{
QRHI_RES_RHI(QRhiMetal);
// Also update the tracked state, so that the callers that reactivate a
// pipeline on a new encoder after interrupting the pass do not have to.
cbD->currentGraphicsPipeline = this;
cbD->currentComputePipeline = nullptr;
cbD->currentPipelineGeneration = generation;
[cbD->d->currentRenderPassEncoder setRenderPipelineState: d->ps];
if (cbD->d->currentDepthStencilState != d->ds) {
[cbD->d->currentRenderPassEncoder setDepthStencilState: d->ds];
cbD->d->currentDepthStencilState = d->ds;
}
if (cbD->currentCullMode == -1 || d->cullMode != uint(cbD->currentCullMode)) {
[cbD->d->currentRenderPassEncoder setCullMode: d->cullMode];
cbD->currentCullMode = int(d->cullMode);
}
if (cbD->currentTriangleFillMode == -1 || d->triangleFillMode != uint(cbD->currentTriangleFillMode)) {
[cbD->d->currentRenderPassEncoder setTriangleFillMode: d->triangleFillMode];
cbD->currentTriangleFillMode = int(d->triangleFillMode);
}
if (rhiD->caps.depthClamp) {
if (cbD->currentDepthClipMode == -1 || d->depthClipMode != uint(cbD->currentDepthClipMode)) {
[cbD->d->currentRenderPassEncoder setDepthClipMode: d->depthClipMode];
cbD->currentDepthClipMode = int(d->depthClipMode);
}
}
if (cbD->currentFrontFaceWinding == -1 || d->winding != uint(cbD->currentFrontFaceWinding)) {
[cbD->d->currentRenderPassEncoder setFrontFacingWinding: d->winding];
cbD->currentFrontFaceWinding = int(d->winding);
}
if (!qFuzzyCompare(d->depthBias, cbD->currentDepthBiasValues.first)
|| !qFuzzyCompare(d->slopeScaledDepthBias, cbD->currentDepthBiasValues.second))
{
[cbD->d->currentRenderPassEncoder setDepthBias: d->depthBias
slopeScale: d->slopeScaledDepthBias
clamp: 0.0f];
cbD->currentDepthBiasValues = { d->depthBias, d->slopeScaledDepthBias };
}
if (cbD->pushConstantsNeedRebind && !d->tess.enabled) {
const int vsIdx = mtlPushConstantBufferIndex(d->vs);
const int fsIdx = mtlPushConstantBufferIndex(d->fs);
if (vsIdx >= 0 || fsIdx >= 0) {
const quint32 blockSize = qMax(mtlPushConstantBlockSize(d->vs), mtlPushConstantBlockSize(d->fs));
if (quint32(cbD->pushConstantData.size()) < blockSize)
cbD->pushConstantData.resize(int(blockSize), 0);
const NSUInteger total = NSUInteger(cbD->pushConstantData.size());
if (vsIdx >= 0)
[cbD->d->currentRenderPassEncoder setVertexBytes: cbD->pushConstantData.constData() length: total atIndex: NSUInteger(vsIdx)];
if (fsIdx >= 0)
[cbD->d->currentRenderPassEncoder setFragmentBytes: cbD->pushConstantData.constData() length: total atIndex: NSUInteger(fsIdx)];
cbD->pushConstantsNeedRebind = false;
}
}
}
void QRhiMetal::setGraphicsPipeline(QRhiCommandBuffer *cb, QRhiGraphicsPipeline *ps)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
QMetalGraphicsPipeline *psD = QRHI_RES(QMetalGraphicsPipeline, ps);
if (cbD->currentGraphicsPipeline == psD && cbD->currentPipelineGeneration == psD->generation)
return;
cbD->currentGraphicsPipeline = psD;
cbD->currentComputePipeline = nullptr;
cbD->currentPipelineGeneration = psD->generation;
if (cbD->hasCustomScissorSet && !psD->m_flags.testFlag(QRhiGraphicsPipeline::UsesScissor))
setDefaultScissor(cbD);
if (!psD->d->tess.enabled && !psD->d->tess.failed)
psD->makeActiveForCurrentRenderPassEncoder(cbD);
// mark work buffers that can now be safely reused as reusable
// NOTE: These are usually empty unless tessellation or mutiview is used.
for (QMetalBuffer *workBuf : psD->d->extraBufMgr.deviceLocalWorkBuffers) {
if (workBuf && workBuf->lastActiveFrameSlot == currentFrameSlot)
workBuf->lastActiveFrameSlot = -1;
}
for (QMetalBuffer *workBuf : psD->d->extraBufMgr.hostVisibleWorkBuffers) {
if (workBuf && workBuf->lastActiveFrameSlot == currentFrameSlot)
workBuf->lastActiveFrameSlot = -1;
}
psD->lastActiveFrameSlot = currentFrameSlot;
}
void QRhiMetal::setShaderResources(QRhiCommandBuffer *cb, QRhiShaderResourceBindings *srb,
int dynamicOffsetCount,
const QRhiCommandBuffer::DynamicOffset *dynamicOffsets)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass != QMetalCommandBuffer::NoPass);
QMetalGraphicsPipeline *gfxPsD = cbD->currentGraphicsPipeline;
QMetalComputePipeline *compPsD = cbD->currentComputePipeline;
if (!srb) {
if (gfxPsD)
srb = gfxPsD->m_shaderResourceBindings;
else
srb = compPsD->m_shaderResourceBindings;
}
QMetalShaderResourceBindings *srbD = QRHI_RES(QMetalShaderResourceBindings, srb);
bool hasSlottedResourceInSrb = false;
bool hasDynamicOffsetInSrb = false;
bool resNeedsRebind = false;
bool pipelineChanged = false;
if (gfxPsD) {
pipelineChanged = srbD->lastUsedGraphicsPipeline != gfxPsD;
srbD->lastUsedGraphicsPipeline = gfxPsD;
} else {
pipelineChanged = srbD->lastUsedComputePipeline != compPsD;
srbD->lastUsedComputePipeline = compPsD;
}
// SPIRV-Cross buffer size buffers
// Need to determine storage buffer sizes here as this is the last opportunity for storage
// buffer bindings (offset, size) to be specified before draw / dispatch call
const bool needsBufferSizeBuffer = (compPsD && compPsD->d->bufferSizeBuffer) || (gfxPsD && gfxPsD->d->bufferSizeBuffer);
QMap<QRhiShaderResourceBinding::StageFlag, QMap<int, quint32>> storageBufferSizes;
// do buffer writes, figure out if we need to rebind, and mark as in-use
for (int i = 0, ie = srbD->sortedBindings.count(); i != ie; ++i) {
const QRhiShaderResourceBinding::Data *b = shaderResourceBindingData(srbD->sortedBindings.at(i));
QMetalShaderResourceBindings::BoundResourceData &bd(srbD->boundResourceData[i]);
switch (b->type) {
case QRhiShaderResourceBinding::UniformBuffer:
{
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, b->u.ubuf.buf);
Q_ASSERT(bufD->m_usage.testFlag(QRhiBuffer::UniformBuffer));
sanityCheckResourceOwnership(bufD);
executeBufferHostWritesForCurrentFrame(bufD);
if (bufD->d->slotted)
hasSlottedResourceInSrb = true;
if (b->u.ubuf.hasDynamicOffset)
hasDynamicOffsetInSrb = true;
if (bufD->generation != bd.ubuf.generation || bufD->m_id != bd.ubuf.id) {
resNeedsRebind = true;
bd.ubuf.id = bufD->m_id;
bd.ubuf.generation = bufD->generation;
}
bufD->lastActiveFrameSlot = currentFrameSlot;
}
break;
case QRhiShaderResourceBinding::SampledTexture:
case QRhiShaderResourceBinding::Texture:
case QRhiShaderResourceBinding::Sampler:
{
const QRhiShaderResourceBinding::Data::TextureAndOrSamplerData *data = &b->stex;
if (bd.stex.d.size() != data->count()) {
bd.stex.d.resize(data->count());
resNeedsRebind = true;
}
for (int elem = 0; elem < data->count(); ++elem) {
QMetalTexture *texD = QRHI_RES(QMetalTexture, data->texSamplers[elem].tex);
QMetalSampler *samplerD = QRHI_RES(QMetalSampler, data->texSamplers[elem].sampler);
Q_ASSERT(texD || samplerD);
sanityCheckResourceOwnership(texD);
sanityCheckResourceOwnership(samplerD);
const quint64 texId = texD ? texD->m_id : 0;
const uint texGen = texD ? texD->generation : 0;
const quint64 samplerId = samplerD ? samplerD->m_id : 0;
const uint samplerGen = samplerD ? samplerD->generation : 0;
if (texGen != bd.stex.d[elem].texGeneration
|| texId != bd.stex.d[elem].texId
|| samplerGen != bd.stex.d[elem].samplerGeneration
|| samplerId != bd.stex.d[elem].samplerId)
{
resNeedsRebind = true;
bd.stex.d[elem].texId = texId;
bd.stex.d[elem].texGeneration = texGen;
bd.stex.d[elem].samplerId = samplerId;
bd.stex.d[elem].samplerGeneration = samplerGen;
}
if (texD)
texD->lastActiveFrameSlot = currentFrameSlot;
if (samplerD)
samplerD->lastActiveFrameSlot = currentFrameSlot;
}
}
break;
case QRhiShaderResourceBinding::ImageLoad:
case QRhiShaderResourceBinding::ImageStore:
case QRhiShaderResourceBinding::ImageLoadStore:
{
QMetalTexture *texD = QRHI_RES(QMetalTexture, b->u.simage.tex);
sanityCheckResourceOwnership(texD);
if (texD->generation != bd.simage.generation || texD->m_id != bd.simage.id) {
resNeedsRebind = true;
bd.simage.id = texD->m_id;
bd.simage.generation = texD->generation;
}
texD->lastActiveFrameSlot = currentFrameSlot;
}
break;
case QRhiShaderResourceBinding::BufferLoad:
case QRhiShaderResourceBinding::BufferStore:
case QRhiShaderResourceBinding::BufferLoadStore:
{
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, b->u.sbuf.buf);
Q_ASSERT(bufD->m_usage.testFlag(QRhiBuffer::StorageBuffer));
sanityCheckResourceOwnership(bufD);
if (needsBufferSizeBuffer) {
for (int i = 0; i < 6; ++i) {
const QRhiShaderResourceBinding::StageFlag stage =
QRhiShaderResourceBinding::StageFlag(1 << i);
if (b->stage.testFlag(stage)) {
storageBufferSizes[stage][b->binding] = b->u.sbuf.maybeSize ? b->u.sbuf.maybeSize : bufD->size();
}
}
}
executeBufferHostWritesForCurrentFrame(bufD);
if (bufD->generation != bd.sbuf.generation || bufD->m_id != bd.sbuf.id) {
resNeedsRebind = true;
bd.sbuf.id = bufD->m_id;
bd.sbuf.generation = bufD->generation;
}
bufD->lastActiveFrameSlot = currentFrameSlot;
}
break;
default:
Q_UNREACHABLE();
break;
}
}
if (needsBufferSizeBuffer) {
QMetalBuffer *bufD = nullptr;
QVarLengthArray<std::pair<QMetalShader *, QRhiShaderResourceBinding::StageFlag>, 4> shaders;
if (compPsD) {
bufD = compPsD->d->bufferSizeBuffer;
Q_ASSERT(compPsD->d->cs.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding));
shaders.append({&compPsD->d->cs, QRhiShaderResourceBinding::StageFlag::ComputeStage});
} else {
bufD = gfxPsD->d->bufferSizeBuffer;
if (gfxPsD->d->tess.enabled) {
// Assumptions
// * We only use one of the compute vertex shader variants in a pipeline at any one time
// * The vertex shader variants all have the same storage block bindings
// * The vertex shader variants all have the same native resource binding map
// * The vertex shader variants all have the same MslBufferSizeBufferBinding requirement
// * The vertex shader variants all have the same MslBufferSizeBufferBinding binding
// => We only need to use one vertex shader variant to generate the identical shader
// resource bindings
Q_ASSERT(gfxPsD->d->tess.compVs[0].desc.storageBlocks() == gfxPsD->d->tess.compVs[1].desc.storageBlocks());
Q_ASSERT(gfxPsD->d->tess.compVs[0].desc.storageBlocks() == gfxPsD->d->tess.compVs[2].desc.storageBlocks());
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeResourceBindingMap == gfxPsD->d->tess.compVs[1].nativeResourceBindingMap);
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeResourceBindingMap == gfxPsD->d->tess.compVs[2].nativeResourceBindingMap);
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding)
== gfxPsD->d->tess.compVs[1].nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding));
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding)
== gfxPsD->d->tess.compVs[2].nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding));
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding]
== gfxPsD->d->tess.compVs[1].nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding]);
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding]
== gfxPsD->d->tess.compVs[2].nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding]);
if (gfxPsD->d->tess.compVs[0].nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding))
shaders.append({&gfxPsD->d->tess.compVs[0], QRhiShaderResourceBinding::StageFlag::VertexStage});
if (gfxPsD->d->tess.compTesc.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding))
shaders.append({&gfxPsD->d->tess.compTesc, QRhiShaderResourceBinding::StageFlag::TessellationControlStage});
if (gfxPsD->d->tess.vertTese.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding))
shaders.append({&gfxPsD->d->tess.vertTese, QRhiShaderResourceBinding::StageFlag::TessellationEvaluationStage});
} else {
if (gfxPsD->d->vs.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding))
shaders.append({&gfxPsD->d->vs, QRhiShaderResourceBinding::StageFlag::VertexStage});
}
if (gfxPsD->d->fs.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding))
shaders.append({&gfxPsD->d->fs, QRhiShaderResourceBinding::StageFlag::FragmentStage});
}
quint32 offset = 0;
for (const auto &shader : shaders) {
const int binding = shader.first->nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding];
// if we don't have a srb entry for the buffer size buffer
if (!(storageBufferSizes.contains(shader.second) && storageBufferSizes[shader.second].contains(binding))) {
int maxNativeBinding = 0;
for (const QShaderDescription::StorageBlock &block : shader.first->desc.storageBlocks())
maxNativeBinding = qMax(maxNativeBinding, shader.first->nativeResourceBindingMap[block.binding].first);
const int size = (maxNativeBinding + 1) * sizeof(int);
Q_ASSERT(offset + size <= bufD->size());
srbD->sortedBindings.append(QRhiShaderResourceBinding::bufferLoad(binding, shader.second, bufD, offset, size));
QMetalShaderResourceBindings::BoundResourceData bd;
bd.sbuf.id = bufD->m_id;
bd.sbuf.generation = bufD->generation;
srbD->boundResourceData.append(bd);
}
// create the buffer size buffer data
QVarLengthArray<int, 8> bufferSizeBufferData;
Q_ASSERT(storageBufferSizes.contains(shader.second));
const QMap<int, quint32> &sizes(storageBufferSizes[shader.second]);
for (const QShaderDescription::StorageBlock &block : shader.first->desc.storageBlocks()) {
const int index = shader.first->nativeResourceBindingMap[block.binding].first;
// if the native binding is -1, the buffer is present but not accessed in the shader
if (index < 0)
continue;
if (bufferSizeBufferData.size() <= index)
bufferSizeBufferData.resize(index + 1);
Q_ASSERT(sizes.contains(block.binding));
bufferSizeBufferData[index] = sizes[block.binding];
}
QRhiBufferData data;
const quint32 size = bufferSizeBufferData.size() * sizeof(int);
data.assign(reinterpret_cast<const char *>(bufferSizeBufferData.constData()), size);
Q_ASSERT(offset + size <= bufD->size());
bufD->d->pendingUpdates[bufD->d->slotted ? currentFrameSlot : 0].append({ offset, data });
// buffer offsets must be 32byte aligned
offset += ((size + 31) / 32) * 32;
}
executeBufferHostWritesForCurrentFrame(bufD);
bufD->lastActiveFrameSlot = currentFrameSlot;
}
// make sure the resources for the correct slot get bound
const int resSlot = hasSlottedResourceInSrb ? currentFrameSlot : 0;
if (hasSlottedResourceInSrb && cbD->currentResSlot != resSlot)
resNeedsRebind = true;
const bool srbChanged = gfxPsD ? (cbD->currentGraphicsSrb != srbD) : (cbD->currentComputeSrb != srbD);
const bool srbRebuilt = cbD->currentSrbGeneration != srbD->generation;
// dynamic uniform buffer offsets always trigger a rebind
if (hasDynamicOffsetInSrb || resNeedsRebind || srbChanged || srbRebuilt || pipelineChanged) {
const QShader::NativeResourceBindingMap *resBindMaps[SUPPORTED_STAGES] = { nullptr, nullptr, nullptr, nullptr, nullptr };
const QMetalShader *shaders[SUPPORTED_STAGES] = { nullptr, nullptr, nullptr, nullptr, nullptr };
if (gfxPsD) {
cbD->currentGraphicsSrb = srbD;
cbD->currentComputeSrb = nullptr;
if (gfxPsD->d->tess.enabled) {
// If tessellating, we don't know which compVs shader to use until the draw call is
// made. They should all have the same native resource binding map, so pick one.
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeResourceBindingMap == gfxPsD->d->tess.compVs[1].nativeResourceBindingMap);
Q_ASSERT(gfxPsD->d->tess.compVs[0].nativeResourceBindingMap == gfxPsD->d->tess.compVs[2].nativeResourceBindingMap);
resBindMaps[QMetalShaderResourceBindingsData::VERTEX] = &gfxPsD->d->tess.compVs[0].nativeResourceBindingMap;
resBindMaps[QMetalShaderResourceBindingsData::TESSCTRL] = &gfxPsD->d->tess.compTesc.nativeResourceBindingMap;
resBindMaps[QMetalShaderResourceBindingsData::TESSEVAL] = &gfxPsD->d->tess.vertTese.nativeResourceBindingMap;
} else {
resBindMaps[QMetalShaderResourceBindingsData::VERTEX] = &gfxPsD->d->vs.nativeResourceBindingMap;
shaders[QMetalShaderResourceBindingsData::VERTEX] = &gfxPsD->d->vs;
}
resBindMaps[QMetalShaderResourceBindingsData::FRAGMENT] = &gfxPsD->d->fs.nativeResourceBindingMap;
shaders[QMetalShaderResourceBindingsData::FRAGMENT] = &gfxPsD->d->fs;
} else {
cbD->currentGraphicsSrb = nullptr;
cbD->currentComputeSrb = srbD;
resBindMaps[QMetalShaderResourceBindingsData::COMPUTE] = &compPsD->d->cs.nativeResourceBindingMap;
shaders[QMetalShaderResourceBindingsData::COMPUTE] = &compPsD->d->cs;
}
cbD->currentSrbGeneration = srbD->generation;
cbD->currentResSlot = resSlot;
const bool offsetOnlyChange = hasDynamicOffsetInSrb && !resNeedsRebind
&& !srbChanged && !srbRebuilt && !pipelineChanged;
enqueueShaderResourceBindings(srbD, cbD, dynamicOffsetCount, dynamicOffsets, offsetOnlyChange,
resBindMaps, shaders);
}
}
void QRhiMetal::setVertexInput(QRhiCommandBuffer *cb,
int startBinding, int bindingCount, const QRhiCommandBuffer::VertexInput *bindings,
QRhiBuffer *indexBuf, quint32 indexOffset, QRhiCommandBuffer::IndexFormat indexFormat)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
QRhiBatchedBindings<id<MTLBuffer> > buffers;
QRhiBatchedBindings<NSUInteger> offsets;
for (int i = 0; i < bindingCount; ++i) {
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, bindings[i].first);
executeBufferHostWritesForCurrentFrame(bufD);
bufD->lastActiveFrameSlot = currentFrameSlot;
id<MTLBuffer> mtlbuf = bufD->d->buf[bufD->d->slotted ? currentFrameSlot : 0];
buffers.feed(startBinding + i, mtlbuf);
offsets.feed(startBinding + i, bindings[i].second);
}
buffers.finish();
offsets.finish();
// same binding space for vertex and constant buffers - work it around
QMetalShaderResourceBindings *srbD = cbD->currentGraphicsSrb;
// There's nothing guaranteeing setShaderResources() was called before
// setVertexInput()... but whatever srb will get bound will have to be
// layout-compatible anyways so maxBinding is the same.
if (!srbD)
srbD = QRHI_RES(QMetalShaderResourceBindings, cbD->currentGraphicsPipeline->shaderResourceBindings());
const int firstVertexBinding = srbD->maxBinding + 1;
if (firstVertexBinding != cbD->d->currentFirstVertexBinding
|| buffers != cbD->d->currentVertexInputsBuffers
|| offsets != cbD->d->currentVertexInputOffsets)
{
cbD->d->currentFirstVertexBinding = firstVertexBinding;
cbD->d->currentVertexInputsBuffers = buffers;
cbD->d->currentVertexInputOffsets = offsets;
for (int i = 0, ie = buffers.batches.count(); i != ie; ++i) {
const auto &bufferBatch(buffers.batches[i]);
const auto &offsetBatch(offsets.batches[i]);
[cbD->d->currentRenderPassEncoder setVertexBuffers:
bufferBatch.resources.constData()
offsets: offsetBatch.resources.constData()
withRange: NSMakeRange(uint(firstVertexBinding) + bufferBatch.startBinding, NSUInteger(bufferBatch.resources.count()))];
}
}
if (indexBuf) {
QMetalBuffer *ibufD = QRHI_RES(QMetalBuffer, indexBuf);
executeBufferHostWritesForCurrentFrame(ibufD);
ibufD->lastActiveFrameSlot = currentFrameSlot;
cbD->currentIndexBuffer = ibufD;
cbD->currentIndexOffset = indexOffset;
cbD->currentIndexFormat = indexFormat;
} else {
cbD->currentIndexBuffer = nullptr;
}
}
// The size of the coordinate space viewports and scissors are specified in.
// Normally this is the pixel size of the render target. When a rasterization
// rate map is attached, Metal interprets viewports and scissors in the logical
// (screen space) coordinate system of the map, which is typically larger than
// the physical texture size. This is what foveated rendering on visionOS uses.
QSize QRhiMetal::outputSizeForTarget(QRhiRenderTarget *target)
{
QRhiShadingRateMap *srm = nullptr;
switch (target->resourceType()) {
case QRhiResource::TextureRenderTarget:
srm = QRHI_RES(QMetalTextureRenderTarget, target)->m_desc.shadingRateMap();
break;
case QRhiResource::SwapChainRenderTarget:
srm = QRHI_RES(QMetalSwapChainRenderTarget, target)->swapChain()->shadingRateMap();
break;
default:
break;
}
if (srm) {
const QSize logicalSize = srm->logicalSize();
if (logicalSize.isValid())
return logicalSize;
}
return target->pixelSize();
}
void QRhiMetal::setDefaultScissor(QMetalCommandBuffer *cbD)
{
cbD->hasCustomScissorSet = false;
const QSize outputSize = outputSizeForTarget(cbD->currentTarget);
std::array<float, 4> vp = cbD->currentViewport.viewport();
float x = 0, y = 0, w = 0, h = 0;
if (qFuzzyIsNull(vp[2]) && qFuzzyIsNull(vp[3])) {
x = 0;
y = 0;
w = outputSize.width();
h = outputSize.height();
} else {
// x,y is top-left in MTLScissorRect but bottom-left in QRhiScissor
qrhi_toTopLeftRenderTargetRect<Bounded>(outputSize, vp, &x, &y, &w, &h);
}
MTLScissorRect s;
s.x = NSUInteger(x);
s.y = NSUInteger(y);
s.width = NSUInteger(w);
s.height = NSUInteger(h);
[cbD->d->currentRenderPassEncoder setScissorRect: s];
}
void QRhiMetal::setViewport(QRhiCommandBuffer *cb, const QRhiViewport &viewport)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
const QSize outputSize = outputSizeForTarget(cbD->currentTarget);
// x,y is top-left in MTLViewportRect but bottom-left in QRhiViewport
float x, y, w, h;
if (!qrhi_toTopLeftRenderTargetRect<UnBounded>(outputSize, viewport.viewport(), &x, &y, &w, &h))
return;
MTLViewport vp;
vp.originX = double(x);
vp.originY = double(y);
vp.width = double(w);
vp.height = double(h);
vp.znear = double(viewport.minDepth());
vp.zfar = double(viewport.maxDepth());
[cbD->d->currentRenderPassEncoder setViewport: vp];
cbD->currentViewport = viewport;
if (cbD->currentGraphicsPipeline
&& !cbD->currentGraphicsPipeline->m_flags.testFlag(QRhiGraphicsPipeline::UsesScissor))
{
setDefaultScissor(cbD);
}
}
void QRhiMetal::setScissor(QRhiCommandBuffer *cb, const QRhiScissor &scissor)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
Q_ASSERT(!cbD->currentGraphicsPipeline
|| cbD->currentGraphicsPipeline->m_flags.testFlag(QRhiGraphicsPipeline::UsesScissor));
const QSize outputSize = outputSizeForTarget(cbD->currentTarget);
// x,y is top-left in MTLScissorRect but bottom-left in QRhiScissor
int x, y, w, h;
if (!qrhi_toTopLeftRenderTargetRect<Bounded>(outputSize, scissor.scissor(), &x, &y, &w, &h))
return;
MTLScissorRect s;
s.x = NSUInteger(x);
s.y = NSUInteger(y);
s.width = NSUInteger(w);
s.height = NSUInteger(h);
[cbD->d->currentRenderPassEncoder setScissorRect: s];
cbD->hasCustomScissorSet = true;
cbD->currentScissor = scissor;
}
void QRhiMetal::setBlendConstants(QRhiCommandBuffer *cb, const QColor &c)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
[cbD->d->currentRenderPassEncoder setBlendColorRed: c.redF()
green: c.greenF() blue: c.blueF() alpha: c.alphaF()];
cbD->hasBlendConstantsSet = true;
cbD->currentBlendConstants = c;
}
void QRhiMetal::setStencilRef(QRhiCommandBuffer *cb, quint32 refValue)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
[cbD->d->currentRenderPassEncoder setStencilReferenceValue: refValue];
cbD->hasStencilRefSet = true;
cbD->currentStencilRef = refValue;
}
void QRhiMetal::setPushConstants(QRhiCommandBuffer *cb, quint32 offset, quint32 size, const void *data)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass != QMetalCommandBuffer::NoPass);
// setVertexBytes() and friends take the whole block every time, so a shadow
// copy is needed to honour an update of part of it.
auto patch = [cbD, offset, size, data](quint32 blockSize) {
const quint32 total = qMax(blockSize, offset + size);
if (quint32(cbD->pushConstantData.size()) < total)
cbD->pushConstantData.resize(int(total), 0);
memcpy(cbD->pushConstantData.data() + offset, data, size);
return total;
};
if (cbD->recordingPass == QMetalCommandBuffer::ComputePass) {
QMetalComputePipeline *psD = cbD->currentComputePipeline;
if (!psD)
return;
const int idx = mtlPushConstantBufferIndex(psD->d->cs);
if (idx < 0) {
qWarning("No pipeline with a push constant block is active; setPushConstants ignored");
return;
}
const quint32 total = patch(mtlPushConstantBlockSize(psD->d->cs));
[cbD->d->currentComputePassEncoder setBytes: cbD->pushConstantData.constData() length: total atIndex: NSUInteger(idx)];
} else {
QMetalGraphicsPipeline *psD = cbD->currentGraphicsPipeline;
if (!psD)
return;
if (psD->d->tess.enabled) {
qWarning("Push constants are not supported with tessellation on Metal");
return;
}
const int vsIdx = mtlPushConstantBufferIndex(psD->d->vs);
const int fsIdx = mtlPushConstantBufferIndex(psD->d->fs);
if (vsIdx < 0 && fsIdx < 0) {
qWarning("No pipeline with a push constant block is active; setPushConstants ignored");
return;
}
const quint32 total = patch(qMax(mtlPushConstantBlockSize(psD->d->vs), mtlPushConstantBlockSize(psD->d->fs)));
if (vsIdx >= 0)
[cbD->d->currentRenderPassEncoder setVertexBytes: cbD->pushConstantData.constData() length: total atIndex: NSUInteger(vsIdx)];
if (fsIdx >= 0)
[cbD->d->currentRenderPassEncoder setFragmentBytes: cbD->pushConstantData.constData() length: total atIndex: NSUInteger(fsIdx)];
}
}
void QRhiMetal::setShadingRate(QRhiCommandBuffer *cb, const QSize &coarsePixelSize)
{
Q_UNUSED(cb);
Q_UNUSED(coarsePixelSize);
}
static QMetalRenderTargetData *currentRenderTargetData(QMetalCommandBuffer *cbD)
{
switch (cbD->currentTarget->resourceType()) {
case QRhiResource::SwapChainRenderTarget:
return QRHI_RES(QMetalSwapChainRenderTarget, cbD->currentTarget)->d;
case QRhiResource::TextureRenderTarget:
return QRHI_RES(QMetalTextureRenderTarget, cbD->currentTarget)->d;
default:
return nullptr;
}
}
// Memoryless attachments only exist for the duration of a single encoder, there
// is nowhere to store them to.
static inline bool canStoreAttachment(id<MTLTexture> tex)
{
return tex && tex.storageMode != MTLStorageModeMemoryless;
}
// When the pass continues on a new encoder afterwards, the contents have to be
// stored, not just resolved or discarded. An attachment with a resolve texture
// can only use the resolving store actions.
static inline MTLStoreAction interruptionStoreAction(MTLStoreAction finalAction, bool passIsEnding)
{
if (passIsEnding)
return finalAction;
return finalAction == MTLStoreActionDontCare ? MTLStoreActionStore
: MTLStoreActionStoreAndMultisampleResolve;
}
// Store actions are deferred (MTLStoreActionUnknown) for attachments whose
// contents may need to outlive the encoder, so they have to be finalized before
// the encoder ends.
// Store actions cannot be mutated otherwise, and for a resolve attachment the
// only legal choices are the two resolving ones.
void QRhiMetal::finalizeDeferredStoreActions(QMetalCommandBuffer *cbD, bool passIsEnding)
{
for (const auto &[index, finalAction] : std::as_const(cbD->d->deferredColorStoreActions))
[cbD->d->currentRenderPassEncoder setColorStoreAction:
interruptionStoreAction(finalAction, passIsEnding) atIndex: index];
if (cbD->d->deferredDepthStoreAction != MTLStoreActionUnknown) {
[cbD->d->currentRenderPassEncoder setDepthStoreAction:
interruptionStoreAction(cbD->d->deferredDepthStoreAction, passIsEnding)];
}
if (cbD->d->deferredStencilStoreAction != MTLStoreActionUnknown) {
[cbD->d->currentRenderPassEncoder setStencilStoreAction:
interruptionStoreAction(cbD->d->deferredStencilStoreAction, passIsEnding)];
}
}
// Ends the render command encoder such that the pass can be continued on a new
// encoder afterwards.
void QRhiMetal::interruptRenderPass(QMetalCommandBuffer *cbD)
{
finalizeDeferredStoreActions(cbD, false);
for (qsizetype i = 0; i < cbD->d->openDebugGroups.size(); ++i)
[cbD->d->currentRenderPassEncoder popDebugGroup];
[cbD->d->currentRenderPassEncoder endEncoding];
cbD->d->currentRenderPassEncoder = nil;
}
static id<MTLComputeCommandEncoder>
tempComputeEncoder(QRhiMetal *rhiD, QMetalCommandBuffer *cbD,
id<MTLComputeCommandEncoder> maybeComputeEncoder)
{
if (cbD->d->currentRenderPassEncoder)
rhiD->interruptRenderPass(cbD);
if (!maybeComputeEncoder)
maybeComputeEncoder = [cbD->d->cb computeCommandEncoder];
return maybeComputeEncoder;
}
static void endTempComputeEncoding(QRhiMetal *rhiD, QMetalCommandBuffer *cbD,
id<MTLComputeCommandEncoder> computeEncoder)
{
if (computeEncoder) {
[computeEncoder endEncoding];
computeEncoder = nil;
}
QMetalRenderTargetData *rtD = currentRenderTargetData(cbD);
Q_ASSERT(rtD);
// A memoryless attachment cannot be loaded, its contents are lost (see
// NoTransientBacking), even when the store action is not DontCare, which is
// the case with a resolve.
const auto canLoad = [](MTLRenderPassAttachmentDescriptor *att) {
return att.storeAction != MTLStoreActionDontCare && canStoreAttachment(att.texture);
};
QVarLengthArray<MTLLoadAction, 4> oldColorLoad;
for (uint i = 0; i < uint(rtD->colorAttCount); ++i) {
oldColorLoad.append(cbD->d->currentPassRpDesc.colorAttachments[i].loadAction);
if (canLoad(cbD->d->currentPassRpDesc.colorAttachments[i]))
cbD->d->currentPassRpDesc.colorAttachments[i].loadAction = MTLLoadActionLoad;
}
MTLLoadAction oldDepthLoad;
MTLLoadAction oldStencilLoad;
if (rtD->dsAttCount) {
oldDepthLoad = cbD->d->currentPassRpDesc.depthAttachment.loadAction;
if (canLoad(cbD->d->currentPassRpDesc.depthAttachment))
cbD->d->currentPassRpDesc.depthAttachment.loadAction = MTLLoadActionLoad;
oldStencilLoad = cbD->d->currentPassRpDesc.stencilAttachment.loadAction;
if (canLoad(cbD->d->currentPassRpDesc.stencilAttachment))
cbD->d->currentPassRpDesc.stencilAttachment.loadAction = MTLLoadActionLoad;
}
// The state below is not tied to the pipeline, so it is not restored by the
// callers when they reactivate it on the new encoder. Preserve it here,
// otherwise the pass would silently continue with a full-target viewport,
// no scissor, and default blend constants and stencil reference.
const QRhiViewport prevViewport = cbD->currentViewport;
const bool prevHasScissor = cbD->hasCustomScissorSet;
const QRhiScissor prevScissor = cbD->currentScissor;
const bool prevHasBlendConstants = cbD->hasBlendConstantsSet;
const QColor prevBlendConstants = cbD->currentBlendConstants;
const bool prevHasStencilRef = cbD->hasStencilRefSet;
const quint32 prevStencilRef = cbD->currentStencilRef;
// Whether the pipeline was relying on the viewport-derived default scissor,
// which setViewport() below cannot reapply on its own: it only does so when
// a pipeline is already current, and there is none at that point.
const bool prevHasDefaultScissor = cbD->currentGraphicsPipeline
&& !cbD->currentGraphicsPipeline->flags().testFlag(QRhiGraphicsPipeline::UsesScissor);
// Rebound when the callers reactivate the pipeline, or when the next
// pipeline with a push constant block is set.
const QVarLengthArray<char, 128> prevPushConstantData = cbD->pushConstantData;
cbD->d->currentRenderPassEncoder = [cbD->d->cb renderCommandEncoderWithDescriptor: cbD->d->currentPassRpDesc];
cbD->resetPerPassCachedState();
for (const QByteArray &name : std::as_const(cbD->d->openDebugGroups))
[cbD->d->currentRenderPassEncoder pushDebugGroup: [NSString stringWithUTF8String: name.constData()]];
cbD->pushConstantData = prevPushConstantData;
cbD->pushConstantsNeedRebind = !prevPushConstantData.isEmpty();
// Must come before the callers reactivate the pipeline: setScissor()
// expects no pipeline to be current yet, and setDefaultScissor() consults
// the viewport.
if (!qFuzzyIsNull(prevViewport.viewport()[2]) || !qFuzzyIsNull(prevViewport.viewport()[3]))
rhiD->setViewport(cbD, prevViewport);
if (prevHasScissor)
rhiD->setScissor(cbD, prevScissor);
else if (prevHasDefaultScissor)
rhiD->setDefaultScissor(cbD);
if (prevHasBlendConstants)
rhiD->setBlendConstants(cbD, prevBlendConstants);
if (prevHasStencilRef)
rhiD->setStencilRef(cbD, prevStencilRef);
for (uint i = 0; i < uint(rtD->colorAttCount); ++i) {
cbD->d->currentPassRpDesc.colorAttachments[i].loadAction = oldColorLoad[i];
}
if (rtD->dsAttCount) {
cbD->d->currentPassRpDesc.depthAttachment.loadAction = oldDepthLoad;
cbD->d->currentPassRpDesc.stencilAttachment.loadAction = oldStencilLoad;
}
}
void QRhiMetal::tessellatedDraw(const TessDrawArgs &args)
{
QMetalCommandBuffer *cbD = args.cbD;
QMetalGraphicsPipeline *graphicsPipeline = cbD->currentGraphicsPipeline;
if (graphicsPipeline->d->tess.failed)
return;
const bool indexed = args.type != TessDrawArgs::NonIndexed;
const quint32 instanceCount = indexed ? args.drawIndexed.instanceCount : args.draw.instanceCount;
const quint32 vertexOrIndexCount = indexed ? args.drawIndexed.indexCount : args.draw.vertexCount;
QMetalGraphicsPipelineData::Tessellation &tess(graphicsPipeline->d->tess);
QMetalGraphicsPipelineData::ExtraBufferManager &extraBufMgr(graphicsPipeline->d->extraBufMgr);
const quint32 patchCount = tess.patchCountForDrawCall(vertexOrIndexCount, instanceCount);
QMetalBuffer *vertOutBuf = nullptr;
QMetalBuffer *tescOutBuf = nullptr;
QMetalBuffer *tescPatchOutBuf = nullptr;
QMetalBuffer *tescFactorBuf = nullptr;
QMetalBuffer *tescParamsBuf = nullptr;
id<MTLComputeCommandEncoder> vertTescComputeEncoder
= tempComputeEncoder(this, cbD, cbD->d->tessellationComputeEncoder);
cbD->d->tessellationComputeEncoder = vertTescComputeEncoder;
// Step 1: vertex shader (as compute)
{
id<MTLComputeCommandEncoder> computeEncoder = vertTescComputeEncoder;
QShader::Variant shaderVariant = QShader::NonIndexedVertexAsComputeShader;
if (args.type == TessDrawArgs::U16Indexed)
shaderVariant = QShader::UInt16IndexedVertexAsComputeShader;
else if (args.type == TessDrawArgs::U32Indexed)
shaderVariant = QShader::UInt32IndexedVertexAsComputeShader;
const int varIndex = QMetalGraphicsPipelineData::Tessellation::vsCompVariantToIndex(shaderVariant);
id<MTLComputePipelineState> computePipelineState = tess.vsCompPipeline(this, shaderVariant);
[computeEncoder setComputePipelineState: computePipelineState];
// Make uniform buffers, textures, and samplers (meant for the
// vertex stage from the client's point of view) visible in the
// "vertex as compute" shader
cbD->d->currentComputePassEncoder = computeEncoder;
rebindShaderResources(cbD, QMetalShaderResourceBindingsData::VERTEX, QMetalShaderResourceBindingsData::COMPUTE);
cbD->d->currentComputePassEncoder = nil;
const QMap<int, int> &ebb(tess.compVs[varIndex].nativeShaderInfo.extraBufferBindings);
const int outputBufferBinding = ebb.value(QShaderPrivate::MslTessVertTescOutputBufferBinding, -1);
const int indexBufferBinding = ebb.value(QShaderPrivate::MslTessVertIndicesBufferBinding, -1);
if (outputBufferBinding >= 0) {
const quint32 workBufSize = tess.vsCompOutputBufferSize(vertexOrIndexCount, instanceCount);
vertOutBuf = extraBufMgr.acquireWorkBuffer(this, workBufSize);
if (!vertOutBuf)
return;
[computeEncoder setBuffer: vertOutBuf->d->buf[0] offset: 0 atIndex: outputBufferBinding];
}
if (indexBufferBinding >= 0)
[computeEncoder setBuffer: (id<MTLBuffer>) args.drawIndexed.indexBuffer offset: 0 atIndex: indexBufferBinding];
for (int i = 0, ie = cbD->d->currentVertexInputsBuffers.batches.count(); i != ie; ++i) {
const auto &bufferBatch(cbD->d->currentVertexInputsBuffers.batches[i]);
const auto &offsetBatch(cbD->d->currentVertexInputOffsets.batches[i]);
[computeEncoder setBuffers: bufferBatch.resources.constData()
offsets: offsetBatch.resources.constData()
withRange: NSMakeRange(uint(cbD->d->currentFirstVertexBinding) + bufferBatch.startBinding, NSUInteger(bufferBatch.resources.count()))];
}
if (indexed) {
[computeEncoder setStageInRegion: MTLRegionMake2D(args.drawIndexed.vertexOffset, args.drawIndexed.firstInstance,
args.drawIndexed.indexCount, args.drawIndexed.instanceCount)];
} else {
[computeEncoder setStageInRegion: MTLRegionMake2D(args.draw.firstVertex, args.draw.firstInstance,
args.draw.vertexCount, args.draw.instanceCount)];
}
[computeEncoder dispatchThreads: MTLSizeMake(vertexOrIndexCount, instanceCount, 1)
threadsPerThreadgroup: MTLSizeMake(computePipelineState.threadExecutionWidth, 1, 1)];
}
// Step 2: tessellation control shader (as compute)
{
id<MTLComputeCommandEncoder> computeEncoder = vertTescComputeEncoder;
id<MTLComputePipelineState> computePipelineState = tess.tescCompPipeline(this);
[computeEncoder setComputePipelineState: computePipelineState];
cbD->d->currentComputePassEncoder = computeEncoder;
rebindShaderResources(cbD, QMetalShaderResourceBindingsData::TESSCTRL, QMetalShaderResourceBindingsData::COMPUTE);
cbD->d->currentComputePassEncoder = nil;
const QMap<int, int> &ebb(tess.compTesc.nativeShaderInfo.extraBufferBindings);
const int outputBufferBinding = ebb.value(QShaderPrivate::MslTessVertTescOutputBufferBinding, -1);
const int patchOutputBufferBinding = ebb.value(QShaderPrivate::MslTessTescPatchOutputBufferBinding, -1);
const int tessFactorBufferBinding = ebb.value(QShaderPrivate::MslTessTescTessLevelBufferBinding, -1);
const int paramsBufferBinding = ebb.value(QShaderPrivate::MslTessTescParamsBufferBinding, -1);
const int inputBufferBinding = ebb.value(QShaderPrivate::MslTessTescInputBufferBinding, -1);
if (outputBufferBinding >= 0) {
const quint32 workBufSize = tess.tescCompOutputBufferSize(patchCount);
tescOutBuf = extraBufMgr.acquireWorkBuffer(this, workBufSize);
if (!tescOutBuf)
return;
[computeEncoder setBuffer: tescOutBuf->d->buf[0] offset: 0 atIndex: outputBufferBinding];
}
if (patchOutputBufferBinding >= 0) {
const quint32 workBufSize = tess.tescCompPatchOutputBufferSize(patchCount);
tescPatchOutBuf = extraBufMgr.acquireWorkBuffer(this, workBufSize);
if (!tescPatchOutBuf)
return;
[computeEncoder setBuffer: tescPatchOutBuf->d->buf[0] offset: 0 atIndex: patchOutputBufferBinding];
}
if (tessFactorBufferBinding >= 0) {
tescFactorBuf = extraBufMgr.acquireWorkBuffer(this, patchCount * sizeof(MTLQuadTessellationFactorsHalf));
[computeEncoder setBuffer: tescFactorBuf->d->buf[0] offset: 0 atIndex: tessFactorBufferBinding];
}
if (paramsBufferBinding >= 0) {
struct {
quint32 inControlPointCount;
quint32 patchCount;
} params;
tescParamsBuf = extraBufMgr.acquireWorkBuffer(this, sizeof(params), QMetalGraphicsPipelineData::ExtraBufferManager::WorkBufType::HostVisible);
if (!tescParamsBuf)
return;
params.inControlPointCount = tess.inControlPointCount;
params.patchCount = patchCount;
id<MTLBuffer> paramsBuf = tescParamsBuf->d->buf[0];
char *p = reinterpret_cast<char *>([paramsBuf contents]);
memcpy(p, &params, sizeof(params));
[computeEncoder setBuffer: paramsBuf offset: 0 atIndex: paramsBufferBinding];
}
if (vertOutBuf && inputBufferBinding >= 0)
[computeEncoder setBuffer: vertOutBuf->d->buf[0] offset: 0 atIndex: inputBufferBinding];
int sgSize = int(computePipelineState.threadExecutionWidth);
int wgSize = std::lcm(tess.outControlPointCount, sgSize);
while (wgSize > caps.maxThreadGroupSize) {
sgSize /= 2;
wgSize = std::lcm(tess.outControlPointCount, sgSize);
}
[computeEncoder dispatchThreads: MTLSizeMake(patchCount * tess.outControlPointCount, 1, 1)
threadsPerThreadgroup: MTLSizeMake(wgSize, 1, 1)];
}
// Much of the state in the QMetalCommandBuffer is going to be reset
// when we get a new render encoder. Save what we need. (cheaper than
// starting to walk over the srb again)
const QMetalShaderResourceBindingsData resourceBindings = cbD->d->currentShaderResourceBindingState;
endTempComputeEncoding(this, cbD, cbD->d->tessellationComputeEncoder);
cbD->d->tessellationComputeEncoder = nil;
// Step 3: tessellation evaluation (as vertex) + fragment shader
{
// No need to call tess.teseFragRenderPipeline because it was done
// once and we know the result is stored in the standard place
// (graphicsPipeline->d->ps).
graphicsPipeline->makeActiveForCurrentRenderPassEncoder(cbD);
id<MTLRenderCommandEncoder> renderEncoder = cbD->d->currentRenderPassEncoder;
rebindShaderResources(cbD, QMetalShaderResourceBindingsData::TESSEVAL, QMetalShaderResourceBindingsData::VERTEX, &resourceBindings);
rebindShaderResources(cbD, QMetalShaderResourceBindingsData::FRAGMENT, QMetalShaderResourceBindingsData::FRAGMENT, &resourceBindings);
const QMap<int, int> &ebb(tess.compTesc.nativeShaderInfo.extraBufferBindings);
const int outputBufferBinding = ebb.value(QShaderPrivate::MslTessVertTescOutputBufferBinding, -1);
const int patchOutputBufferBinding = ebb.value(QShaderPrivate::MslTessTescPatchOutputBufferBinding, -1);
const int tessFactorBufferBinding = ebb.value(QShaderPrivate::MslTessTescTessLevelBufferBinding, -1);
if (outputBufferBinding >= 0 && tescOutBuf)
[renderEncoder setVertexBuffer: tescOutBuf->d->buf[0] offset: 0 atIndex: outputBufferBinding];
if (patchOutputBufferBinding >= 0 && tescPatchOutBuf)
[renderEncoder setVertexBuffer: tescPatchOutBuf->d->buf[0] offset: 0 atIndex: patchOutputBufferBinding];
if (tessFactorBufferBinding >= 0 && tescFactorBuf) {
[renderEncoder setTessellationFactorBuffer: tescFactorBuf->d->buf[0] offset: 0 instanceStride: 0];
[renderEncoder setVertexBuffer: tescFactorBuf->d->buf[0] offset: 0 atIndex: tessFactorBufferBinding];
}
[cbD->d->currentRenderPassEncoder drawPatches: tess.outControlPointCount
patchStart: 0
patchCount: patchCount
patchIndexBuffer: nil
patchIndexBufferOffset: 0
instanceCount: 1
baseInstance: 0];
}
}
void QRhiMetal::adjustForMultiViewDraw(quint32 *instanceCount, QRhiCommandBuffer *cb)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
const int multiViewCount = cbD->currentGraphicsPipeline->m_multiViewCount;
if (multiViewCount <= 1)
return;
const QMap<int, int> &ebb(cbD->currentGraphicsPipeline->d->vs.nativeShaderInfo.extraBufferBindings);
const int viewMaskBufBinding = ebb.value(QShaderPrivate::MslMultiViewMaskBufferBinding, -1);
if (viewMaskBufBinding == -1) {
qWarning("No extra buffer for multiview in the vertex shader; was it built with --view-count specified?");
return;
}
struct {
quint32 viewOffset;
quint32 viewCount;
} multiViewInfo;
multiViewInfo.viewOffset = 0;
multiViewInfo.viewCount = quint32(multiViewCount);
QMetalBuffer *buf = cbD->currentGraphicsPipeline->d->extraBufMgr.acquireWorkBuffer(this, sizeof(multiViewInfo),
QMetalGraphicsPipelineData::ExtraBufferManager::WorkBufType::HostVisible);
if (buf) {
id<MTLBuffer> mtlbuf = buf->d->buf[0];
char *p = reinterpret_cast<char *>([mtlbuf contents]);
memcpy(p, &multiViewInfo, sizeof(multiViewInfo));
[cbD->d->currentRenderPassEncoder setVertexBuffer: mtlbuf offset: 0 atIndex: viewMaskBufBinding];
// The instance count is adjusted for layered rendering. The vertex shader is expected to contain something like:
// uint gl_ViewIndex = spvViewMask[0] + (gl_InstanceIndex - gl_BaseInstance) % spvViewMask[1];
// where spvViewMask is the buffer with multiViewInfo passed in above.
*instanceCount *= multiViewCount;
}
}
void QRhiMetal::draw(QRhiCommandBuffer *cb, quint32 vertexCount,
quint32 instanceCount, quint32 firstVertex, quint32 firstInstance)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
if (cbD->currentGraphicsPipeline->d->tess.enabled) {
TessDrawArgs a;
a.cbD = cbD;
a.type = TessDrawArgs::NonIndexed;
a.draw.vertexCount = vertexCount;
a.draw.instanceCount = instanceCount;
a.draw.firstVertex = firstVertex;
a.draw.firstInstance = firstInstance;
tessellatedDraw(a);
return;
}
adjustForMultiViewDraw(&instanceCount, cb);
if (caps.baseVertexAndInstance) {
[cbD->d->currentRenderPassEncoder drawPrimitives: cbD->currentGraphicsPipeline->d->primitiveType
vertexStart: firstVertex vertexCount: vertexCount instanceCount: instanceCount baseInstance: firstInstance];
} else {
[cbD->d->currentRenderPassEncoder drawPrimitives: cbD->currentGraphicsPipeline->d->primitiveType
vertexStart: firstVertex vertexCount: vertexCount instanceCount: instanceCount];
}
}
void QRhiMetal::drawIndexed(QRhiCommandBuffer *cb, quint32 indexCount,
quint32 instanceCount, quint32 firstIndex, qint32 vertexOffset, quint32 firstInstance)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
if (!cbD->currentIndexBuffer)
return;
const quint32 indexOffset = cbD->currentIndexOffset + firstIndex * (cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16 ? 2 : 4);
Q_ASSERT(indexOffset == aligned(indexOffset, 4u));
QMetalBuffer *ibufD = cbD->currentIndexBuffer;
id<MTLBuffer> mtlibuf = ibufD->d->buf[ibufD->d->slotted ? currentFrameSlot : 0];
if (cbD->currentGraphicsPipeline->d->tess.enabled) {
TessDrawArgs a;
a.cbD = cbD;
a.type = cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16 ? TessDrawArgs::U16Indexed : TessDrawArgs::U32Indexed;
a.drawIndexed.indexCount = indexCount;
a.drawIndexed.instanceCount = instanceCount;
a.drawIndexed.firstIndex = firstIndex;
a.drawIndexed.vertexOffset = vertexOffset;
a.drawIndexed.firstInstance = firstInstance;
a.drawIndexed.indexBuffer = mtlibuf;
tessellatedDraw(a);
return;
}
adjustForMultiViewDraw(&instanceCount, cb);
if (caps.baseVertexAndInstance) {
[cbD->d->currentRenderPassEncoder drawIndexedPrimitives: cbD->currentGraphicsPipeline->d->primitiveType
indexCount: indexCount
indexType: cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16 ? MTLIndexTypeUInt16 : MTLIndexTypeUInt32
indexBuffer: mtlibuf
indexBufferOffset: indexOffset
instanceCount: instanceCount
baseVertex: vertexOffset
baseInstance: firstInstance];
} else {
[cbD->d->currentRenderPassEncoder drawIndexedPrimitives: cbD->currentGraphicsPipeline->d->primitiveType
indexCount: indexCount
indexType: cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16 ? MTLIndexTypeUInt16 : MTLIndexTypeUInt32
indexBuffer: mtlibuf
indexBufferOffset: indexOffset
instanceCount: instanceCount];
}
}
// Returns null when the ICB path is usable, otherwise the reason why not.
const char *QRhiMetal::icbUnavailableReason(QMetalCommandBuffer *cbD) const
{
if (!caps.indirectCommandBuffers)
return "indirect command buffers are not supported on this device";
if (!cbD->currentGraphicsPipeline
|| !cbD->currentGraphicsPipeline->m_flags.testFlag(QRhiGraphicsPipeline::UsesIndirectDraws))
{
return "the current graphics pipeline was not created with UsesIndirectDraws";
}
if (cbD->currentGraphicsPipeline->d->tess.enabled)
return "the current graphics pipeline uses tessellation";
if (!cbD->currentGraphicsPipeline->d->icbCapable) {
return "the shaders of the current graphics pipeline sample textures but have no "
"argument buffer variant, which Metal requires for a pipeline that supports "
"indirect command buffers; rebuild them with qsb --msl-argument-buffers "
"(or use MSLARGUMENTBUFFERS with qt_add_shaders)";
}
return nullptr;
}
bool QRhiMetal::prepareIcbKernels()
{
if (d->icbSetupFailed)
return false;
if (!d->icbEncodePipeline) {
NSError *err = nil;
NSString *src = [NSString stringWithUTF8String:s_icbEncodeMsl];
MTLCompileOptions *opts = [MTLCompileOptions new];
opts.languageVersion = MTLLanguageVersion2_1;
id<MTLLibrary> lib = [d->dev newLibraryWithSource:src options:opts error:&err];
[opts release];
if (!lib) {
qWarning("Failed to compile ICB encode kernel: %s",
qPrintable(QString::fromNSString(err.localizedDescription)));
d->icbSetupFailed = true;
return false;
}
d->icbEncodeFunction = [lib newFunctionWithName:@"encode_icb"];
d->icbEncodeFunctionU32 = [lib newFunctionWithName:@"encode_icb_indexed_u32"];
d->icbEncodeFunctionU16 = [lib newFunctionWithName:@"encode_icb_indexed_u16"];
[lib release];
if (!d->icbEncodeFunction || !d->icbEncodeFunctionU32 || !d->icbEncodeFunctionU16) {
qWarning("ICB encode kernel functions not found");
d->icbSetupFailed = true;
return false;
}
NSError *errU32 = nil;
NSError *errU16 = nil;
d->icbEncodePipeline = [d->dev newComputePipelineStateWithFunction:d->icbEncodeFunction error:&err];
d->icbEncodePipelineU32 = [d->dev newComputePipelineStateWithFunction:d->icbEncodeFunctionU32 error:&errU32];
d->icbEncodePipelineU16 = [d->dev newComputePipelineStateWithFunction:d->icbEncodeFunctionU16 error:&errU16];
if (!d->icbEncodePipeline || !d->icbEncodePipelineU32 || !d->icbEncodePipelineU16) {
NSError *firstErr = !d->icbEncodePipeline ? err
: (!d->icbEncodePipelineU32 ? errU32 : errU16);
qWarning("Failed to create ICB encode compute pipeline: %s",
qPrintable(QString::fromNSString(firstErr.localizedDescription)));
d->icbSetupFailed = true;
return false;
}
}
if (!d->icbRangeBuffer) {
d->icbRangeBuffer = [d->dev newBufferWithLength:sizeof(MTLIndirectCommandBufferExecutionRange)
options:MTLResourceStorageModePrivate];
static constexpr quint32 noCount = 0xFFFFFFFFu;
d->icbNoCountBuffer = [d->dev newBufferWithBytes:&noCount
length:sizeof(noCount)
options:MTLResourceStorageModeShared];
if (!d->icbRangeBuffer || !d->icbNoCountBuffer) {
qWarning("Failed to create ICB helper buffers");
d->icbSetupFailed = true;
return false;
}
}
return true;
}
bool QRhiMetal::prepareIcb(quint32 maxDrawCount)
{
if (!prepareIcbKernels())
return false;
if (!d->icb || d->icbCapacity < maxDrawCount) {
if (d->icb) {
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingIcbBuffer;
e.lastActiveFrameSlot = currentFrameSlot;
e.stagingIcbBuffer.icb = d->icb;
e.stagingIcbBuffer.argBuffer = d->icbArgumentBuffer;
d->releaseQueue.append(e);
}
d->icb = nil;
d->icbArgumentBuffer = nil;
MTLIndirectCommandBufferDescriptor *icbDesc = [MTLIndirectCommandBufferDescriptor new];
icbDesc.commandTypes = MTLIndirectCommandTypeDraw | MTLIndirectCommandTypeDrawIndexed;
icbDesc.inheritPipelineState = YES;
icbDesc.inheritBuffers = YES;
icbDesc.maxVertexBufferBindCount = 0;
icbDesc.maxFragmentBufferBindCount = 0;
d->icb = [d->dev newIndirectCommandBufferWithDescriptor:icbDesc
maxCommandCount:maxDrawCount
options:MTLResourceStorageModePrivate];
[icbDesc release];
if (!d->icb) {
qWarning("Failed to create MTLIndirectCommandBuffer");
d->icbCapacity = 0;
return false;
}
d->icbCapacity = maxDrawCount;
id<MTLArgumentEncoder> argEnc = [d->icbEncodeFunction newArgumentEncoderWithBufferIndex:1];
d->icbArgumentBuffer = [d->dev newBufferWithLength:argEnc.encodedLength
options:MTLResourceStorageModeShared];
[argEnc setArgumentBuffer:d->icbArgumentBuffer offset:0];
[argEnc setIndirectCommandBuffer:d->icb atIndex:0];
[argEnc release];
}
return true;
}
// Encodes maxDrawCount entries of indirectBufMtl into targetIcb on an already
// open compute encoder, writing the encoded count to targetRangeBuffer.
// countBufMtl is optional: when null all maxDrawCount commands are encoded.
static void encodeIcbWithCompute(QRhiMetalData *d,
id<MTLComputeCommandEncoder> computeEncoder,
id<MTLIndirectCommandBuffer> targetIcb,
id<MTLBuffer> targetArgBuffer,
id<MTLBuffer> targetRangeBuffer,
bool indexed,
QRhiCommandBuffer::IndexFormat indexFormat,
MTLPrimitiveType primitiveType,
id<MTLBuffer> indirectBufMtl, quint32 indirectBufferOffset,
id<MTLBuffer> indexBufMtl, quint32 indexBufferOffset,
id<MTLBuffer> countBufMtl, quint32 countBufferOffset,
quint32 maxDrawCount, quint32 stride)
{
id<MTLComputePipelineState> computePipeline = d->icbEncodePipeline;
if (indexed) {
computePipeline = indexFormat == QRhiCommandBuffer::IndexUInt16
? d->icbEncodePipelineU16 : d->icbEncodePipelineU32;
}
uint32_t maxDrawCountVal = maxDrawCount;
uint32_t metalPrimType = uint32_t(primitiveType);
uint32_t strideVal = stride;
[computeEncoder setComputePipelineState:computePipeline];
[computeEncoder setBuffer:indirectBufMtl offset:indirectBufferOffset atIndex:0];
[computeEncoder setBuffer:targetArgBuffer offset:0 atIndex:1];
[computeEncoder setBytes:&maxDrawCountVal length:sizeof(uint32_t) atIndex:2];
if (indexed)
[computeEncoder setBuffer:indexBufMtl offset:indexBufferOffset atIndex:3];
[computeEncoder setBytes:&metalPrimType length:sizeof(uint32_t) atIndex:4];
[computeEncoder setBytes:&strideVal length:sizeof(uint32_t) atIndex:5];
[computeEncoder setBuffer:countBufMtl ? countBufMtl : d->icbNoCountBuffer
offset:countBufMtl ? countBufferOffset : 0
atIndex:6];
[computeEncoder setBuffer:targetRangeBuffer offset:0 atIndex:7];
[computeEncoder useResource:targetIcb usage:MTLResourceUsageWrite];
[computeEncoder useResource:indirectBufMtl usage:MTLResourceUsageRead];
if (indexed)
[computeEncoder useResource:indexBufMtl usage:MTLResourceUsageRead];
NSUInteger tw = computePipeline.threadExecutionWidth;
[computeEncoder dispatchThreads:MTLSizeMake(maxDrawCount, 1, 1)
threadsPerThreadgroup:MTLSizeMake(tw, 1, 1)];
}
// Encodes up to maxDrawCount commands into the shared ICB with a compute
// dispatch, then executes them on the render encoder. countBufMtl is optional:
// when null, all maxDrawCount commands are executed, otherwise the number of
// draws is min(maxDrawCount, <uint32 at countBufferOffset>), computed on the
// GPU. Returns false when the ICB could not be set up, in which case nothing
// was recorded and the pass is left untouched.
bool QRhiMetal::icbDraw(QMetalCommandBuffer *cbD, bool indexed,
QMetalBuffer *indirectBufD, quint32 indirectBufferOffset,
QMetalBuffer *countBufD, quint32 countBufferOffset,
quint32 maxDrawCount, quint32 stride)
{
if (!maxDrawCount)
return true;
QMetalBuffer *indexBufD = cbD->currentIndexBuffer;
if (indexed && !indexBufD)
return false;
if (!prepareIcb(maxDrawCount))
return false;
executeBufferHostWritesForCurrentFrame(indirectBufD);
indirectBufD->lastActiveFrameSlot = currentFrameSlot;
id<MTLBuffer> indirectBufMtl = indirectBufD->d->buf[indirectBufD->d->slotted ? currentFrameSlot : 0];
id<MTLBuffer> countBufMtl = nil;
if (countBufD) {
executeBufferHostWritesForCurrentFrame(countBufD);
countBufD->lastActiveFrameSlot = currentFrameSlot;
countBufMtl = countBufD->d->buf[countBufD->d->slotted ? currentFrameSlot : 0];
}
// Everything below survives the interruption only if saved and restored.
QMetalGraphicsPipeline *savedPipeline = cbD->currentGraphicsPipeline;
const QMetalShaderResourceBindingsData savedResourceBindings = cbD->d->currentShaderResourceBindingState;
const int savedFirstVertexBinding = cbD->d->currentFirstVertexBinding;
const auto savedVertexBuffers = cbD->d->currentVertexInputsBuffers;
const auto savedVertexOffsets = cbD->d->currentVertexInputOffsets;
const quint32 savedIndexOffset = cbD->currentIndexOffset;
const QRhiCommandBuffer::IndexFormat savedIndexFormat = cbD->currentIndexFormat;
id<MTLBuffer> indexBufMtl = indexed
? indexBufD->d->buf[indexBufD->d->slotted ? currentFrameSlot : 0] : nil;
// End the current render encoder to make room for the compute pass.
interruptRenderPass(cbD);
id<MTLComputeCommandEncoder> computeEncoder = [cbD->d->cb computeCommandEncoder];
encodeIcbWithCompute(d, computeEncoder, d->icb, d->icbArgumentBuffer, d->icbRangeBuffer,
indexed, savedIndexFormat, savedPipeline->d->primitiveType,
indirectBufMtl, indirectBufferOffset,
indexBufMtl, savedIndexOffset,
countBufMtl, countBufferOffset,
maxDrawCount, stride);
// Restart the render pass with Load actions to preserve existing content.
endTempComputeEncoding(this, cbD, computeEncoder);
// Restore pipeline, shader resources, and vertex bindings on the new encoder.
savedPipeline->makeActiveForCurrentRenderPassEncoder(cbD);
rebindShaderResources(cbD, QMetalShaderResourceBindingsData::VERTEX,
QMetalShaderResourceBindingsData::VERTEX, &savedResourceBindings);
rebindShaderResources(cbD, QMetalShaderResourceBindingsData::FRAGMENT,
QMetalShaderResourceBindingsData::FRAGMENT, &savedResourceBindings);
if (savedFirstVertexBinding >= 0) {
cbD->d->currentFirstVertexBinding = savedFirstVertexBinding;
cbD->d->currentVertexInputsBuffers = savedVertexBuffers;
cbD->d->currentVertexInputOffsets = savedVertexOffsets;
for (int i = 0, ie = savedVertexBuffers.batches.count(); i != ie; ++i) {
const auto &bufferBatch(savedVertexBuffers.batches[i]);
const auto &offsetBatch(savedVertexOffsets.batches[i]);
[cbD->d->currentRenderPassEncoder setVertexBuffers:
bufferBatch.resources.constData()
offsets: offsetBatch.resources.constData()
withRange: NSMakeRange(uint(savedFirstVertexBinding) + bufferBatch.startBinding,
NSUInteger(bufferBatch.resources.count()))];
}
}
cbD->currentIndexBuffer = indexBufD;
cbD->currentIndexOffset = savedIndexOffset;
cbD->currentIndexFormat = savedIndexFormat;
// Declare buffer dependencies and execute the GPU-encoded ICB. The range to
// execute is read from icbRangeBuffer, which the kernel just wrote.
[cbD->d->currentRenderPassEncoder useResource:indirectBufMtl
usage:MTLResourceUsageRead
stages:MTLRenderStageVertex | MTLRenderStageFragment];
if (indexed) {
[cbD->d->currentRenderPassEncoder useResource:indexBufMtl
usage:MTLResourceUsageRead
stages:MTLRenderStageVertex | MTLRenderStageFragment];
}
[cbD->d->currentRenderPassEncoder executeCommandsInBuffer:d->icb
indirectBuffer:d->icbRangeBuffer
indirectBufferOffset:0];
return true;
}
// The ICB (Indirect Command Buffer) path encodes the draw commands on the GPU
// and executes them with a single executeCommandsInBuffer, which removes the
// per-draw CPU overhead. The encoding needs a compute pass, so the render pass
// has to be interrupted and restarted: that costs about 100-150 microseconds,
// whereas an individual indirect draw call takes 1-2. Hence only taking this
// path for large batches.
static constexpr quint32 ICB_DRAW_COUNT_THRESHOLD = 128;
void QRhiMetal::drawIndirect(QRhiCommandBuffer *cb, QRhiBuffer *indirectBuffer,
quint32 indirectBufferOffset, quint32 drawCount, quint32 stride)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
QMetalBuffer *indirectBufD = QRHI_RES(QMetalBuffer, indirectBuffer);
executeBufferHostWritesForCurrentFrame(indirectBufD);
indirectBufD->lastActiveFrameSlot = currentFrameSlot;
id<MTLBuffer> indirectBufMtl = indirectBufD->d->buf[indirectBufD->d->slotted ? currentFrameSlot : 0];
if (drawCount > ICB_DRAW_COUNT_THRESHOLD && !icbUnavailableReason(cbD)
&& icbDraw(cbD, false, indirectBufD, indirectBufferOffset, nullptr, 0, drawCount, stride))
{
return;
}
// CPU-side for-loop fallback: used when ICB is not applicable or setup failed.
NSUInteger offset = indirectBufferOffset;
for (quint32 i = 0; i < drawCount; ++i) {
[cbD->d->currentRenderPassEncoder drawPrimitives: cbD->currentGraphicsPipeline->d->primitiveType
indirectBuffer: indirectBufMtl
indirectBufferOffset: offset];
offset += stride;
}
}
void QRhiMetal::drawIndexedIndirect(QRhiCommandBuffer *cb, QRhiBuffer *indirectBuffer,
quint32 indirectBufferOffset, quint32 drawCount, quint32 stride)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
if (!cbD->currentIndexBuffer)
return;
QMetalBuffer *indexBufD = cbD->currentIndexBuffer;
id<MTLBuffer> indexBufMtl = indexBufD->d->buf[indexBufD->d->slotted ? currentFrameSlot : 0];
QMetalBuffer *indirectBufD = QRHI_RES(QMetalBuffer, indirectBuffer);
executeBufferHostWritesForCurrentFrame(indirectBufD);
indirectBufD->lastActiveFrameSlot = currentFrameSlot;
id<MTLBuffer> indirectBufMtl = indirectBufD->d->buf[indirectBufD->d->slotted ? currentFrameSlot : 0];
if (drawCount > ICB_DRAW_COUNT_THRESHOLD && !icbUnavailableReason(cbD)
&& icbDraw(cbD, true, indirectBufD, indirectBufferOffset, nullptr, 0, drawCount, stride))
{
return;
}
// CPU-side for-loop fallback: used when ICB is not applicable or setup failed.
NSUInteger offset = indirectBufferOffset;
for (quint32 i = 0; i < drawCount; ++i) {
[cbD->d->currentRenderPassEncoder drawIndexedPrimitives: cbD->currentGraphicsPipeline->d->primitiveType
indexType: cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16 ? MTLIndexTypeUInt16 : MTLIndexTypeUInt32
indexBuffer: indexBufMtl
indexBufferOffset: cbD->currentIndexOffset
indirectBuffer: indirectBufMtl
indirectBufferOffset: offset];
offset += stride;
}
}
void QRhiMetal::debugMarkBegin(QRhiCommandBuffer *cb, const QByteArray &name)
{
if (!debugMarkers)
return;
NSString *str = [NSString stringWithUTF8String: name.constData()];
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
switch (cbD->recordingPass) {
case QMetalCommandBuffer::RenderPass:
[cbD->d->currentRenderPassEncoder pushDebugGroup: str];
cbD->d->openDebugGroups.append(name);
break;
case QMetalCommandBuffer::ComputePass:
[cbD->d->currentComputePassEncoder pushDebugGroup: str];
break;
default:
[cbD->d->cb pushDebugGroup: str];
break;
}
}
void QRhiMetal::debugMarkEnd(QRhiCommandBuffer *cb)
{
if (!debugMarkers)
return;
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
switch (cbD->recordingPass) {
case QMetalCommandBuffer::RenderPass:
[cbD->d->currentRenderPassEncoder popDebugGroup];
if (!cbD->d->openDebugGroups.isEmpty())
cbD->d->openDebugGroups.removeLast();
break;
case QMetalCommandBuffer::ComputePass:
[cbD->d->currentComputePassEncoder popDebugGroup];
break;
default:
[cbD->d->cb popDebugGroup];
break;
}
}
void QRhiMetal::debugMarkMsg(QRhiCommandBuffer *cb, const QByteArray &msg)
{
if (!debugMarkers)
return;
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
NSString *str = [NSString stringWithUTF8String: msg.constData()];
switch (cbD->recordingPass) {
case QMetalCommandBuffer::RenderPass:
[cbD->d->currentRenderPassEncoder insertDebugSignpost: str];
break;
case QMetalCommandBuffer::ComputePass:
[cbD->d->currentComputePassEncoder insertDebugSignpost: str];
break;
default:
break;
}
}
const QRhiNativeHandles *QRhiMetal::nativeHandles(QRhiCommandBuffer *cb)
{
return QRHI_RES(QMetalCommandBuffer, cb)->nativeHandles();
}
void QRhiMetal::beginExternal(QRhiCommandBuffer *cb)
{
Q_UNUSED(cb);
}
void QRhiMetal::endExternal(QRhiCommandBuffer *cb)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
cbD->resetPerPassCachedState();
}
double QRhiMetal::lastCompletedGpuTime(QRhiCommandBuffer *cb)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
return cbD->d->lastGpuTime;
}
QRhi::FrameOpResult QRhiMetal::beginFrame(QRhiSwapChain *swapChain, QRhi::BeginFrameFlags flags)
{
Q_UNUSED(flags);
QMetalSwapChain *swapChainD = QRHI_RES(QMetalSwapChain, swapChain);
currentSwapChain = swapChainD;
currentFrameSlot = swapChainD->currentFrameSlot;
// If we are too far ahead, block. This is also what ensures that any
// resource used in the previous frame for this slot is now not in use
// anymore by the GPU.
dispatch_semaphore_wait(swapChainD->d->sem[currentFrameSlot], DISPATCH_TIME_FOREVER);
// Do this also for any other swapchain's commands with the same frame slot
// While this reduces concurrency, it keeps resource usage safe: swapchain
// A starting its frame 0, followed by swapchain B starting its own frame 0
// will make B wait for A's frame 0 commands, so if a resource is written
// in B's frame or when B checks for pending resource releases, that won't
// mess up A's in-flight commands (as they are not in flight anymore).
for (QMetalSwapChain *sc : std::as_const(swapchains)) {
if (sc != swapChainD)
sc->waitUntilCompleted(currentFrameSlot); // wait+signal
}
[d->captureScope beginScope];
swapChainD->cbWrapper.d->cb = d->newCommandBuffer();
QMetalRenderTargetData::ColorAtt colorAtt;
if (swapChainD->samples > 1) {
colorAtt.tex = swapChainD->d->msaaTex[currentFrameSlot];
colorAtt.needsDrawableForResolveTex = true;
} else {
colorAtt.needsDrawableForTex = true;
}
swapChainD->rtWrapper.d->fb.colorAtt[0] = colorAtt;
swapChainD->rtWrapper.d->fb.dsTex = swapChainD->ds ? swapChainD->ds->d->tex : nil;
swapChainD->rtWrapper.d->fb.dsResolveTex = nil;
swapChainD->rtWrapper.d->fb.hasStencil = swapChainD->ds ? true : false;
swapChainD->rtWrapper.d->fb.depthNeedsStore = false;
if (swapChainD->ds)
swapChainD->ds->lastActiveFrameSlot = currentFrameSlot;
d->argBufPool[currentFrameSlot].offset = 0;
d->resetAndResizeBufferStagingArea(currentFrameSlot);
d->globalFrameId += 1;
executeDeferredReleases();
swapChainD->cbWrapper.resetState(swapChainD->d->lastGpuTime[currentFrameSlot]);
swapChainD->d->lastGpuTime[currentFrameSlot] = 0;
finishActiveReadbacks();
return QRhi::FrameOpSuccess;
}
QRhi::FrameOpResult QRhiMetal::endFrame(QRhiSwapChain *swapChain, QRhi::EndFrameFlags flags)
{
QMetalSwapChain *swapChainD = QRHI_RES(QMetalSwapChain, swapChain);
Q_ASSERT(currentSwapChain == swapChainD);
// Keep strong reference to command buffer
id<MTLCommandBuffer> commandBuffer = swapChainD->cbWrapper.d->cb;
__block int thisFrameSlot = currentFrameSlot;
[commandBuffer addCompletedHandler: ^(id<MTLCommandBuffer> cb) {
swapChainD->d->lastGpuTime[thisFrameSlot] += cb.GPUEndTime - cb.GPUStartTime;
dispatch_semaphore_signal(swapChainD->d->sem[thisFrameSlot]);
}];
#ifdef QRHI_METAL_COMMAND_BUFFERS_WITH_UNRETAINED_REFERENCES
// When Metal API validation diagnostics is enabled in Xcode the texture is
// released before the command buffer is done with it. Manually keep it alive
// to work around this.
id<MTLTexture> drawableTexture = [swapChainD->d->curDrawable.texture retain];
[commandBuffer addCompletedHandler:^(id<MTLCommandBuffer>) {
[drawableTexture release];
}];
#endif
if (flags.testFlag(QRhi::SkipPresent)) {
// Just need to commit, that's it
[commandBuffer commit];
} else {
if (id<CAMetalDrawable> drawable = swapChainD->d->curDrawable) {
// Got something to present
if (swapChainD->d->layer.presentsWithTransaction) {
[commandBuffer commit];
// Keep strong reference to Metal layer
auto *metalLayer = swapChainD->d->layer;
auto presentWithTransaction = ^{
[commandBuffer waitUntilScheduled];
// If the layer has been resized while we waited to be scheduled we bail out,
// as the drawable is no longer valid for the layer, and we'll get a follow-up
// display with the right size. We know we are on the main thread here, which
// means we can access the layer directly. We also know that the layer is valid,
// since the block keeps a strong reference to it, compared to the QRhiSwapChain
// that can go away under our feet by the time we're scheduled.
const auto surfaceSize = QSizeF::fromCGSize(metalLayer.bounds.size) * metalLayer.contentsScale;
const auto textureSize = QSizeF(drawable.texture.width, drawable.texture.height);
if (textureSize == surfaceSize) {
[drawable present];
} else {
qCDebug(QRHI_LOG_INFO) << "Skipping" << drawable << "due to texture size"
<< textureSize << "not matching surface size" << surfaceSize;
}
};
if (NSThread.currentThread == NSThread.mainThread) {
presentWithTransaction();
} else {
auto *qtMetalLayer = qt_objc_cast<QMetalLayer*>(swapChainD->d->layer);
Q_ASSERT(qtMetalLayer);
// Let the main thread present the drawable from displayLayer
qtMetalLayer.mainThreadPresentation = presentWithTransaction;
}
} else {
// Keep strong reference to Metal layer so it's valid in the block
auto *qtMetalLayer = qt_objc_cast<QMetalLayer*>(swapChainD->d->layer);
[commandBuffer addScheduledHandler:^(id<MTLCommandBuffer>) {
if (qtMetalLayer) {
// The schedule handler comes in on the com.Metal.CompletionQueueDispatch
// thread, which means we might be racing against a display cycle on the
// main thread. If the displayLayer is already in progress, we don't want
// to step on its toes.
if (qtMetalLayer.displayLock.tryLockForRead()) {
[drawable present];
qtMetalLayer.displayLock.unlock();
} else {
qCDebug(QRHI_LOG_INFO) << "Skipping" << drawable
<< "due to" << qtMetalLayer << "needing display";
}
} else {
[drawable present];
}
}];
[commandBuffer commit];
}
} else {
// Still need to commit, even if we don't have a drawable
[commandBuffer commit];
}
swapChainD->currentFrameSlot = (swapChainD->currentFrameSlot + 1) % QMTL_FRAMES_IN_FLIGHT;
}
// Must not hold on to the drawable, regardless of needsPresent
[swapChainD->d->curDrawable release];
swapChainD->d->curDrawable = nil;
[d->captureScope endScope];
swapChainD->frameCount += 1;
currentSwapChain = nullptr;
return QRhi::FrameOpSuccess;
}
QRhi::FrameOpResult QRhiMetal::beginOffscreenFrame(QRhiCommandBuffer **cb, QRhi::BeginFrameFlags flags)
{
Q_UNUSED(flags);
currentFrameSlot = (currentFrameSlot + 1) % QMTL_FRAMES_IN_FLIGHT;
for (QMetalSwapChain *sc : std::as_const(swapchains))
sc->waitUntilCompleted(currentFrameSlot);
d->ofr.active = true;
*cb = &d->ofr.cbWrapper;
d->ofr.cbWrapper.d->cb = d->newCommandBuffer();
d->argBufPool[currentFrameSlot].offset = 0;
d->resetAndResizeBufferStagingArea(currentFrameSlot);
d->globalFrameId += 1;
executeDeferredReleases();
d->ofr.cbWrapper.resetState(d->ofr.lastGpuTime);
d->ofr.lastGpuTime = 0;
finishActiveReadbacks();
return QRhi::FrameOpSuccess;
}
QRhi::FrameOpResult QRhiMetal::endOffscreenFrame(QRhi::EndFrameFlags flags)
{
Q_UNUSED(flags);
Q_ASSERT(d->ofr.active);
d->ofr.active = false;
id<MTLCommandBuffer> cb = d->ofr.cbWrapper.d->cb;
[cb commit];
// offscreen frames wait for completion, unlike swapchain ones
[cb waitUntilCompleted];
d->ofr.lastGpuTime += cb.GPUEndTime - cb.GPUStartTime;
finishActiveReadbacks(true);
return QRhi::FrameOpSuccess;
}
QRhi::FrameOpResult QRhiMetal::finish()
{
id<MTLCommandBuffer> cb = nil;
QMetalSwapChain *swapChainD = nullptr;
if (inFrame) {
if (d->ofr.active) {
Q_ASSERT(!currentSwapChain);
Q_ASSERT(d->ofr.cbWrapper.recordingPass == QMetalCommandBuffer::NoPass);
cb = d->ofr.cbWrapper.d->cb;
} else {
Q_ASSERT(currentSwapChain);
swapChainD = currentSwapChain;
Q_ASSERT(swapChainD->cbWrapper.recordingPass == QMetalCommandBuffer::NoPass);
cb = swapChainD->cbWrapper.d->cb;
}
}
for (QMetalSwapChain *sc : std::as_const(swapchains)) {
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
if (currentSwapChain && sc == currentSwapChain && i == currentFrameSlot) {
// no wait as this is the thing we're going to be commit below and
// beginFrame decremented sem already and going to be signaled by endFrame
continue;
}
sc->waitUntilCompleted(i);
}
}
if (cb) {
[cb commit];
[cb waitUntilCompleted];
}
if (inFrame) {
if (d->ofr.active) {
d->ofr.lastGpuTime += cb.GPUEndTime - cb.GPUStartTime;
d->ofr.cbWrapper.d->cb = d->newCommandBuffer();
} else {
swapChainD->d->lastGpuTime[currentFrameSlot] += cb.GPUEndTime - cb.GPUStartTime;
swapChainD->cbWrapper.d->cb = d->newCommandBuffer();
}
}
executeDeferredReleases(true);
finishActiveReadbacks(true);
return QRhi::FrameOpSuccess;
}
MTLRenderPassDescriptor *QRhiMetalData::createDefaultRenderPass(bool hasDepthStencil,
const QColor &colorClearValue,
const QRhiDepthStencilClearValue &depthStencilClearValue,
int colorAttCount,
QRhiShadingRateMap *shadingRateMap)
{
MTLRenderPassDescriptor *rp = [MTLRenderPassDescriptor renderPassDescriptor];
MTLClearColor c = MTLClearColorMake(colorClearValue.redF(), colorClearValue.greenF(), colorClearValue.blueF(),
colorClearValue.alphaF());
for (uint i = 0; i < uint(colorAttCount); ++i) {
rp.colorAttachments[i].loadAction = MTLLoadActionClear;
rp.colorAttachments[i].storeAction = MTLStoreActionStore;
rp.colorAttachments[i].clearColor = c;
}
if (hasDepthStencil) {
rp.depthAttachment.loadAction = MTLLoadActionClear;
rp.depthAttachment.storeAction = MTLStoreActionDontCare;
rp.stencilAttachment.loadAction = MTLLoadActionClear;
rp.stencilAttachment.storeAction = MTLStoreActionDontCare;
rp.depthAttachment.clearDepth = double(depthStencilClearValue.depthClearValue());
rp.stencilAttachment.clearStencil = depthStencilClearValue.stencilClearValue();
}
if (shadingRateMap)
rp.rasterizationRateMap = QRHI_RES(QMetalShadingRateMap, shadingRateMap)->d->rateMap;
return rp;
}
qsizetype QRhiMetal::subresUploadByteSize(const QRhiTextureSubresourceUploadDescription &subresDesc) const
{
qsizetype size = 0;
const qsizetype imageSizeBytes = subresDesc.image().isNull() ?
subresDesc.data().size() : subresDesc.image().sizeInBytes();
if (imageSizeBytes > 0)
size += aligned<qsizetype>(imageSizeBytes, QRhiMetalData::TEXBUF_ALIGN);
return size;
}
void QRhiMetal::enqueueSubresUpload(QMetalTexture *texD, void *mp, void *blitEncPtr,
int layer, int level, const QRhiTextureSubresourceUploadDescription &subresDesc,
qsizetype *curOfs)
{
const QPoint dp = subresDesc.destinationTopLeft();
const QByteArray rawData = subresDesc.data();
QImage img = subresDesc.image();
const bool is3D = texD->m_flags.testFlag(QRhiTexture::ThreeDimensional);
id<MTLBlitCommandEncoder> blitEnc = (id<MTLBlitCommandEncoder>) blitEncPtr;
if (!img.isNull()) {
const qsizetype fullImageSizeBytes = img.sizeInBytes();
QSize size = img.size();
int bpl = img.bytesPerLine();
if (!subresDesc.sourceSize().isEmpty() || !subresDesc.sourceTopLeft().isNull()) {
const int sx = subresDesc.sourceTopLeft().x();
const int sy = subresDesc.sourceTopLeft().y();
if (!subresDesc.sourceSize().isEmpty())
size = subresDesc.sourceSize();
size = clampedSubResourceUploadSize(size, dp, level, texD->m_pixelSize);
if (size.width() == img.width()) {
const int bpc = qMax(1, img.depth() / 8);
Q_ASSERT(size.height() * img.bytesPerLine() <= fullImageSizeBytes);
memcpy(reinterpret_cast<char *>(mp) + *curOfs,
img.constBits() + sy * img.bytesPerLine() + sx * bpc,
size.height() * img.bytesPerLine());
} else {
img = img.copy(sx, sy, size.width(), size.height());
bpl = img.bytesPerLine();
Q_ASSERT(img.sizeInBytes() <= fullImageSizeBytes);
memcpy(reinterpret_cast<char *>(mp) + *curOfs, img.constBits(), size_t(img.sizeInBytes()));
}
} else {
size = clampedSubResourceUploadSize(size, dp, level, texD->m_pixelSize);
memcpy(reinterpret_cast<char *>(mp) + *curOfs, img.constBits(), size_t(fullImageSizeBytes));
}
[blitEnc copyFromBuffer: texD->d->stagingBuf[currentFrameSlot]
sourceOffset: NSUInteger(*curOfs)
sourceBytesPerRow: NSUInteger(bpl)
sourceBytesPerImage: 0
sourceSize: MTLSizeMake(NSUInteger(size.width()), NSUInteger(size.height()), 1)
toTexture: texD->d->tex
destinationSlice: NSUInteger(is3D ? 0 : layer)
destinationLevel: NSUInteger(level)
destinationOrigin: MTLOriginMake(NSUInteger(dp.x()), NSUInteger(dp.y()), NSUInteger(is3D ? layer : 0))
options: MTLBlitOptionNone];
*curOfs += aligned<qsizetype>(fullImageSizeBytes, QRhiMetalData::TEXBUF_ALIGN);
} else if (!rawData.isEmpty() && isCompressedFormat(texD->m_format)) {
const QSize subresSize = q->sizeForMipLevel(level, texD->m_pixelSize);
const int subresw = subresSize.width();
const int subresh = subresSize.height();
int w, h;
if (subresDesc.sourceSize().isEmpty()) {
w = subresw;
h = subresh;
} else {
w = subresDesc.sourceSize().width();
h = subresDesc.sourceSize().height();
}
quint32 bpl = 0;
QSize blockDim;
compressedFormatInfo(texD->m_format, QSize(w, h), &bpl, nullptr, &blockDim);
const int dx = aligned(dp.x(), blockDim.width());
const int dy = aligned(dp.y(), blockDim.height());
if (dx + w != subresw)
w = aligned(w, blockDim.width());
if (dy + h != subresh)
h = aligned(h, blockDim.height());
memcpy(reinterpret_cast<char *>(mp) + *curOfs, rawData.constData(), size_t(rawData.size()));
[blitEnc copyFromBuffer: texD->d->stagingBuf[currentFrameSlot]
sourceOffset: NSUInteger(*curOfs)
sourceBytesPerRow: bpl
sourceBytesPerImage: 0
sourceSize: MTLSizeMake(NSUInteger(w), NSUInteger(h), 1)
toTexture: texD->d->tex
destinationSlice: NSUInteger(is3D ? 0 : layer)
destinationLevel: NSUInteger(level)
destinationOrigin: MTLOriginMake(NSUInteger(dx), NSUInteger(dy), NSUInteger(is3D ? layer : 0))
options: MTLBlitOptionNone];
*curOfs += aligned<qsizetype>(rawData.size(), QRhiMetalData::TEXBUF_ALIGN);
} else if (!rawData.isEmpty()) {
const QSize subresSize = q->sizeForMipLevel(level, texD->m_pixelSize);
const int subresw = subresSize.width();
const int subresh = subresSize.height();
int w, h;
if (subresDesc.sourceSize().isEmpty()) {
w = subresw;
h = subresh;
} else {
w = subresDesc.sourceSize().width();
h = subresDesc.sourceSize().height();
}
QSize size = clampedSubResourceUploadSize(QSize(w, h), dp, level, texD->m_pixelSize);
quint32 bytesPerPixel = 0;
textureFormatInfo(texD->m_format, size, nullptr, nullptr, &bytesPerPixel);
size = clampedSubResourceUploadSizeForSourceData(size, subresDesc.dataStride(),
bytesPerPixel, rawData.size());
w = size.width();
h = size.height();
quint32 bpl = 0;
if (subresDesc.dataStride())
bpl = subresDesc.dataStride();
else
textureFormatInfo(texD->m_format, QSize(w, h), &bpl, nullptr, nullptr);
memcpy(reinterpret_cast<char *>(mp) + *curOfs, rawData.constData(), size_t(rawData.size()));
if (!size.isEmpty()) {
[blitEnc copyFromBuffer: texD->d->stagingBuf[currentFrameSlot]
sourceOffset: NSUInteger(*curOfs)
sourceBytesPerRow: bpl
sourceBytesPerImage: 0
sourceSize: MTLSizeMake(NSUInteger(w), NSUInteger(h), 1)
toTexture: texD->d->tex
destinationSlice: NSUInteger(is3D ? 0 : layer)
destinationLevel: NSUInteger(level)
destinationOrigin: MTLOriginMake(NSUInteger(dp.x()), NSUInteger(dp.y()), NSUInteger(is3D ? layer : 0))
options: MTLBlitOptionNone];
}
*curOfs += aligned<qsizetype>(rawData.size(), QRhiMetalData::TEXBUF_ALIGN);
} else {
qWarning("Invalid texture upload for %p layer=%d mip=%d", texD, layer, level);
}
}
void QRhiMetal::enqueueResourceUpdates(QRhiCommandBuffer *cb, QRhiResourceUpdateBatch *resourceUpdates)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
QRhiResourceUpdateBatchPrivate *ud = QRhiResourceUpdateBatchPrivate::get(resourceUpdates);
id<MTLBlitCommandEncoder> blitEnc = nil;
auto ensureBlit = [&blitEnc, cbD, this]() {
if (!blitEnc) {
blitEnc = [cbD->d->cb blitCommandEncoder];
if (debugMarkers)
[blitEnc pushDebugGroup: @"Resource updates"];
}
};
for (int opIdx = 0; opIdx < ud->activeBufferOpCount; ++opIdx) {
const QRhiResourceUpdateBatchPrivate::BufferOp &u(ud->bufferOps[opIdx]);
if (u.type == QRhiResourceUpdateBatchPrivate::BufferOp::DynamicUpdate) {
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, u.buf);
Q_ASSERT(bufD->m_type == QRhiBuffer::Dynamic);
for (int i = 0, ie = bufD->d->slotted ? QMTL_FRAMES_IN_FLIGHT : 1; i != ie; ++i) {
if (u.offset == 0 && u.data.size() == bufD->m_size)
bufD->d->pendingUpdates[i].clear();
bufD->d->pendingUpdates[i].append({ u.offset, u.data });
}
} else if (u.type == QRhiResourceUpdateBatchPrivate::BufferOp::StaticUpload) {
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, u.buf);
Q_ASSERT(bufD->m_type != QRhiBuffer::Dynamic);
Q_ASSERT(u.offset + u.data.size() <= bufD->m_size);
if (bufD->d->isDeviceLocal) {
const quint32 size = quint32(u.data.size());
if (size) { // a zero size blit is invalid
quint32 stagingOffset = 0;
id<MTLBuffer> stagingBuf = d->allocBufferStaging(size, currentFrameSlot, &stagingOffset);
if (stagingBuf) {
char *p = reinterpret_cast<char *>([stagingBuf contents]);
memcpy(p + stagingOffset, u.data.constData(), size);
ensureBlit();
[blitEnc copyFromBuffer: stagingBuf
sourceOffset: stagingOffset
toBuffer: bufD->d->buf[0]
destinationOffset: u.offset
size: size];
} else {
qWarning("Failed to allocate staging buffer of size %u for buffer upload", size);
}
}
bufD->lastActiveFrameSlot = currentFrameSlot;
} else {
for (int i = 0, ie = bufD->d->slotted ? QMTL_FRAMES_IN_FLIGHT : 1; i != ie; ++i)
bufD->d->pendingUpdates[i].append({ u.offset, u.data });
}
} else if (u.type == QRhiResourceUpdateBatchPrivate::BufferOp::Read) {
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, u.buf);
executeBufferHostWritesForCurrentFrame(bufD);
const int idx = bufD->d->slotted ? currentFrameSlot : 0;
if (bufD->m_type == QRhiBuffer::Dynamic) {
char *p = reinterpret_cast<char *>([bufD->d->buf[idx] contents]);
if (p) {
u.result->data.resize(u.readSize);
memcpy(u.result->data.data(), p + u.offset, size_t(u.readSize));
}
if (u.result->completed)
u.result->completed();
} else {
// Copy into a dedicated staging buffer, here and now, instead
// of holding on to the buffer and reading it when the readback
// completes. The contents have to be the ones at this point in
// the command stream: a buffer that is not slotted - which is
// every buffer with StorageBuffer usage - has one native buffer
// shared by all frames, so by the time the readback completes a
// later frame may well be writing it.
QRhiMetalData::BufferReadback readback;
readback.activeFrameSlot = currentFrameSlot;
readback.readSize = u.readSize;
readback.result = u.result;
readback.buf = [d->dev newBufferWithLength: u.readSize
options: MTLResourceStorageModeShared];
ensureBlit();
[blitEnc copyFromBuffer: bufD->d->buf[idx]
sourceOffset: u.offset
toBuffer: readback.buf
destinationOffset: 0
size: u.readSize];
d->activeBufferReadbacks.append(readback);
bufD->lastActiveFrameSlot = currentFrameSlot;
}
} else if (u.type == QRhiResourceUpdateBatchPrivate::BufferOp::Copy) {
QMetalBuffer *dstD = QRHI_RES(QMetalBuffer, u.buf);
QMetalBuffer *srcD = QRHI_RES(QMetalBuffer, u.src);
Q_ASSERT(dstD->m_type != QRhiBuffer::Dynamic && srcD->m_type != QRhiBuffer::Dynamic);
executeBufferHostWritesForCurrentFrame(srcD);
const int srcIdx = srcD->d->slotted ? currentFrameSlot : 0;
const int dstSlotCount = dstD->d->slotted ? QMTL_FRAMES_IN_FLIGHT : 1;
// With device private buffers dstSlotCount is 1 and there are no
// pending host writes at all, so this is a no-op. On the host
// visible path every slot has to be flushed, not just the current
// one: a partial copy cannot discard the pending writes outside the
// copied range, and leaving them queued would let them land on top
// of the copy in a later frame. Writing the slot that is not the
// current one races a still in-flight frame reading it, which is
// why mixing uploadStaticBuffer() and copyBuffer() on one buffer
// within a frame stays unsupported there.
for (int i = 0; i != dstSlotCount; ++i)
executeBufferHostWritesForSlot(dstD, i);
ensureBlit();
for (int i = 0; i != dstSlotCount; ++i) {
[blitEnc copyFromBuffer: srcD->d->buf[srcIdx]
sourceOffset: u.srcOffset
toBuffer: dstD->d->buf[i]
destinationOffset: u.offset
size: u.readSize];
}
srcD->lastActiveFrameSlot = dstD->lastActiveFrameSlot = currentFrameSlot;
} else if (u.type == QRhiResourceUpdateBatchPrivate::BufferOp::Clear) {
QMetalBuffer *bufD = QRHI_RES(QMetalBuffer, u.buf);
Q_ASSERT(bufD->m_type != QRhiBuffer::Dynamic && !bufD->d->slotted);
executeBufferHostWritesForCurrentFrame(bufD);
ensureBlit();
[blitEnc fillBuffer: bufD->d->buf[0]
range: NSMakeRange(u.offset, u.readSize)
value: u.fillValue];
bufD->lastActiveFrameSlot = currentFrameSlot;
}
}
for (int opIdx = 0; opIdx < ud->activeTextureOpCount; ++opIdx) {
const QRhiResourceUpdateBatchPrivate::TextureOp &u(ud->textureOps[opIdx]);
if (u.type == QRhiResourceUpdateBatchPrivate::TextureOp::Upload) {
QMetalTexture *utexD = QRHI_RES(QMetalTexture, u.dst);
qsizetype stagingSize = 0;
for (const auto &subres : u.subresDesc)
stagingSize += subresUploadByteSize(subres.desc);
ensureBlit();
Q_ASSERT(!utexD->d->stagingBuf[currentFrameSlot]);
utexD->d->stagingBuf[currentFrameSlot] = [d->dev newBufferWithLength: NSUInteger(stagingSize)
options: MTLResourceStorageModeShared];
void *mp = [utexD->d->stagingBuf[currentFrameSlot] contents];
qsizetype curOfs = 0;
for (const auto &subres : u.subresDesc)
enqueueSubresUpload(utexD, mp, blitEnc, subres.layer, subres.level, subres.desc, &curOfs);
utexD->lastActiveFrameSlot = currentFrameSlot;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingBuffer;
e.lastActiveFrameSlot = currentFrameSlot;
e.stagingBuffer.buffer = utexD->d->stagingBuf[currentFrameSlot];
utexD->d->stagingBuf[currentFrameSlot] = nil;
d->releaseQueue.append(e);
} else if (u.type == QRhiResourceUpdateBatchPrivate::TextureOp::Copy) {
Q_ASSERT(u.src && u.dst);
QMetalTexture *srcD = QRHI_RES(QMetalTexture, u.src);
QMetalTexture *dstD = QRHI_RES(QMetalTexture, u.dst);
const bool srcIs3D = srcD->m_flags.testFlag(QRhiTexture::ThreeDimensional);
const bool dstIs3D = dstD->m_flags.testFlag(QRhiTexture::ThreeDimensional);
const QPoint dp = u.desc.destinationTopLeft();
const QSize mipSize = q->sizeForMipLevel(u.desc.sourceLevel(), srcD->m_pixelSize);
const QSize copySize = u.desc.pixelSize().isEmpty() ? mipSize : u.desc.pixelSize();
const QPoint sp = u.desc.sourceTopLeft();
ensureBlit();
[blitEnc copyFromTexture: srcD->d->tex
sourceSlice: NSUInteger(srcIs3D ? 0 : u.desc.sourceLayer())
sourceLevel: NSUInteger(u.desc.sourceLevel())
sourceOrigin: MTLOriginMake(NSUInteger(sp.x()), NSUInteger(sp.y()), NSUInteger(srcIs3D ? u.desc.sourceLayer() : 0))
sourceSize: MTLSizeMake(NSUInteger(copySize.width()), NSUInteger(copySize.height()), 1)
toTexture: dstD->d->tex
destinationSlice: NSUInteger(dstIs3D ? 0 : u.desc.destinationLayer())
destinationLevel: NSUInteger(u.desc.destinationLevel())
destinationOrigin: MTLOriginMake(NSUInteger(dp.x()), NSUInteger(dp.y()), NSUInteger(dstIs3D ? u.desc.destinationLayer() : 0))];
srcD->lastActiveFrameSlot = dstD->lastActiveFrameSlot = currentFrameSlot;
} else if (u.type == QRhiResourceUpdateBatchPrivate::TextureOp::Read) {
QRhiMetalData::TextureReadback readback;
readback.activeFrameSlot = currentFrameSlot;
readback.desc = u.rb;
readback.result = u.result;
QMetalTexture *texD = QRHI_RES(QMetalTexture, u.rb.texture());
QMetalSwapChain *swapChainD = nullptr;
id<MTLTexture> src;
QRect rect;
bool is3D = false;
if (texD) {
if (texD->samples > 1) {
qWarning("Multisample texture cannot be read back");
continue;
}
is3D = texD->m_flags.testFlag(QRhiTexture::ThreeDimensional);
if (u.rb.rect().isValid())
rect = u.rb.rect();
else
rect = QRect({0, 0}, q->sizeForMipLevel(u.rb.level(), texD->m_pixelSize));
readback.format = texD->m_format;
src = texD->d->tex;
texD->lastActiveFrameSlot = currentFrameSlot;
} else {
Q_ASSERT(currentSwapChain);
swapChainD = QRHI_RES(QMetalSwapChain, currentSwapChain);
if (u.rb.rect().isValid())
rect = u.rb.rect();
else
rect = QRect({0, 0}, swapChainD->pixelSize);
readback.format = swapChainD->d->rhiColorFormat;
// Multisample swapchains need nothing special since resolving
// happens when ending a renderpass.
const QMetalRenderTargetData::ColorAtt &colorAtt(swapChainD->rtWrapper.d->fb.colorAtt[0]);
src = colorAtt.resolveTex ? colorAtt.resolveTex : colorAtt.tex;
}
readback.pixelSize = rect.size();
quint32 bpl = 0;
textureFormatInfo(readback.format, readback.pixelSize, &bpl, &readback.bufSize, nullptr);
// The depth and stencil aspects of a texture with a combined
// depth/stencil Metal pixel format cannot be copied out with
// MTLBlitOptionNone, they need separate blits, each into its own
// densely packed plane of the staging buffer. In addition, the
// layout of what the blit produces does not necessarily match
// what QRhi returns for the format (e.g. D16 and D24 may be backed
// by Depth32Float). The decisions are thus based on the actual Metal
// pixel format. finishActiveReadbacks() then converts the planes
// into the layout of the result.
const MTLPixelFormat mtlFormat = texD ? texD->d->format : MTLPixelFormatInvalid;
const bool isDepthFormat = texD && (readback.format == QRhiTexture::D16
|| readback.format == QRhiTexture::D24
|| readback.format == QRhiTexture::D24S8
|| readback.format == QRhiTexture::D32F
|| readback.format == QRhiTexture::D32FS8);
const bool nativeLayout = (readback.format == QRhiTexture::D16 && mtlFormat == MTLPixelFormatDepth16Unorm)
|| (readback.format == QRhiTexture::D32F && mtlFormat == MTLPixelFormatDepth32Float);
const bool usePlanes = isDepthFormat && !nativeLayout;
bool combinedMtlFormat = mtlFormat == MTLPixelFormatDepth32Float_Stencil8;
#ifdef Q_OS_MACOS
if (mtlFormat == MTLPixelFormatDepth24Unorm_Stencil8)
combinedMtlFormat = true;
#endif
const bool hasStencil = isStencilSupportingFormat(readback.format);
quint32 depthPlaneBytesPerRow = 0;
if (usePlanes) {
// The depth blit writes 4 bytes per pixel (a float, or a 24-bit
// unorm value in the low bits), the stencil blit 1 byte per pixel.
depthPlaneBytesPerRow = quint32(rect.width()) * 4;
readback.depthPlaneByteSize = depthPlaneBytesPerRow * quint32(rect.height());
if (hasStencil)
readback.stencilPlaneByteSize = quint32(rect.width()) * quint32(rect.height());
readback.depthPlaneIsFloat = mtlFormat == MTLPixelFormatDepth32Float
|| mtlFormat == MTLPixelFormatDepth32Float_Stencil8;
}
const quint32 stagingBufSize = usePlanes
? readback.depthPlaneByteSize + readback.stencilPlaneByteSize
: readback.bufSize;
readback.buf = [d->dev newBufferWithLength: stagingBufSize options: MTLResourceStorageModeShared];
ensureBlit();
const auto blit = [&](quint32 destinationOffset, quint32 destinationBytesPerRow, MTLBlitOption options) {
[blitEnc copyFromTexture: src
sourceSlice: NSUInteger(is3D ? 0 : u.rb.layer())
sourceLevel: NSUInteger(u.rb.level())
sourceOrigin: MTLOriginMake(NSUInteger(rect.x()), NSUInteger(rect.y()), NSUInteger(is3D ? u.rb.layer() : 0))
sourceSize: MTLSizeMake(NSUInteger(rect.width()), NSUInteger(rect.height()), 1)
toBuffer: readback.buf
destinationOffset: destinationOffset
destinationBytesPerRow: destinationBytesPerRow
destinationBytesPerImage: 0
options: options];
};
if (usePlanes) {
blit(0, depthPlaneBytesPerRow,
combinedMtlFormat ? MTLBlitOptionDepthFromDepthStencil : MTLBlitOptionNone);
if (hasStencil)
blit(readback.depthPlaneByteSize, quint32(rect.width()), MTLBlitOptionStencilFromDepthStencil);
} else {
blit(0, bpl, MTLBlitOptionNone);
}
d->activeTextureReadbacks.append(readback);
} else if (u.type == QRhiResourceUpdateBatchPrivate::TextureOp::GenMips) {
QMetalTexture *utexD = QRHI_RES(QMetalTexture, u.dst);
ensureBlit();
[blitEnc generateMipmapsForTexture: utexD->d->tex];
utexD->lastActiveFrameSlot = currentFrameSlot;
}
}
if (blitEnc) {
if (debugMarkers)
[blitEnc popDebugGroup];
[blitEnc endEncoding];
}
ud->free();
}
// this handles all types of buffers, not just Dynamic
void QRhiMetal::executeBufferHostWritesForSlot(QMetalBuffer *bufD, int slot)
{
if (bufD->d->pendingUpdates[slot].isEmpty())
return;
Q_ASSERT(!bufD->d->isDeviceLocal);
void *p = [bufD->d->buf[slot] contents];
quint32 changeBegin = UINT32_MAX;
quint32 changeEnd = 0;
for (const QMetalBufferData::BufferUpdate &u : std::as_const(bufD->d->pendingUpdates[slot])) {
memcpy(static_cast<char *>(p) + u.offset, u.data.constData(), size_t(u.data.size()));
if (u.offset < changeBegin)
changeBegin = u.offset;
if (u.offset + u.data.size() > changeEnd)
changeEnd = u.offset + u.data.size();
}
#ifdef Q_OS_MACOS
if (changeBegin < UINT32_MAX && changeBegin < changeEnd && bufD->d->managed)
[bufD->d->buf[slot] didModifyRange: NSMakeRange(NSUInteger(changeBegin), NSUInteger(changeEnd - changeBegin))];
#endif
bufD->d->pendingUpdates[slot].clear();
}
void QRhiMetal::executeBufferHostWritesForCurrentFrame(QMetalBuffer *bufD)
{
executeBufferHostWritesForSlot(bufD, bufD->d->slotted ? currentFrameSlot : 0);
}
void QRhiMetal::resourceUpdate(QRhiCommandBuffer *cb, QRhiResourceUpdateBatch *resourceUpdates)
{
Q_ASSERT(QRHI_RES(QMetalCommandBuffer, cb)->recordingPass == QMetalCommandBuffer::NoPass);
enqueueResourceUpdates(cb, resourceUpdates);
}
void QRhiMetal::beginPass(QRhiCommandBuffer *cb,
QRhiRenderTarget *rt,
const QColor &colorClearValue,
const QRhiDepthStencilClearValue &depthStencilClearValue,
QRhiResourceUpdateBatch *resourceUpdates,
QRhiCommandBuffer::BeginPassFlags)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::NoPass);
if (resourceUpdates)
enqueueResourceUpdates(cb, resourceUpdates);
QMetalRenderTargetData *rtD = nullptr;
switch (rt->resourceType()) {
case QRhiResource::SwapChainRenderTarget:
{
QMetalSwapChainRenderTarget *rtSc = QRHI_RES(QMetalSwapChainRenderTarget, rt);
rtD = rtSc->d;
QRhiShadingRateMap *shadingRateMap = rtSc->swapChain()->shadingRateMap();
cbD->d->currentPassRpDesc = d->createDefaultRenderPass(rtD->dsAttCount,
colorClearValue,
depthStencilClearValue,
rtD->colorAttCount,
shadingRateMap);
if (rtD->colorAttCount) {
QMetalRenderTargetData::ColorAtt &color0(rtD->fb.colorAtt[0]);
if (color0.needsDrawableForTex || color0.needsDrawableForResolveTex) {
Q_ASSERT(currentSwapChain);
QMetalSwapChain *swapChainD = QRHI_RES(QMetalSwapChain, currentSwapChain);
if (!swapChainD->d->curDrawable) {
QMacAutoReleasePool pool;
swapChainD->d->curDrawable = [[swapChainD->d->layer nextDrawable] retain];
}
if (!swapChainD->d->curDrawable) {
qWarning("No drawable");
return;
}
id<MTLTexture> scTex = swapChainD->d->curDrawable.texture;
if (color0.needsDrawableForTex) {
color0.tex = scTex;
color0.needsDrawableForTex = false;
} else {
color0.resolveTex = scTex;
color0.needsDrawableForResolveTex = false;
}
}
}
if (shadingRateMap)
QRHI_RES(QMetalShadingRateMap, shadingRateMap)->lastActiveFrameSlot = currentFrameSlot;
}
break;
case QRhiResource::TextureRenderTarget:
{
QMetalTextureRenderTarget *rtTex = QRHI_RES(QMetalTextureRenderTarget, rt);
rtD = rtTex->d;
if (!QRhiRenderTargetAttachmentTracker::isUpToDate<QMetalTexture, QMetalRenderBuffer>(rtTex->description(), rtD->currentResIdList))
rtTex->create();
cbD->d->currentPassRpDesc = d->createDefaultRenderPass(rtD->dsAttCount,
colorClearValue,
depthStencilClearValue,
rtD->colorAttCount,
rtTex->m_desc.shadingRateMap());
if (rtD->fb.preserveColor) {
for (uint i = 0; i < uint(rtD->colorAttCount); ++i)
cbD->d->currentPassRpDesc.colorAttachments[i].loadAction = MTLLoadActionLoad;
}
if (rtD->dsAttCount && rtD->fb.preserveDs) {
cbD->d->currentPassRpDesc.depthAttachment.loadAction = MTLLoadActionLoad;
cbD->d->currentPassRpDesc.stencilAttachment.loadAction = MTLLoadActionLoad;
}
int colorAttCount = 0;
for (auto it = rtTex->m_desc.cbeginColorAttachments(), itEnd = rtTex->m_desc.cendColorAttachments();
it != itEnd; ++it)
{
colorAttCount += 1;
if (it->texture()) {
QRHI_RES(QMetalTexture, it->texture())->lastActiveFrameSlot = currentFrameSlot;
if (it->multiViewCount() >= 2)
cbD->d->currentPassRpDesc.renderTargetArrayLength = NSUInteger(it->multiViewCount());
} else if (it->renderBuffer()) {
QRHI_RES(QMetalRenderBuffer, it->renderBuffer())->lastActiveFrameSlot = currentFrameSlot;
}
if (it->resolveTexture())
QRHI_RES(QMetalTexture, it->resolveTexture())->lastActiveFrameSlot = currentFrameSlot;
}
if (rtTex->m_desc.depthStencilBuffer())
QRHI_RES(QMetalRenderBuffer, rtTex->m_desc.depthStencilBuffer())->lastActiveFrameSlot = currentFrameSlot;
if (rtTex->m_desc.depthTexture()) {
QMetalTexture *depthTexture = QRHI_RES(QMetalTexture, rtTex->m_desc.depthTexture());
depthTexture->lastActiveFrameSlot = currentFrameSlot;
if (depthTexture->arraySize() >= 2) {
const int depthLayer = rtTex->m_desc.depthLayer();
if (depthLayer >= 0) {
cbD->d->currentPassRpDesc.depthAttachment.slice = NSUInteger(depthLayer);
cbD->d->currentPassRpDesc.stencilAttachment.slice = NSUInteger(depthLayer);
if (colorAttCount == 0)
cbD->d->currentPassRpDesc.renderTargetArrayLength = 1;
} else if (colorAttCount == 0) {
cbD->d->currentPassRpDesc.renderTargetArrayLength = NSUInteger(depthTexture->arraySize());
}
}
}
if (rtTex->m_desc.depthResolveTexture())
QRHI_RES(QMetalTexture, rtTex->m_desc.depthResolveTexture())->lastActiveFrameSlot = currentFrameSlot;
if (rtTex->m_desc.shadingRateMap())
QRHI_RES(QMetalShadingRateMap, rtTex->m_desc.shadingRateMap())->lastActiveFrameSlot = currentFrameSlot;
}
break;
default:
Q_UNREACHABLE();
break;
}
cbD->d->deferredColorStoreActions.clear();
cbD->d->deferredDepthStoreAction = MTLStoreActionUnknown;
cbD->d->deferredStencilStoreAction = MTLStoreActionUnknown;
for (uint i = 0; i < uint(rtD->colorAttCount); ++i) {
cbD->d->currentPassRpDesc.colorAttachments[i].texture = rtD->fb.colorAtt[i].tex;
cbD->d->currentPassRpDesc.colorAttachments[i].slice = NSUInteger(rtD->fb.colorAtt[i].arrayLayer);
cbD->d->currentPassRpDesc.colorAttachments[i].depthPlane = NSUInteger(rtD->fb.colorAtt[i].slice);
cbD->d->currentPassRpDesc.colorAttachments[i].level = NSUInteger(rtD->fb.colorAtt[i].level);
if (rtD->fb.colorAtt[i].resolveTex) {
const MTLStoreAction storeAction = rtD->fb.preserveColor ? MTLStoreActionStoreAndMultisampleResolve
: MTLStoreActionMultisampleResolve;
// Defer, so that the multisample contents can be kept if the pass
// ends up being interrupted. finalizeDeferredStoreActions() sets the
// real action before the encoder ends.
cbD->d->currentPassRpDesc.colorAttachments[i].storeAction = MTLStoreActionUnknown;
cbD->d->deferredColorStoreActions.append({ i, storeAction });
cbD->d->currentPassRpDesc.colorAttachments[i].resolveTexture = rtD->fb.colorAtt[i].resolveTex;
cbD->d->currentPassRpDesc.colorAttachments[i].resolveSlice = NSUInteger(rtD->fb.colorAtt[i].resolveLayer);
cbD->d->currentPassRpDesc.colorAttachments[i].resolveLevel = NSUInteger(rtD->fb.colorAtt[i].resolveLevel);
}
}
if (rtD->dsAttCount) {
Q_ASSERT(rtD->fb.dsTex);
cbD->d->currentPassRpDesc.depthAttachment.texture = rtD->fb.dsTex;
cbD->d->currentPassRpDesc.stencilAttachment.texture = rtD->fb.hasStencil ? rtD->fb.dsTex : nil;
if (rtD->fb.depthNeedsStore) { // Depth/Stencil is set to DontCare by default, override if needed
cbD->d->currentPassRpDesc.depthAttachment.storeAction = MTLStoreActionStore;
if (rtD->fb.hasStencil)
cbD->d->currentPassRpDesc.stencilAttachment.storeAction = MTLStoreActionStore;
} else if (canStoreAttachment(rtD->fb.dsTex)) {
// Would be discarded at the end of the pass, but an interruption in
// the middle of it still has to be able to keep the contents. Defer,
// so that nothing is stored unless that actually happens.
cbD->d->currentPassRpDesc.depthAttachment.storeAction = MTLStoreActionUnknown;
cbD->d->deferredDepthStoreAction = MTLStoreActionDontCare;
if (rtD->fb.hasStencil) {
cbD->d->currentPassRpDesc.stencilAttachment.storeAction = MTLStoreActionUnknown;
cbD->d->deferredStencilStoreAction = MTLStoreActionDontCare;
}
}
if (rtD->fb.dsResolveTex) {
const MTLStoreAction dsStoreAction = rtD->fb.depthNeedsStore ? MTLStoreActionStoreAndMultisampleResolve
: MTLStoreActionMultisampleResolve;
// Deferred for the same reason as the color attachments above, but
// only when there is something to defer to: a memoryless
// depth-stencil buffer, which is what a QRhiRenderBuffer is on Apple
// GPUs, cannot be stored at all, and rejects the store-and-resolve
// action that an interruption would need.
const bool deferrable = canStoreAttachment(rtD->fb.dsTex);
cbD->d->currentPassRpDesc.depthAttachment.storeAction = deferrable ? MTLStoreActionUnknown
: dsStoreAction;
if (deferrable)
cbD->d->deferredDepthStoreAction = dsStoreAction;
cbD->d->currentPassRpDesc.depthAttachment.resolveTexture = rtD->fb.dsResolveTex;
if (rtD->fb.hasStencil) {
cbD->d->currentPassRpDesc.stencilAttachment.resolveTexture = rtD->fb.dsResolveTex;
cbD->d->currentPassRpDesc.stencilAttachment.storeAction = deferrable ? MTLStoreActionUnknown
: dsStoreAction;
if (deferrable)
cbD->d->deferredStencilStoreAction = dsStoreAction;
}
}
}
cbD->d->currentRenderPassEncoder = [cbD->d->cb renderCommandEncoderWithDescriptor: cbD->d->currentPassRpDesc];
cbD->resetPerPassState();
cbD->recordingPass = QMetalCommandBuffer::RenderPass;
cbD->currentTarget = rt;
}
void QRhiMetal::endPass(QRhiCommandBuffer *cb, QRhiResourceUpdateBatch *resourceUpdates)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
finalizeDeferredStoreActions(cbD, true);
[cbD->d->currentRenderPassEncoder endEncoding];
cbD->recordingPass = QMetalCommandBuffer::NoPass;
cbD->currentTarget = nullptr;
if (resourceUpdates)
enqueueResourceUpdates(cb, resourceUpdates);
}
void QRhiMetal::beginComputePass(QRhiCommandBuffer *cb,
QRhiResourceUpdateBatch *resourceUpdates,
QRhiCommandBuffer::BeginPassFlags)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::NoPass);
if (resourceUpdates)
enqueueResourceUpdates(cb, resourceUpdates);
cbD->d->currentComputePassEncoder = [cbD->d->cb computeCommandEncoder];
cbD->resetPerPassState();
cbD->recordingPass = QMetalCommandBuffer::ComputePass;
}
void QRhiMetal::endComputePass(QRhiCommandBuffer *cb, QRhiResourceUpdateBatch *resourceUpdates)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::ComputePass);
[cbD->d->currentComputePassEncoder endEncoding];
cbD->recordingPass = QMetalCommandBuffer::NoPass;
if (resourceUpdates)
enqueueResourceUpdates(cb, resourceUpdates);
}
void QRhiMetal::setComputePipeline(QRhiCommandBuffer *cb, QRhiComputePipeline *ps)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::ComputePass);
QMetalComputePipeline *psD = QRHI_RES(QMetalComputePipeline, ps);
if (cbD->currentComputePipeline != psD || cbD->currentPipelineGeneration != psD->generation) {
cbD->currentGraphicsPipeline = nullptr;
cbD->currentComputePipeline = psD;
cbD->currentPipelineGeneration = psD->generation;
[cbD->d->currentComputePassEncoder setComputePipelineState: psD->d->ps];
}
psD->lastActiveFrameSlot = currentFrameSlot;
}
void QRhiMetal::dispatch(QRhiCommandBuffer *cb, int x, int y, int z)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::ComputePass);
QMetalComputePipeline *psD = QRHI_RES(QMetalComputePipeline, cbD->currentComputePipeline);
[cbD->d->currentComputePassEncoder dispatchThreadgroups: MTLSizeMake(NSUInteger(x), NSUInteger(y), NSUInteger(z))
threadsPerThreadgroup: psD->d->localSize];
}
void QRhiMetal::dispatchIndirect(QRhiCommandBuffer *cb, QRhiBuffer *indirectBuffer,
quint32 indirectBufferOffset)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::ComputePass);
QMetalComputePipeline *psD = QRHI_RES(QMetalComputePipeline, cbD->currentComputePipeline);
QMetalBuffer *indirectBufD = QRHI_RES(QMetalBuffer, indirectBuffer);
executeBufferHostWritesForCurrentFrame(indirectBufD);
indirectBufD->lastActiveFrameSlot = currentFrameSlot;
id<MTLBuffer> indirectBufMtl = indirectBufD->d->buf[indirectBufD->d->slotted ? currentFrameSlot : 0];
// dispatchThreadgroups still wants threadsPerThreadgroup explicitly; the
// indirect buffer only supplies the grid size in threadgroups. The
// threads-per-threadgroup value comes from the bound compute pipeline
// (set in QMetalComputePipeline::create() from the SPIR-V shader's
// local_size_x/y/z layout qualifiers).
[cbD->d->currentComputePassEncoder
dispatchThreadgroupsWithIndirectBuffer: indirectBufMtl
indirectBufferOffset: indirectBufferOffset
threadsPerThreadgroup: psD->d->localSize];
}
void QRhiMetal::drawIndirectCount(QRhiCommandBuffer *cb,
QRhiBuffer *indirectBuffer, quint32 indirectBufferOffset,
QRhiBuffer *countBuffer, quint32 countBufferOffset,
quint32 maxDrawCount, quint32 stride)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
// Implemented on top of indirect command buffers. There can be no CPU-side
// fallback, the count is only known to the device.
if (const char *reason = icbUnavailableReason(cbD)) {
qWarning("drawIndirectCount is not available because %s; skipping", reason);
return;
}
icbDraw(cbD, false, QRHI_RES(QMetalBuffer, indirectBuffer), indirectBufferOffset,
QRHI_RES(QMetalBuffer, countBuffer), countBufferOffset, maxDrawCount, stride);
}
void QRhiMetal::drawIndexedIndirectCount(QRhiCommandBuffer *cb,
QRhiBuffer *indirectBuffer, quint32 indirectBufferOffset,
QRhiBuffer *countBuffer, quint32 countBufferOffset,
quint32 maxDrawCount, quint32 stride)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
// Implemented on top of indirect command buffers. There can be no CPU-side
// fallback, the count is only known to the device.
if (const char *reason = icbUnavailableReason(cbD)) {
qWarning("drawIndexedIndirectCount is not available because %s; skipping", reason);
return;
}
if (!cbD->currentIndexBuffer) {
qWarning("drawIndexedIndirectCount called without an index buffer bound; skipping");
return;
}
icbDraw(cbD, true, QRHI_RES(QMetalBuffer, indirectBuffer), indirectBufferOffset,
QRHI_RES(QMetalBuffer, countBuffer), countBufferOffset, maxDrawCount, stride);
}
static inline MTLPrimitiveType toMetalPrimitiveType(QRhiGraphicsPipeline::Topology t);
struct QMetalIndirectCommandBufferData
{
struct Slot {
id<MTLIndirectCommandBuffer> icb = nil;
id<MTLBuffer> argBuffer = nil;
id<MTLBuffer> rangeBuffer = nil;
quint64 generation = 0; // unchanged contents should not be re-encoded every frame
MTLPrimitiveType primitiveType = MTLPrimitiveTypeTriangle;
id<MTLBuffer> indexBuf = nil;
quint32 indexOffset = 0;
QRhiCommandBuffer::IndexFormat indexFormat = QRhiCommandBuffer::IndexUInt16;
bool encoded = false;
quint64 usedInFrameId = 0;
};
Slot frameSlots[QMTL_FRAMES_IN_FLIGHT];
enum class Fill { None, Cpu, Gpu };
Fill fill = Fill::None;
bool slotSetupFailed = false;
bool created = false;
// Set by buildIndirect(), which makes the CPU-side recording irrelevant:
// gpuFilled means the kernel encoded into frameSlots[builtSlot], fallbackBuild
// that there was no ICB to encode into and executeIndirect() has to use the
// plain indirect draw entry points.
bool gpuFilled = false;
bool fallbackBuild = false;
QRhiIndirectCommandBufferBuildInfo buildInfo;
int builtSlot = -1;
};
static void qrhimtl_releaseIcbSlots(QRhiMetal *rhiD, QMetalIndirectCommandBuffer *icbD)
{
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
QMetalIndirectCommandBufferData::Slot &slot(icbD->d->frameSlots[i]);
if (slot.icb) {
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingIcbBuffer;
e.lastActiveFrameSlot = icbD->lastActiveFrameSlot;
e.stagingIcbBuffer.icb = slot.icb;
e.stagingIcbBuffer.argBuffer = slot.argBuffer;
rhiD->d->releaseQueue.append(e);
}
if (slot.rangeBuffer) {
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingBuffer;
e.lastActiveFrameSlot = icbD->lastActiveFrameSlot;
e.stagingBuffer.buffer = slot.rangeBuffer;
rhiD->d->releaseQueue.append(e);
}
slot = {};
}
icbD->d->fill = QMetalIndirectCommandBufferData::Fill::None;
}
static bool qrhimtl_ensureIcbSlots(QRhiMetal *rhiD, QMetalIndirectCommandBuffer *icbD,
QMetalIndirectCommandBufferData::Fill fill)
{
Q_ASSERT(fill != QMetalIndirectCommandBufferData::Fill::None);
if (icbD->d->slotSetupFailed)
return false;
if (icbD->d->fill == fill)
return icbD->d->frameSlots[0].icb != nil;
if (icbD->d->fill != QMetalIndirectCommandBufferData::Fill::None) {
qrhimtl_releaseIcbSlots(rhiD, icbD);
icbD->d->gpuFilled = false;
icbD->d->builtSlot = -1;
}
if (!rhiD->caps.indirectCommandBuffers)
return false;
const bool gpu = fill == QMetalIndirectCommandBufferData::Fill::Gpu;
if (gpu && !rhiD->prepareIcbKernels())
return false;
MTLIndirectCommandBufferDescriptor *icbDesc = [MTLIndirectCommandBufferDescriptor new];
icbDesc.commandTypes = icbD->type() == QRhiIndirectCommandBuffer::IndexedDraws
? MTLIndirectCommandTypeDrawIndexed : MTLIndirectCommandTypeDraw;
// All state except the primitive type and the index buffer is inherited.
icbDesc.inheritPipelineState = YES;
icbDesc.inheritBuffers = YES;
icbDesc.maxVertexBufferBindCount = 0;
icbDesc.maxFragmentBufferBindCount = 0;
bool ok = true;
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT && ok; ++i) {
QMetalIndirectCommandBufferData::Slot &slot(icbD->d->frameSlots[i]);
slot.icb = [rhiD->d->dev newIndirectCommandBufferWithDescriptor:icbDesc
maxCommandCount:icbD->maxCommandCount()
options:gpu ? MTLResourceStorageModePrivate
: MTLResourceStorageModeShared];
if (!slot.icb) {
qWarning("Failed to create MTLIndirectCommandBuffer");
ok = false;
break;
}
if (gpu) {
slot.rangeBuffer = [rhiD->d->dev newBufferWithLength:sizeof(MTLIndirectCommandBufferExecutionRange)
options:MTLResourceStorageModePrivate];
id<MTLArgumentEncoder> argEnc = [rhiD->d->icbEncodeFunction newArgumentEncoderWithBufferIndex:1];
slot.argBuffer = [rhiD->d->dev newBufferWithLength:argEnc.encodedLength
options:MTLResourceStorageModeShared];
if (slot.rangeBuffer && slot.argBuffer) {
[argEnc setArgumentBuffer:slot.argBuffer offset:0];
[argEnc setIndirectCommandBuffer:slot.icb atIndex:0];
} else {
qWarning("Failed to create MTLIndirectCommandBuffer helper buffers");
ok = false;
}
[argEnc release];
if (!ok)
break;
}
}
[icbDesc release];
if (!ok) {
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
[icbD->d->frameSlots[i].icb release];
[icbD->d->frameSlots[i].rangeBuffer release];
[icbD->d->frameSlots[i].argBuffer release];
icbD->d->frameSlots[i] = {};
}
icbD->d->slotSetupFailed = true;
return false;
}
icbD->d->fill = fill;
return true;
}
QMetalIndirectCommandBuffer::QMetalIndirectCommandBuffer(QRhiImplementation *rhi, Type type,
quint32 maxCommandCount)
: QRhiIndirectCommandBuffer(rhi, type, maxCommandCount),
d(new QMetalIndirectCommandBufferData)
{
}
QMetalIndirectCommandBuffer::~QMetalIndirectCommandBuffer()
{
destroy();
delete d;
}
void QMetalIndirectCommandBuffer::destroy()
{
clear();
if (!d->created)
return;
d->slotSetupFailed = false;
d->gpuFilled = false;
d->fallbackBuild = false;
d->buildInfo = {};
d->builtSlot = -1;
d->created = false;
m_gpuBuilt = false;
m_gpuBuiltCommandCount = 0;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
qrhimtl_releaseIcbSlots(rhiD, this);
rhiD->unregisterResource(this);
}
}
bool QMetalIndirectCommandBuffer::create()
{
if (d->created)
destroy();
else
clear();
if (!m_maxCommandCount) {
qWarning("QRhiIndirectCommandBuffer: maxCommandCount is 0");
return false;
}
QRHI_RES_RHI(QRhiMetal);
lastActiveFrameSlot = -1;
d->created = true;
rhiD->registerResource(this);
return true;
}
QRhiIndirectCommandBuffer *QRhiMetal::createIndirectCommandBuffer(QRhiIndirectCommandBuffer::Type type,
quint32 maxCommandCount)
{
return new QMetalIndirectCommandBuffer(this, type, maxCommandCount);
}
void QRhiMetal::commitIndirectCommandBuffer(QRhiResourceUpdateBatch *u,
QRhiIndirectCommandBuffer *icb)
{
// Nothing to upload: executeIndirect() encodes straight into the ICB, and
// only there are the primitive type and index buffer known.
Q_UNUSED(u);
Q_UNUSED(icb);
}
// True when the slot holds an encoding that is already good for these
// contents and this state, and so does not need to be re-encoded.
static bool qrhimtl_icbSlotMatches(const QMetalIndirectCommandBuffer *icbD,
const QMetalIndirectCommandBufferData::Slot &slot,
MTLPrimitiveType primitiveType,
id<MTLBuffer> indexBufMtl, quint32 indexOffset,
QRhiCommandBuffer::IndexFormat indexFormat)
{
const bool indexed = icbD->type() == QRhiIndirectCommandBuffer::IndexedDraws;
return slot.encoded
&& slot.generation == icbD->contentsGeneration()
&& slot.primitiveType == primitiveType
&& (!indexed || (slot.indexBuf == indexBufMtl
&& slot.indexOffset == indexOffset
&& slot.indexFormat == indexFormat));
}
// Re-encodes the CPU-recorded commands unless the slot already matches.
static void qrhimtl_encodeIcbFromCpu(QMetalIndirectCommandBuffer *icbD,
QMetalIndirectCommandBufferData::Slot &slot,
MTLPrimitiveType primitiveType,
id<MTLBuffer> indexBufMtl, quint32 indexOffset,
QRhiCommandBuffer::IndexFormat indexFormat)
{
const bool indexed = icbD->type() == QRhiIndirectCommandBuffer::IndexedDraws;
if (qrhimtl_icbSlotMatches(icbD, slot, primitiveType, indexBufMtl, indexOffset, indexFormat))
return;
const quint32 count = icbD->recordedCommandCount();
if (indexed) {
const MTLIndexType indexType = indexFormat == QRhiCommandBuffer::IndexUInt16
? MTLIndexTypeUInt16 : MTLIndexTypeUInt32;
const quint32 indexSize = indexFormat == QRhiCommandBuffer::IndexUInt16 ? 2 : 4;
const QRhiIndexedIndirectDrawCommand *cmds = icbD->indexedDrawCommands();
for (quint32 i = 0; i < count; ++i) {
const QRhiIndexedIndirectDrawCommand &c(cmds[i]);
id<MTLIndirectRenderCommand> rc = [slot.icb indirectRenderCommandAtIndex:i];
[rc drawIndexedPrimitives:primitiveType
indexCount:c.indexCount
indexType:indexType
indexBuffer:indexBufMtl
indexBufferOffset:indexOffset + c.firstIndex * indexSize
instanceCount:c.instanceCount
baseVertex:c.vertexOffset
baseInstance:c.firstInstance];
}
} else {
const QRhiIndirectDrawCommand *cmds = icbD->drawCommands();
for (quint32 i = 0; i < count; ++i) {
const QRhiIndirectDrawCommand &c(cmds[i]);
id<MTLIndirectRenderCommand> rc = [slot.icb indirectRenderCommandAtIndex:i];
[rc drawPrimitives:primitiveType
vertexStart:c.firstVertex
vertexCount:c.vertexCount
instanceCount:c.instanceCount
baseInstance:c.firstInstance];
}
}
// Commands past the current count may be left over from a longer batch.
if (count < icbD->maxCommandCount())
[slot.icb resetWithRange:NSMakeRange(count, icbD->maxCommandCount() - count)];
slot.generation = icbD->contentsGeneration();
slot.primitiveType = primitiveType;
slot.indexBuf = indexBufMtl;
slot.indexOffset = indexOffset;
slot.indexFormat = indexFormat;
slot.encoded = true;
}
// Fallback for when there is no usable ICB.
static void qrhimtl_replayIcbOnCpu(QMetalCommandBuffer *cbD, QMetalIndirectCommandBuffer *icbD,
quint32 firstCommand, quint32 count,
int currentFrameSlot)
{
const MTLPrimitiveType primitiveType = cbD->currentGraphicsPipeline->d->primitiveType;
if (icbD->type() == QRhiIndirectCommandBuffer::IndexedDraws) {
QMetalBuffer *indexBufD = cbD->currentIndexBuffer;
if (!indexBufD)
return;
id<MTLBuffer> indexBufMtl = indexBufD->d->buf[indexBufD->d->slotted ? currentFrameSlot : 0];
const MTLIndexType indexType = cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16
? MTLIndexTypeUInt16 : MTLIndexTypeUInt32;
const quint32 indexSize = cbD->currentIndexFormat == QRhiCommandBuffer::IndexUInt16 ? 2 : 4;
const QRhiIndexedIndirectDrawCommand *cmds = icbD->indexedDrawCommands();
for (quint32 i = 0; i < count; ++i) {
const QRhiIndexedIndirectDrawCommand &c(cmds[firstCommand + i]);
[cbD->d->currentRenderPassEncoder drawIndexedPrimitives: primitiveType
indexCount: c.indexCount
indexType: indexType
indexBuffer: indexBufMtl
indexBufferOffset: cbD->currentIndexOffset + c.firstIndex * indexSize
instanceCount: c.instanceCount
baseVertex: c.vertexOffset
baseInstance: c.firstInstance];
}
} else {
const QRhiIndirectDrawCommand *cmds = icbD->drawCommands();
for (quint32 i = 0; i < count; ++i) {
const QRhiIndirectDrawCommand &c(cmds[firstCommand + i]);
[cbD->d->currentRenderPassEncoder drawPrimitives: primitiveType
vertexStart: c.firstVertex
vertexCount: c.vertexCount
instanceCount: c.instanceCount
baseInstance: c.firstInstance];
}
}
}
void QRhiMetal::executeIndirect(QRhiCommandBuffer *cb, QRhiIndirectCommandBuffer *icb,
quint32 firstCommand, quint32 commandCount)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::RenderPass);
QMetalIndirectCommandBuffer *icbD = QRHI_RES(QMetalIndirectCommandBuffer, icb);
icbD->lastActiveFrameSlot = currentFrameSlot;
const bool indexed = icb->type() == QRhiIndirectCommandBuffer::IndexedDraws;
if (icbD->d->gpuFilled) {
if (icbD->d->buildInfo.topology != cbD->currentGraphicsPipeline->topology()) {
qWarning("executeIndirect: the indirect command buffer was built for a different "
"topology than the current graphics pipeline uses; skipping");
return;
}
QMetalIndirectCommandBufferData::Slot &slot(icbD->d->frameSlots[icbD->d->builtSlot]);
const quint32 total = icbD->commandCount();
const bool deviceCount = icbD->d->buildInfo.countBuffer != nullptr;
NSRange range = NSMakeRange(0, total);
if (deviceCount) {
// The count is only known to the device, and applying it is what
// the compute kernel-written range is for. That form of
// executeCommandsInBuffer takes no CPU-side range, so a subrange
// and a device-side count cannot be combined.
if (firstCommand != 0 || commandCount < total) {
qWarning("executeIndirect: firstCommand and commandCount cannot be honoured "
"together with a device-side count; executing all %u command(s)", total);
}
} else {
if (firstCommand >= total)
return;
const quint32 count = qMin(commandCount, total - firstCommand);
if (!count)
return;
range = NSMakeRange(firstCommand, count);
}
if (indexed && icbD->d->buildInfo.indexBuffer) {
QMetalBuffer *indexBufD = QRHI_RES(QMetalBuffer, icbD->d->buildInfo.indexBuffer);
id<MTLBuffer> indexBufMtl = indexBufD->d->buf[indexBufD->d->slotted ? currentFrameSlot : 0];
[cbD->d->currentRenderPassEncoder useResource:indexBufMtl
usage:MTLResourceUsageRead
stages:MTLRenderStageVertex | MTLRenderStageFragment];
}
if (deviceCount) {
[cbD->d->currentRenderPassEncoder executeCommandsInBuffer:slot.icb
indirectBuffer:slot.rangeBuffer
indirectBufferOffset:0];
} else {
[cbD->d->currentRenderPassEncoder executeCommandsInBuffer:slot.icb withRange:range];
}
return;
}
if (icbD->d->fallbackBuild) {
const QRhiIndirectCommandBufferBuildInfo &info(icbD->d->buildInfo);
if (info.countBuffer) {
qWarning("executeIndirect: a device-side count needs an indirect command buffer, "
"which is not available here; skipping");
return;
}
const quint32 canonicalStride = indexed ? sizeof(QRhiIndexedIndirectDrawCommand)
: sizeof(QRhiIndirectDrawCommand);
const quint32 stride = info.stride ? info.stride : canonicalStride;
const quint32 total = icbD->commandCount();
if (firstCommand >= total)
return;
const quint32 count = qMin(commandCount, total - firstCommand);
if (!count)
return;
const quint32 offset = info.sourceBufferOffset + firstCommand * stride;
if (indexed)
drawIndexedIndirect(cb, info.sourceBuffer, offset, count, stride);
else
drawIndirect(cb, info.sourceBuffer, offset, count, stride);
return;
}
const quint32 total = icbD->recordedCommandCount();
if (firstCommand >= total)
return;
const quint32 count = qMin(commandCount, total - firstCommand);
if (!count)
return;
if (icbUnavailableReason(cbD)
|| !qrhimtl_ensureIcbSlots(this, icbD, QMetalIndirectCommandBufferData::Fill::Cpu))
{
qrhimtl_replayIcbOnCpu(cbD, icbD, firstCommand, count, currentFrameSlot);
return;
}
QMetalIndirectCommandBufferData::Slot &slot(icbD->d->frameSlots[currentFrameSlot]);
id<MTLBuffer> indexBufMtl = nil;
quint32 indexOffset = 0;
if (indexed) {
QMetalBuffer *indexBufD = cbD->currentIndexBuffer;
if (!indexBufD)
return;
indexBufD->lastActiveFrameSlot = currentFrameSlot;
indexBufMtl = indexBufD->d->buf[indexBufD->d->slotted ? currentFrameSlot : 0];
indexOffset = cbD->currentIndexOffset;
}
const MTLPrimitiveType primitiveType = cbD->currentGraphicsPipeline->d->primitiveType;
if (slot.usedInFrameId == d->globalFrameId
&& !qrhimtl_icbSlotMatches(icbD, slot, primitiveType, indexBufMtl, indexOffset,
cbD->currentIndexFormat))
{
// An executeCommandsInBuffer recorded earlier in this frame references
// this slot, and re-encoding it now would change what that one executes
// once submitted. Replaying as ordinary draws keeps both correct.
qWarning("executeIndirect: the same indirect command buffer is executed more than once "
"in a frame, with different contents, topology or index buffer state; "
"falling back to individual draw calls");
qrhimtl_replayIcbOnCpu(cbD, icbD, firstCommand, count, currentFrameSlot);
return;
}
qrhimtl_encodeIcbFromCpu(icbD, slot, primitiveType,
indexBufMtl, indexOffset, cbD->currentIndexFormat);
if (indexed) {
// Index buffer is not inherited from the encoder, and the ICB commands reference it directly,
// so it needs the useResource.
[cbD->d->currentRenderPassEncoder useResource:indexBufMtl
usage:MTLResourceUsageRead
stages:MTLRenderStageVertex | MTLRenderStageFragment];
}
[cbD->d->currentRenderPassEncoder executeCommandsInBuffer:slot.icb
withRange:NSMakeRange(firstCommand, count)];
slot.usedInFrameId = d->globalFrameId;
}
void QRhiMetal::buildIndirect(QRhiCommandBuffer *cb, QRhiIndirectCommandBuffer *icb,
const QRhiIndirectCommandBufferBuildInfo &info)
{
QMetalCommandBuffer *cbD = QRHI_RES(QMetalCommandBuffer, cb);
Q_ASSERT(cbD->recordingPass == QMetalCommandBuffer::NoPass);
QMetalIndirectCommandBuffer *icbD = QRHI_RES(QMetalIndirectCommandBuffer, icb);
icbD->lastActiveFrameSlot = currentFrameSlot;
const bool indexed = icb->type() == QRhiIndirectCommandBuffer::IndexedDraws;
if (indexed && !info.indexBuffer) {
qWarning("buildIndirect: an IndexedDraws indirect command buffer needs an "
"index buffer in QRhiIndirectCommandBufferBuildInfo; skipping");
return;
}
quint32 count = info.commandCount ? info.commandCount : icbD->m_maxCommandCount;
if (count > icbD->m_maxCommandCount) {
qWarning("QRhiIndirectCommandBuffer: buildIndirect() with commandCount %u exceeds "
"maxCommandCount %u; clamping", count, icbD->m_maxCommandCount);
count = icbD->m_maxCommandCount;
}
icbD->m_gpuBuilt = true;
icbD->m_gpuBuiltCommandCount = count;
if (!qrhimtl_ensureIcbSlots(this, icbD, QMetalIndirectCommandBufferData::Fill::Gpu)) {
icbD->d->gpuFilled = false;
icbD->d->fallbackBuild = true;
icbD->d->buildInfo = info;
icbD->d->builtSlot = -1;
return;
}
QMetalIndirectCommandBufferData::Slot &slot(icbD->d->frameSlots[currentFrameSlot]);
QMetalBuffer *srcBufD = QRHI_RES(QMetalBuffer, info.sourceBuffer);
executeBufferHostWritesForCurrentFrame(srcBufD);
srcBufD->lastActiveFrameSlot = currentFrameSlot;
id<MTLBuffer> srcBufMtl = srcBufD->d->buf[srcBufD->d->slotted ? currentFrameSlot : 0];
id<MTLBuffer> indexBufMtl = nil;
if (indexed) {
QMetalBuffer *indexBufD = QRHI_RES(QMetalBuffer, info.indexBuffer);
indexBufD->lastActiveFrameSlot = currentFrameSlot;
indexBufMtl = indexBufD->d->buf[indexBufD->d->slotted ? currentFrameSlot : 0];
}
id<MTLBuffer> countBufMtl = nil;
if (info.countBuffer) {
QMetalBuffer *countBufD = QRHI_RES(QMetalBuffer, info.countBuffer);
executeBufferHostWritesForCurrentFrame(countBufD);
countBufD->lastActiveFrameSlot = currentFrameSlot;
countBufMtl = countBufD->d->buf[countBufD->d->slotted ? currentFrameSlot : 0];
}
const quint32 stride = info.stride ? info.stride
: (indexed ? sizeof(QRhiIndexedIndirectDrawCommand)
: sizeof(QRhiIndirectDrawCommand));
// Outside a render pass, so the compute encoder costs no interruption, no
// store action juggling and no per-pass state to restore.
id<MTLComputeCommandEncoder> computeEncoder = [cbD->d->cb computeCommandEncoder];
encodeIcbWithCompute(d, computeEncoder, slot.icb, slot.argBuffer, slot.rangeBuffer,
indexed, info.indexFormat,
toMetalPrimitiveType(info.topology),
srcBufMtl, info.sourceBufferOffset,
indexBufMtl, info.indexBufferOffset,
countBufMtl, info.countBufferOffset,
icbD->commandCount(), stride);
[computeEncoder endEncoding];
icbD->d->gpuFilled = true;
icbD->d->fallbackBuild = false;
icbD->d->buildInfo = info;
icbD->d->builtSlot = currentFrameSlot;
// The CPU-encoded contents of this slot, if any, are gone now.
slot.encoded = false;
}
static void qrhimtl_releaseBuffer(const QRhiMetalData::DeferredReleaseEntry &e)
{
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i)
[e.buffer.buffers[i] release];
}
static void qrhimtl_releaseRenderBuffer(const QRhiMetalData::DeferredReleaseEntry &e)
{
[e.renderbuffer.texture release];
}
static void qrhimtl_releaseTexture(const QRhiMetalData::DeferredReleaseEntry &e)
{
[e.texture.texture release];
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i)
[e.texture.stagingBuffers[i] release];
for (int i = 0; i < QRhi::MAX_MIP_LEVELS; ++i)
[e.texture.views[i] release];
[e.texture.samplingView release];
[e.texture.writeView release];
}
static void qrhimtl_releaseSampler(const QRhiMetalData::DeferredReleaseEntry &e)
{
[e.sampler.samplerState release];
}
void QRhiMetal::executeDeferredReleases(bool forced)
{
qsizetype keepBegin = d->releaseQueue.size();
for (qsizetype i = keepBegin - 1; i >= 0; --i) {
const QRhiMetalData::DeferredReleaseEntry &e(d->releaseQueue[i]);
if (forced || currentFrameSlot == e.lastActiveFrameSlot || e.lastActiveFrameSlot < 0) {
switch (e.type) {
case QRhiMetalData::DeferredReleaseEntry::Buffer:
qrhimtl_releaseBuffer(e);
break;
case QRhiMetalData::DeferredReleaseEntry::RenderBuffer:
qrhimtl_releaseRenderBuffer(e);
break;
case QRhiMetalData::DeferredReleaseEntry::Texture:
qrhimtl_releaseTexture(e);
break;
case QRhiMetalData::DeferredReleaseEntry::Sampler:
qrhimtl_releaseSampler(e);
break;
case QRhiMetalData::DeferredReleaseEntry::StagingBuffer:
[e.stagingBuffer.buffer release];
break;
case QRhiMetalData::DeferredReleaseEntry::GraphicsPipeline:
[e.graphicsPipeline.pipelineState release];
[e.graphicsPipeline.depthStencilState release];
[e.graphicsPipeline.tessVertexComputeState[0] release];
[e.graphicsPipeline.tessVertexComputeState[1] release];
[e.graphicsPipeline.tessVertexComputeState[2] release];
[e.graphicsPipeline.tessTessControlComputeState release];
break;
case QRhiMetalData::DeferredReleaseEntry::ComputePipeline:
[e.computePipeline.pipelineState release];
break;
case QRhiMetalData::DeferredReleaseEntry::ShadingRateMap:
[e.shadingRateMap.rateMap release];
break;
case QRhiMetalData::DeferredReleaseEntry::StagingIcbBuffer:
[e.stagingIcbBuffer.icb release];
[e.stagingIcbBuffer.argBuffer release];
break;
default:
break;
}
} else if (--keepBegin != i) {
d->releaseQueue[keepBegin] = std::move(d->releaseQueue[i]);
}
}
if (keepBegin)
d->releaseQueue.remove(0, keepBegin);
}
void QRhiMetal::finishActiveReadbacks(bool forced)
{
QVarLengthArray<std::function<void()>, 4> completedCallbacks;
for (int i = d->activeTextureReadbacks.count() - 1; i >= 0; --i) {
const QRhiMetalData::TextureReadback &readback(d->activeTextureReadbacks[i]);
if (forced || currentFrameSlot == readback.activeFrameSlot || readback.activeFrameSlot < 0) {
readback.result->format = readback.format;
readback.result->pixelSize = readback.pixelSize;
readback.result->data.resize(int(readback.bufSize));
const void *p = [readback.buf contents];
if (readback.depthPlaneByteSize) {
// The staging buffer holds a densely packed depth plane, followed
// by a densely packed stencil plane when the format has stencil
// (see enqueueResourceUpdates()). Convert into the layout QRhi
// guarantees: D16 is a 16-bit unorm value, D24 and D24S8 have the
// depth in the upper 24 bits and the stencil (or zero) in the lower
// 8 bits, and D32FS8 is the float depth followed by a 32-bit word
// with the stencil in its low 8 bits.
const quint32 pixelCount = quint32(readback.pixelSize.width()) * quint32(readback.pixelSize.height());
const char *depthPlane = static_cast<const char *>(p);
const quint8 *stencilPlane = reinterpret_cast<const quint8 *>(depthPlane + readback.depthPlaneByteSize);
char *dst = readback.result->data.data();
for (quint32 px = 0; px < pixelCount; ++px) {
const quint32 depthWord = qFromUnaligned<quint32>(depthPlane + px * 4);
const float depthF = readback.depthPlaneIsFloat ? qFromUnaligned<float>(depthPlane + px * 4) : 0.0f;
const quint32 stencil = readback.stencilPlaneByteSize ? stencilPlane[px] : 0;
switch (readback.format) {
case QRhiTexture::D16:
qToUnaligned(quint16(qRound(qBound(0.0f, depthF, 1.0f) * 65535.0f)), dst + px * 2);
break;
case QRhiTexture::D32FS8:
qToUnaligned(depthWord, dst + px * 8);
qToUnaligned(stencil, dst + px * 8 + 4);
break;
default: // D24, D24S8
{
const quint32 depth24 = readback.depthPlaneIsFloat
? quint32(qBound(0.0f, depthF, 1.0f) * 16777215.0f + 0.5f)
: depthWord & 0x00FFFFFFu;
qToUnaligned((depth24 << 8) | stencil, dst + px * 4);
}
break;
}
}
} else {
memcpy(readback.result->data.data(), p, readback.bufSize);
}
[readback.buf release];
if (readback.result->completed)
completedCallbacks.append(readback.result->completed);
d->activeTextureReadbacks.remove(i);
}
}
for (int i = d->activeBufferReadbacks.count() - 1; i >= 0; --i) {
const QRhiMetalData::BufferReadback &readback(d->activeBufferReadbacks[i]);
if (forced || currentFrameSlot == readback.activeFrameSlot
|| readback.activeFrameSlot < 0) {
readback.result->data.resize(readback.readSize);
char *p = reinterpret_cast<char *>([readback.buf contents]);
Q_ASSERT(p);
memcpy(readback.result->data.data(), p, size_t(readback.readSize));
[readback.buf release];
if (readback.result->completed)
completedCallbacks.append(readback.result->completed);
d->activeBufferReadbacks.remove(i);
}
}
for (auto f : completedCallbacks)
f();
}
QMetalBuffer::QMetalBuffer(QRhiImplementation *rhi, Type type, UsageFlags usage, quint32 size)
: QRhiBuffer(rhi, type, usage, size),
d(new QMetalBufferData)
{
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i)
d->buf[i] = nil;
}
QMetalBuffer::~QMetalBuffer()
{
destroy();
delete d;
}
void QMetalBuffer::destroy()
{
if (!d->buf[0])
return;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::Buffer;
e.lastActiveFrameSlot = lastActiveFrameSlot;
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
e.buffer.buffers[i] = d->buf[i];
d->buf[i] = nil;
d->pendingUpdates[i].clear();
}
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
bool QMetalBuffer::create()
{
if (d->buf[0])
destroy();
if (m_usage.testFlag(QRhiBuffer::StorageBuffer) && m_type == Dynamic) {
qWarning("StorageBuffer cannot be combined with Dynamic");
return false;
}
const quint32 nonZeroSize = m_size <= 0 ? 256 : m_size;
const quint32 roundedSize = m_usage.testFlag(QRhiBuffer::UniformBuffer) ? aligned(nonZeroSize, 256u) : nonZeroSize;
d->managed = false;
d->isDeviceLocal = false;
MTLResourceOptions opts = MTLResourceStorageModeShared;
QRHI_RES_RHI(QRhiMetal);
const bool internalHostWritable = (int(m_usage) & (WorkBufPoolUsage | InternalHostWritable)) != 0;
if (m_type != Dynamic && !internalHostWritable && rhiD->caps.usePrivateStaticBuffers) {
opts = MTLResourceStorageModePrivate;
d->isDeviceLocal = true;
d->slotted = false;
} else {
#ifdef Q_OS_MACOS
if (!rhiD->caps.isAppleGPU && m_type != Dynamic) {
opts = MTLResourceStorageModeManaged;
d->managed = true;
}
#endif
// Have QMTL_FRAMES_IN_FLIGHT versions regardless of the type. This is
// because writing to a host visible buffer is not safe when another
// frame reading from the same buffer is still in flight.
d->slotted = !m_usage.testFlag(QRhiBuffer::StorageBuffer) // except for SSBOs written in the shader
&& !internalHostWritable; // and the internal buffers
}
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
if (i == 0 || d->slotted) {
d->buf[i] = [rhiD->d->dev newBufferWithLength: roundedSize options: opts];
if (!m_objectName.isEmpty()) {
if (!d->slotted) {
d->buf[i].label = [NSString stringWithUTF8String: m_objectName.constData()];
} else {
const QByteArray name = m_objectName + '/' + QByteArray::number(i);
d->buf[i].label = [NSString stringWithUTF8String: name.constData()];
}
}
}
}
lastActiveFrameSlot = -1;
generation += 1;
rhiD->registerResource(this);
return true;
}
QRhiBuffer::NativeBuffer QMetalBuffer::nativeBuffer()
{
if (d->slotted) {
NativeBuffer b;
Q_ASSERT(sizeof(b.objects) / sizeof(b.objects[0]) >= size_t(QMTL_FRAMES_IN_FLIGHT));
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
QRHI_RES_RHI(QRhiMetal);
rhiD->executeBufferHostWritesForSlot(this, i);
b.objects[i] = &d->buf[i];
}
b.slotCount = QMTL_FRAMES_IN_FLIGHT;
return b;
}
if (!d->isDeviceLocal) {
QRHI_RES_RHI(QRhiMetal);
rhiD->executeBufferHostWritesForSlot(this, 0);
}
return { { &d->buf[0] }, 1 };
}
char *QMetalBuffer::beginFullDynamicBufferUpdateForCurrentFrame()
{
// Shortcut the entire buffer update mechanism and allow the client to do
// the host writes directly to the buffer. This will lead to unexpected
// results when combined with QRhiResourceUpdateBatch-based updates for the
// buffer, but provides a fast path for dynamic buffers that have all their
// content changed in every frame.
Q_ASSERT(m_type == Dynamic);
Q_ASSERT(!d->isDeviceLocal);
QRHI_RES_RHI(QRhiMetal);
Q_ASSERT(rhiD->inFrame);
const int slot = d->slotted ? rhiD->currentFrameSlot : 0;
void *p = [d->buf[slot] contents];
return static_cast<char *>(p);
}
void QMetalBuffer::endFullDynamicBufferUpdateForCurrentFrame()
{
// Nothing to do: managed is never set for Dynamic buffers, and so there is
// no didModifyRange: to issue.
}
static inline MTLPixelFormat toMetalTextureFormat(QRhiTexture::Format format, QRhiTexture::Flags flags, const QRhiMetal *d)
{
#ifndef Q_OS_MACOS
Q_UNUSED(d);
#endif
const bool srgb = flags.testFlag(QRhiTexture::sRGB);
switch (format) {
case QRhiTexture::RGBA8:
return srgb ? MTLPixelFormatRGBA8Unorm_sRGB : MTLPixelFormatRGBA8Unorm;
case QRhiTexture::BGRA8:
return srgb ? MTLPixelFormatBGRA8Unorm_sRGB : MTLPixelFormatBGRA8Unorm;
case QRhiTexture::R8:
#ifdef Q_OS_MACOS
return MTLPixelFormatR8Unorm;
#else
return srgb ? MTLPixelFormatR8Unorm_sRGB : MTLPixelFormatR8Unorm;
#endif
case QRhiTexture::R8SI:
return MTLPixelFormatR8Sint;
case QRhiTexture::R8UI:
return MTLPixelFormatR8Uint;
case QRhiTexture::RG8:
#ifdef Q_OS_MACOS
return MTLPixelFormatRG8Unorm;
#else
return srgb ? MTLPixelFormatRG8Unorm_sRGB : MTLPixelFormatRG8Unorm;
#endif
case QRhiTexture::R16:
return MTLPixelFormatR16Unorm;
case QRhiTexture::RG16:
return MTLPixelFormatRG16Unorm;
case QRhiTexture::RED_OR_ALPHA8:
return MTLPixelFormatR8Unorm;
case QRhiTexture::RGBA16F:
return MTLPixelFormatRGBA16Float;
case QRhiTexture::RGBA32F:
return MTLPixelFormatRGBA32Float;
case QRhiTexture::R16F:
return MTLPixelFormatR16Float;
case QRhiTexture::R32F:
return MTLPixelFormatR32Float;
case QRhiTexture::RGB10A2:
return MTLPixelFormatRGB10A2Unorm;
case QRhiTexture::R32SI:
return MTLPixelFormatR32Sint;
case QRhiTexture::R32UI:
return MTLPixelFormatR32Uint;
case QRhiTexture::RG32SI:
return MTLPixelFormatRG32Sint;
case QRhiTexture::RG32UI:
return MTLPixelFormatRG32Uint;
case QRhiTexture::RGBA32SI:
return MTLPixelFormatRGBA32Sint;
case QRhiTexture::RGBA32UI:
return MTLPixelFormatRGBA32Uint;
#ifdef Q_OS_MACOS
case QRhiTexture::D16:
return MTLPixelFormatDepth16Unorm;
case QRhiTexture::D24:
return [d->d->dev isDepth24Stencil8PixelFormatSupported] ? MTLPixelFormatDepth24Unorm_Stencil8 : MTLPixelFormatDepth32Float;
case QRhiTexture::D24S8:
return [d->d->dev isDepth24Stencil8PixelFormatSupported] ? MTLPixelFormatDepth24Unorm_Stencil8 : MTLPixelFormatDepth32Float_Stencil8;
#else
case QRhiTexture::D16:
return MTLPixelFormatDepth32Float;
case QRhiTexture::D24:
return MTLPixelFormatDepth32Float;
case QRhiTexture::D24S8:
return MTLPixelFormatDepth32Float_Stencil8;
#endif
case QRhiTexture::D32F:
return MTLPixelFormatDepth32Float;
case QRhiTexture::D32FS8:
return MTLPixelFormatDepth32Float_Stencil8;
#ifdef Q_OS_MACOS
case QRhiTexture::BC1:
return srgb ? MTLPixelFormatBC1_RGBA_sRGB : MTLPixelFormatBC1_RGBA;
case QRhiTexture::BC2:
return srgb ? MTLPixelFormatBC2_RGBA_sRGB : MTLPixelFormatBC2_RGBA;
case QRhiTexture::BC3:
return srgb ? MTLPixelFormatBC3_RGBA_sRGB : MTLPixelFormatBC3_RGBA;
case QRhiTexture::BC4:
return MTLPixelFormatBC4_RUnorm;
case QRhiTexture::BC5:
qWarning("QRhiMetal does not support BC5");
return MTLPixelFormatInvalid;
case QRhiTexture::BC6H:
return MTLPixelFormatBC6H_RGBUfloat;
case QRhiTexture::BC7:
return srgb ? MTLPixelFormatBC7_RGBAUnorm_sRGB : MTLPixelFormatBC7_RGBAUnorm;
#else
case QRhiTexture::BC1:
case QRhiTexture::BC2:
case QRhiTexture::BC3:
case QRhiTexture::BC4:
case QRhiTexture::BC5:
case QRhiTexture::BC6H:
case QRhiTexture::BC7:
qWarning("QRhiMetal: BCx compression not supported on this platform");
return MTLPixelFormatInvalid;
#endif
#ifndef Q_OS_MACOS
case QRhiTexture::ETC2_RGB8:
return srgb ? MTLPixelFormatETC2_RGB8_sRGB : MTLPixelFormatETC2_RGB8;
case QRhiTexture::ETC2_RGB8A1:
return srgb ? MTLPixelFormatETC2_RGB8A1_sRGB : MTLPixelFormatETC2_RGB8A1;
case QRhiTexture::ETC2_RGBA8:
return srgb ? MTLPixelFormatEAC_RGBA8_sRGB : MTLPixelFormatEAC_RGBA8;
case QRhiTexture::ASTC_4x4:
return srgb ? MTLPixelFormatASTC_4x4_sRGB : MTLPixelFormatASTC_4x4_LDR;
case QRhiTexture::ASTC_5x4:
return srgb ? MTLPixelFormatASTC_5x4_sRGB : MTLPixelFormatASTC_5x4_LDR;
case QRhiTexture::ASTC_5x5:
return srgb ? MTLPixelFormatASTC_5x5_sRGB : MTLPixelFormatASTC_5x5_LDR;
case QRhiTexture::ASTC_6x5:
return srgb ? MTLPixelFormatASTC_6x5_sRGB : MTLPixelFormatASTC_6x5_LDR;
case QRhiTexture::ASTC_6x6:
return srgb ? MTLPixelFormatASTC_6x6_sRGB : MTLPixelFormatASTC_6x6_LDR;
case QRhiTexture::ASTC_8x5:
return srgb ? MTLPixelFormatASTC_8x5_sRGB : MTLPixelFormatASTC_8x5_LDR;
case QRhiTexture::ASTC_8x6:
return srgb ? MTLPixelFormatASTC_8x6_sRGB : MTLPixelFormatASTC_8x6_LDR;
case QRhiTexture::ASTC_8x8:
return srgb ? MTLPixelFormatASTC_8x8_sRGB : MTLPixelFormatASTC_8x8_LDR;
case QRhiTexture::ASTC_10x5:
return srgb ? MTLPixelFormatASTC_10x5_sRGB : MTLPixelFormatASTC_10x5_LDR;
case QRhiTexture::ASTC_10x6:
return srgb ? MTLPixelFormatASTC_10x6_sRGB : MTLPixelFormatASTC_10x6_LDR;
case QRhiTexture::ASTC_10x8:
return srgb ? MTLPixelFormatASTC_10x8_sRGB : MTLPixelFormatASTC_10x8_LDR;
case QRhiTexture::ASTC_10x10:
return srgb ? MTLPixelFormatASTC_10x10_sRGB : MTLPixelFormatASTC_10x10_LDR;
case QRhiTexture::ASTC_12x10:
return srgb ? MTLPixelFormatASTC_12x10_sRGB : MTLPixelFormatASTC_12x10_LDR;
case QRhiTexture::ASTC_12x12:
return srgb ? MTLPixelFormatASTC_12x12_sRGB : MTLPixelFormatASTC_12x12_LDR;
#else
case QRhiTexture::ETC2_RGB8:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatETC2_RGB8_sRGB : MTLPixelFormatETC2_RGB8;
qWarning("QRhiMetal: ETC2 compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ETC2_RGB8A1:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatETC2_RGB8A1_sRGB : MTLPixelFormatETC2_RGB8A1;
qWarning("QRhiMetal: ETC2 compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ETC2_RGBA8:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatEAC_RGBA8_sRGB : MTLPixelFormatEAC_RGBA8;
qWarning("QRhiMetal: ETC2 compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_4x4:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_4x4_sRGB : MTLPixelFormatASTC_4x4_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_5x4:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_5x4_sRGB : MTLPixelFormatASTC_5x4_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_5x5:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_5x5_sRGB : MTLPixelFormatASTC_5x5_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_6x5:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_6x5_sRGB : MTLPixelFormatASTC_6x5_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_6x6:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_6x6_sRGB : MTLPixelFormatASTC_6x6_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_8x5:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_8x5_sRGB : MTLPixelFormatASTC_8x5_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_8x6:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_8x6_sRGB : MTLPixelFormatASTC_8x6_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_8x8:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_8x8_sRGB : MTLPixelFormatASTC_8x8_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_10x5:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_10x5_sRGB : MTLPixelFormatASTC_10x5_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_10x6:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_10x6_sRGB : MTLPixelFormatASTC_10x6_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_10x8:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_10x8_sRGB : MTLPixelFormatASTC_10x8_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_10x10:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_10x10_sRGB : MTLPixelFormatASTC_10x10_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_12x10:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_12x10_sRGB : MTLPixelFormatASTC_12x10_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
case QRhiTexture::ASTC_12x12:
if (d->caps.isAppleGPU)
return srgb ? MTLPixelFormatASTC_12x12_sRGB : MTLPixelFormatASTC_12x12_LDR;
qWarning("QRhiMetal: ASTC compression not supported on this platform");
return MTLPixelFormatInvalid;
#endif
default:
Q_UNREACHABLE();
return MTLPixelFormatInvalid;
}
}
QMetalRenderBuffer::QMetalRenderBuffer(QRhiImplementation *rhi, Type type, const QSize &pixelSize,
int sampleCount, QRhiRenderBuffer::Flags flags,
QRhiTexture::Format backingFormatHint)
: QRhiRenderBuffer(rhi, type, pixelSize, sampleCount, flags, backingFormatHint),
d(new QMetalRenderBufferData)
{
}
QMetalRenderBuffer::~QMetalRenderBuffer()
{
destroy();
delete d;
}
void QMetalRenderBuffer::destroy()
{
if (!d->tex)
return;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::RenderBuffer;
e.lastActiveFrameSlot = lastActiveFrameSlot;
e.renderbuffer.texture = d->tex;
d->tex = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
bool QMetalRenderBuffer::create()
{
if (d->tex)
destroy();
if (m_pixelSize.isEmpty())
return false;
QRHI_RES_RHI(QRhiMetal);
samples = rhiD->effectiveSampleCount(m_sampleCount);
MTLTextureDescriptor *desc = [[MTLTextureDescriptor alloc] init];
desc.textureType = samples > 1 ? MTLTextureType2DMultisample : MTLTextureType2D;
desc.width = NSUInteger(m_pixelSize.width());
desc.height = NSUInteger(m_pixelSize.height());
if (samples > 1)
desc.sampleCount = NSUInteger(samples);
desc.resourceOptions = MTLResourceStorageModePrivate;
desc.usage = MTLTextureUsageRenderTarget;
// Memoryless contents cannot survive the render pass getting interrupted and
// continued on another command encoder, which is what NoTransientBacking is
// there to avoid.
const bool canBeMemoryless = !m_flags.testFlag(QRhiRenderBuffer::NoTransientBacking);
switch (m_type) {
case DepthStencil:
#ifdef Q_OS_MACOS
if (rhiD->caps.isAppleGPU && canBeMemoryless) {
desc.storageMode = MTLStorageModeMemoryless;
d->format = MTLPixelFormatDepth32Float_Stencil8;
} else {
desc.storageMode = MTLStorageModePrivate;
d->format = rhiD->d->dev.depth24Stencil8PixelFormatSupported
? MTLPixelFormatDepth24Unorm_Stencil8 : MTLPixelFormatDepth32Float_Stencil8;
}
#else
desc.storageMode = canBeMemoryless ? MTLStorageModeMemoryless : MTLStorageModePrivate;
d->format = MTLPixelFormatDepth32Float_Stencil8;
#endif
desc.pixelFormat = d->format;
break;
case Color:
desc.storageMode = MTLStorageModePrivate;
if (m_backingFormatHint != QRhiTexture::UnknownFormat)
d->format = toMetalTextureFormat(m_backingFormatHint, {}, rhiD);
else
d->format = MTLPixelFormatRGBA8Unorm;
desc.pixelFormat = d->format;
break;
default:
Q_UNREACHABLE();
break;
}
d->tex = [rhiD->d->dev newTextureWithDescriptor: desc];
[desc release];
if (!m_objectName.isEmpty())
d->tex.label = [NSString stringWithUTF8String: m_objectName.constData()];
lastActiveFrameSlot = -1;
generation += 1;
rhiD->registerResource(this);
return true;
}
QRhiTexture::Format QMetalRenderBuffer::backingFormat() const
{
if (m_backingFormatHint != QRhiTexture::UnknownFormat)
return m_backingFormatHint;
else
return m_type == Color ? QRhiTexture::RGBA8 : QRhiTexture::UnknownFormat;
}
QMetalTexture::QMetalTexture(QRhiImplementation *rhi, Format format, const QSize &pixelSize, int depth,
int arraySize, int sampleCount, Flags flags)
: QRhiTexture(rhi, format, pixelSize, depth, arraySize, sampleCount, flags),
d(new QMetalTextureData(this))
{
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i)
d->stagingBuf[i] = nil;
for (int i = 0; i < QRhi::MAX_MIP_LEVELS; ++i)
d->perLevelViews[i] = nil;
}
QMetalTexture::~QMetalTexture()
{
destroy();
delete d;
}
void QMetalTexture::destroy()
{
if (!d->tex)
return;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::Texture;
e.lastActiveFrameSlot = lastActiveFrameSlot;
e.texture.texture = d->owns ? d->tex : nil;
d->tex = nil;
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
e.texture.stagingBuffers[i] = d->stagingBuf[i];
d->stagingBuf[i] = nil;
}
for (int i = 0; i < QRhi::MAX_MIP_LEVELS; ++i) {
e.texture.views[i] = d->perLevelViews[i];
d->perLevelViews[i] = nil;
}
e.texture.samplingView = d->samplingView;
d->samplingView = nil;
e.texture.writeView = d->writeView;
d->writeView = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
bool QMetalTexture::prepareCreate(QSize *adjustedSize)
{
if (d->tex)
destroy();
const bool isCube = m_flags.testFlag(CubeMap);
const bool is3D = m_flags.testFlag(ThreeDimensional);
const bool isArray = m_flags.testFlag(TextureArray);
const bool hasMipMaps = m_flags.testFlag(MipMapped);
const bool is1D = m_flags.testFlag(OneDimensional);
const QSize size = is1D ? QSize(qMax(1, m_pixelSize.width()), 1)
: (m_pixelSize.isEmpty() ? QSize(1, 1) : m_pixelSize);
QRHI_RES_RHI(QRhiMetal);
d->format = toMetalTextureFormat(m_format, m_flags, rhiD);
if (m_writeViewFormat.format != UnknownFormat) {
d->viewFormat = toMetalTextureFormat(m_writeViewFormat.format,
m_writeViewFormat.srgb ? sRGB : Flags(), rhiD);
} else {
d->viewFormat = d->format;
}
if (m_readViewFormat.format != UnknownFormat) {
d->viewFormatForSampling = toMetalTextureFormat(m_readViewFormat.format,
m_readViewFormat.srgb ? sRGB : Flags(), rhiD);
} else {
d->viewFormatForSampling = d->format;
}
mipLevelCount = hasMipMaps ? rhiD->q->mipLevelsForSize(size) : 1;
samples = rhiD->effectiveSampleCount(m_sampleCount);
if (samples > 1) {
if (isCube) {
qWarning("Cubemap texture cannot be multisample");
return false;
}
if (is3D) {
qWarning("3D texture cannot be multisample");
return false;
}
if (hasMipMaps) {
qWarning("Multisample texture cannot have mipmaps");
return false;
}
}
if (isCube && is3D) {
qWarning("Texture cannot be both cube and 3D");
return false;
}
if (isArray && is3D) {
qWarning("Texture cannot be both array and 3D");
return false;
}
if (is1D && is3D) {
qWarning("Texture cannot be both 1D and 3D");
return false;
}
if (is1D && isCube) {
qWarning("Texture cannot be both 1D and cube");
return false;
}
if (m_depth > 1 && !is3D) {
qWarning("Texture cannot have a depth of %d when it is not 3D", m_depth);
return false;
}
if (m_arraySize > 0 && !isArray) {
qWarning("Texture cannot have an array size of %d when it is not an array", m_arraySize);
return false;
}
if (m_arraySize < 1 && isArray) {
qWarning("Texture is an array but array size is %d", m_arraySize);
return false;
}
if (!rhiD->textureFormatInfo(m_format, size, nullptr, nullptr, nullptr))
return false;
if (adjustedSize)
*adjustedSize = size;
return true;
}
bool QMetalTexture::create()
{
QSize size;
if (!prepareCreate(&size))
return false;
MTLTextureDescriptor *desc = [[MTLTextureDescriptor alloc] init];
const bool isCube = m_flags.testFlag(CubeMap);
const bool is3D = m_flags.testFlag(ThreeDimensional);
const bool isArray = m_flags.testFlag(TextureArray);
const bool is1D = m_flags.testFlag(OneDimensional);
if (isCube) {
desc.textureType = MTLTextureTypeCube;
} else if (is3D) {
desc.textureType = MTLTextureType3D;
} else if (is1D) {
desc.textureType = isArray ? MTLTextureType1DArray : MTLTextureType1D;
} else if (isArray) {
desc.textureType = samples > 1 ? MTLTextureType2DMultisampleArray : MTLTextureType2DArray;
} else {
desc.textureType = samples > 1 ? MTLTextureType2DMultisample : MTLTextureType2D;
}
desc.pixelFormat = d->format;
desc.width = NSUInteger(size.width());
desc.height = NSUInteger(size.height());
desc.depth = is3D ? qMax(1, m_depth) : 1;
desc.mipmapLevelCount = NSUInteger(mipLevelCount);
if (samples > 1)
desc.sampleCount = NSUInteger(samples);
if (isArray)
desc.arrayLength = NSUInteger(qMax(0, m_arraySize));
desc.resourceOptions = MTLResourceStorageModePrivate;
desc.storageMode = MTLStorageModePrivate;
desc.usage = MTLTextureUsageShaderRead;
if (m_flags.testFlag(RenderTarget))
desc.usage |= MTLTextureUsageRenderTarget;
if (m_flags.testFlag(UsedWithLoadStore))
desc.usage |= MTLTextureUsageShaderWrite;
// Metal requires this only when the view changes the component layout, and
// explicitly says not to set it for linear <-> sRGB views. A view of the
// same QRhi format with a different sRGB setting, or over an array slice
// range, therefore does not need it.
const bool writeViewChangesFormat = m_writeViewFormat.format != UnknownFormat
&& m_writeViewFormat.format != m_format;
const bool readViewChangesFormat = m_readViewFormat.format != UnknownFormat
&& m_readViewFormat.format != m_format;
if (writeViewChangesFormat || readViewChangesFormat)
desc.usage |= MTLTextureUsagePixelFormatView;
QRHI_RES_RHI(QRhiMetal);
d->tex = [rhiD->d->dev newTextureWithDescriptor: desc];
[desc release];
if (!m_objectName.isEmpty())
d->tex.label = [NSString stringWithUTF8String: m_objectName.constData()];
d->owns = true;
if (!d->createViews())
return false;
lastActiveFrameSlot = -1;
generation += 1;
rhiD->registerResource(this);
return true;
}
bool QMetalTexture::createFrom(QRhiTexture::NativeTexture src)
{
id<MTLTexture> tex = id<MTLTexture>(src.object);
if (tex == 0)
return false;
if (!prepareCreate())
return false;
d->tex = tex;
d->owns = false;
if (!d->createViews())
return false;
lastActiveFrameSlot = -1;
generation += 1;
QRHI_RES_RHI(QRhiMetal);
rhiD->registerResource(this);
return true;
}
QRhiTexture::NativeTexture QMetalTexture::nativeTexture()
{
return {quint64(d->tex), 0};
}
bool QMetalTextureData::createViews()
{
Q_ASSERT(!samplingView && !writeView);
const bool isCube = q->m_flags.testFlag(QRhiTexture::CubeMap);
const bool isArray = q->m_flags.testFlag(QRhiTexture::TextureArray);
const bool hasArrayRange = isArray && q->m_arrayRangeStart >= 0 && q->m_arrayRangeLength >= 0;
const NSUInteger sliceCount = isCube ? 6 : (isArray ? NSUInteger(qMax(0, q->m_arraySize)) : 1);
const NSRange levels = NSMakeRange(0, NSUInteger(q->mipLevelCount));
const MTLTextureType type = [tex textureType];
id<MTLTexture> newSamplingView = nil;
id<MTLTexture> newWriteView = nil;
if (viewFormatForSampling != format || hasArrayRange) {
const NSRange slices = hasArrayRange
? NSMakeRange(NSUInteger(q->m_arrayRangeStart), NSUInteger(q->m_arrayRangeLength))
: NSMakeRange(0, sliceCount);
newSamplingView = [tex newTextureViewWithPixelFormat: viewFormatForSampling
textureType: type levels: levels slices: slices];
if (!newSamplingView) {
qWarning("QRhiMetal: Failed to create texture view used for sampling");
return false;
}
}
if (viewFormat != format) {
newWriteView = [tex newTextureViewWithPixelFormat: viewFormat
textureType: type levels: levels
slices: NSMakeRange(0, sliceCount)];
if (!newWriteView) {
qWarning("QRhiMetal: Failed to create texture view used for rendering");
[newSamplingView release];
return false;
}
}
samplingView = newSamplingView;
writeView = newWriteView;
return true;
}
id<MTLTexture> QMetalTextureData::viewForLevel(int level)
{
Q_ASSERT(level >= 0 && level < int(q->mipLevelCount));
if (perLevelViews[level])
return perLevelViews[level];
const MTLTextureType type = [tex textureType];
const bool isCube = q->m_flags.testFlag(QRhiTexture::CubeMap);
const bool isArray = q->m_flags.testFlag(QRhiTexture::TextureArray);
id<MTLTexture> view = [tex newTextureViewWithPixelFormat: viewFormat textureType: type
levels: NSMakeRange(NSUInteger(level), 1)
slices: NSMakeRange(0, isCube ? 6 : (isArray ? qMax(0, q->m_arraySize) : 1))];
perLevelViews[level] = view;
return view;
}
QMetalSampler::QMetalSampler(QRhiImplementation *rhi, Filter magFilter, Filter minFilter, Filter mipmapMode,
AddressMode u, AddressMode v, AddressMode w)
: QRhiSampler(rhi, magFilter, minFilter, mipmapMode, u, v, w),
d(new QMetalSamplerData)
{
}
QMetalSampler::~QMetalSampler()
{
destroy();
delete d;
}
void QMetalSampler::destroy()
{
if (!d->samplerState)
return;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::Sampler;
e.lastActiveFrameSlot = lastActiveFrameSlot;
e.sampler.samplerState = d->samplerState;
d->samplerState = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
static inline MTLSamplerMinMagFilter toMetalFilter(QRhiSampler::Filter f)
{
switch (f) {
case QRhiSampler::Nearest:
return MTLSamplerMinMagFilterNearest;
case QRhiSampler::Linear:
return MTLSamplerMinMagFilterLinear;
default:
Q_UNREACHABLE();
return MTLSamplerMinMagFilterNearest;
}
}
static inline MTLSamplerMipFilter toMetalMipmapMode(QRhiSampler::Filter f)
{
switch (f) {
case QRhiSampler::None:
return MTLSamplerMipFilterNotMipmapped;
case QRhiSampler::Nearest:
return MTLSamplerMipFilterNearest;
case QRhiSampler::Linear:
return MTLSamplerMipFilterLinear;
default:
Q_UNREACHABLE();
return MTLSamplerMipFilterNotMipmapped;
}
}
static inline MTLSamplerAddressMode toMetalAddressMode(QRhiSampler::AddressMode m)
{
switch (m) {
case QRhiSampler::Repeat:
return MTLSamplerAddressModeRepeat;
case QRhiSampler::ClampToEdge:
return MTLSamplerAddressModeClampToEdge;
case QRhiSampler::Mirror:
return MTLSamplerAddressModeMirrorRepeat;
default:
Q_UNREACHABLE();
return MTLSamplerAddressModeClampToEdge;
}
}
static inline MTLCompareFunction toMetalTextureCompareFunction(QRhiSampler::CompareOp op)
{
switch (op) {
case QRhiSampler::Never:
return MTLCompareFunctionNever;
case QRhiSampler::Less:
return MTLCompareFunctionLess;
case QRhiSampler::Equal:
return MTLCompareFunctionEqual;
case QRhiSampler::LessOrEqual:
return MTLCompareFunctionLessEqual;
case QRhiSampler::Greater:
return MTLCompareFunctionGreater;
case QRhiSampler::NotEqual:
return MTLCompareFunctionNotEqual;
case QRhiSampler::GreaterOrEqual:
return MTLCompareFunctionGreaterEqual;
case QRhiSampler::Always:
return MTLCompareFunctionAlways;
default:
Q_UNREACHABLE();
return MTLCompareFunctionNever;
}
}
bool QMetalSampler::create()
{
if (d->samplerState)
destroy();
MTLSamplerDescriptor *desc = [[MTLSamplerDescriptor alloc] init];
desc.minFilter = toMetalFilter(m_minFilter);
desc.magFilter = toMetalFilter(m_magFilter);
desc.mipFilter = toMetalMipmapMode(m_mipmapMode);
desc.sAddressMode = toMetalAddressMode(m_addressU);
desc.tAddressMode = toMetalAddressMode(m_addressV);
desc.rAddressMode = toMetalAddressMode(m_addressW);
desc.compareFunction = toMetalTextureCompareFunction(m_compareOp);
QRHI_RES_RHI(QRhiMetal);
// Whether this sampler ends up in an argument buffer is not known here, and
// a sampler state cannot be changed afterwards. Metal gives no warning when
// one without this is used with an argument buffer, it just faults the GPU.
// So set it always as long as ICBs are supported.
desc.supportArgumentBuffers = rhiD->caps.indirectCommandBuffers ? YES : NO;
d->samplerState = [rhiD->d->dev newSamplerStateWithDescriptor: desc];
[desc release];
if (!d->samplerState) {
// Sampler states with supportArgumentBuffers set draw on a per-process
// quota (MTLDevice.maxArgumentBufferSamplerCount), so mention that as
// the likely reason for a failure that is otherwise hard to explain.
qWarning("Failed to create Metal sampler state. The number of unique sampler "
"states with argument buffer support may have exceeded the limit of %u.",
uint(rhiD->d->dev.maxArgumentBufferSamplerCount));
return false;
}
lastActiveFrameSlot = -1;
generation += 1;
rhiD->registerResource(this);
return true;
}
QMetalShadingRateMap::QMetalShadingRateMap(QRhiImplementation *rhi)
: QRhiShadingRateMap(rhi),
d(new QMetalShadingRateMapData)
{
}
QMetalShadingRateMap::~QMetalShadingRateMap()
{
destroy();
delete d;
}
void QMetalShadingRateMap::destroy()
{
if (!d->rateMap)
return;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::ShadingRateMap;
e.lastActiveFrameSlot = lastActiveFrameSlot;
e.shadingRateMap.rateMap = d->rateMap;
d->rateMap = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
bool QMetalShadingRateMap::createFrom(NativeShadingRateMap src)
{
if (d->rateMap)
destroy();
d->rateMap = (id<MTLRasterizationRateMap>) (quintptr(src.object));
if (!d->rateMap)
return false;
[d->rateMap retain];
lastActiveFrameSlot = -1;
generation += 1;
QRHI_RES_RHI(QRhiMetal);
rhiD->registerResource(this);
return true;
}
QSize QMetalShadingRateMap::logicalSize() const
{
if (!d->rateMap)
return QSize();
const MTLSize screenSize = [d->rateMap screenSize];
return QSize(int(screenSize.width), int(screenSize.height));
}
// dummy, no Vulkan-style RenderPass+Framebuffer concept here.
// We do have MTLRenderPassDescriptor of course, but it will be created on the fly for each pass.
QMetalRenderPassDescriptor::QMetalRenderPassDescriptor(QRhiImplementation *rhi)
: QRhiRenderPassDescriptor(rhi)
{
serializedFormatData.reserve(16);
}
QMetalRenderPassDescriptor::~QMetalRenderPassDescriptor()
{
destroy();
}
void QMetalRenderPassDescriptor::destroy()
{
QRHI_RES_RHI(QRhiMetal);
if (rhiD)
rhiD->unregisterResource(this);
}
bool QMetalRenderPassDescriptor::isCompatible(const QRhiRenderPassDescriptor *other) const
{
if (!other)
return false;
const QMetalRenderPassDescriptor *o = QRHI_RES(const QMetalRenderPassDescriptor, other);
if (colorAttachmentCount != o->colorAttachmentCount)
return false;
if (hasDepthStencil != o->hasDepthStencil)
return false;
for (int i = 0; i < colorAttachmentCount; ++i) {
if (colorFormat[i] != o->colorFormat[i])
return false;
}
if (hasDepthStencil) {
if (dsFormat != o->dsFormat)
return false;
}
if (hasShadingRateMap != o->hasShadingRateMap)
return false;
return true;
}
void QMetalRenderPassDescriptor::updateSerializedFormat()
{
serializedFormatData.clear();
auto p = std::back_inserter(serializedFormatData);
*p++ = colorAttachmentCount;
*p++ = hasDepthStencil;
for (int i = 0; i < colorAttachmentCount; ++i)
*p++ = colorFormat[i];
*p++ = hasDepthStencil ? dsFormat : 0;
*p++ = hasShadingRateMap;
}
QRhiRenderPassDescriptor *QMetalRenderPassDescriptor::newCompatibleRenderPassDescriptor() const
{
QMetalRenderPassDescriptor *rpD = new QMetalRenderPassDescriptor(m_rhi);
rpD->colorAttachmentCount = colorAttachmentCount;
rpD->hasDepthStencil = hasDepthStencil;
memcpy(rpD->colorFormat, colorFormat, sizeof(colorFormat));
rpD->dsFormat = dsFormat;
rpD->hasShadingRateMap = hasShadingRateMap;
rpD->updateSerializedFormat();
QRHI_RES_RHI(QRhiMetal);
rhiD->registerResource(rpD, false);
return rpD;
}
QVector<quint32> QMetalRenderPassDescriptor::serializedFormat() const
{
return serializedFormatData;
}
QMetalSwapChainRenderTarget::QMetalSwapChainRenderTarget(QRhiImplementation *rhi, QRhiSwapChain *swapchain)
: QRhiSwapChainRenderTarget(rhi, swapchain),
d(new QMetalRenderTargetData)
{
}
QMetalSwapChainRenderTarget::~QMetalSwapChainRenderTarget()
{
destroy();
delete d;
}
void QMetalSwapChainRenderTarget::destroy()
{
// nothing to do here
}
QSize QMetalSwapChainRenderTarget::pixelSize() const
{
return d->pixelSize;
}
float QMetalSwapChainRenderTarget::devicePixelRatio() const
{
return d->dpr;
}
int QMetalSwapChainRenderTarget::sampleCount() const
{
return d->sampleCount;
}
QMetalTextureRenderTarget::QMetalTextureRenderTarget(QRhiImplementation *rhi,
const QRhiTextureRenderTargetDescription &desc,
Flags flags)
: QRhiTextureRenderTarget(rhi, desc, flags),
d(new QMetalRenderTargetData)
{
}
QMetalTextureRenderTarget::~QMetalTextureRenderTarget()
{
destroy();
delete d;
}
void QMetalTextureRenderTarget::destroy()
{
QRHI_RES_RHI(QRhiMetal);
if (rhiD)
rhiD->unregisterResource(this);
}
QRhiRenderPassDescriptor *QMetalTextureRenderTarget::newCompatibleRenderPassDescriptor()
{
const int colorAttachmentCount = int(m_desc.colorAttachmentCount());
QMetalRenderPassDescriptor *rpD = new QMetalRenderPassDescriptor(m_rhi);
rpD->colorAttachmentCount = colorAttachmentCount;
rpD->hasDepthStencil = m_desc.depthStencilBuffer() || m_desc.depthTexture();
for (int i = 0; i < colorAttachmentCount; ++i) {
const QRhiColorAttachment *colorAtt = m_desc.colorAttachmentAt(i);
QMetalTexture *texD = QRHI_RES(QMetalTexture, colorAtt->texture());
QMetalRenderBuffer *rbD = QRHI_RES(QMetalRenderBuffer, colorAtt->renderBuffer());
rpD->colorFormat[i] = int(texD ? texD->d->viewFormat : rbD->d->format);
}
if (m_desc.depthTexture())
rpD->dsFormat = int(QRHI_RES(QMetalTexture, m_desc.depthTexture())->d->viewFormat);
else if (m_desc.depthStencilBuffer())
rpD->dsFormat = int(QRHI_RES(QMetalRenderBuffer, m_desc.depthStencilBuffer())->d->format);
rpD->hasShadingRateMap = m_desc.shadingRateMap() != nullptr;
rpD->updateSerializedFormat();
QRHI_RES_RHI(QRhiMetal);
rhiD->registerResource(rpD, false);
return rpD;
}
bool QMetalTextureRenderTarget::create()
{
QRHI_RES_RHI(QRhiMetal);
Q_ASSERT(m_desc.colorAttachmentCount() > 0 || m_desc.depthTexture());
Q_ASSERT(!m_desc.depthStencilBuffer() || !m_desc.depthTexture());
const bool hasDepthStencil = m_desc.depthStencilBuffer() || m_desc.depthTexture();
d->colorAttCount = 0;
int attIndex = 0;
for (auto it = m_desc.cbeginColorAttachments(), itEnd = m_desc.cendColorAttachments(); it != itEnd; ++it, ++attIndex) {
d->colorAttCount += 1;
QMetalTexture *texD = QRHI_RES(QMetalTexture, it->texture());
QMetalRenderBuffer *rbD = QRHI_RES(QMetalRenderBuffer, it->renderBuffer());
Q_ASSERT(texD || rbD);
id<MTLTexture> dst = nil;
bool is3D = false;
if (texD) {
dst = texD->d->textureForWrite();
if (attIndex == 0) {
d->pixelSize = rhiD->q->sizeForMipLevel(it->level(), texD->pixelSize());
d->sampleCount = texD->samples;
}
is3D = texD->flags().testFlag(QRhiTexture::ThreeDimensional);
} else if (rbD) {
dst = rbD->d->tex;
if (attIndex == 0) {
d->pixelSize = rbD->pixelSize();
d->sampleCount = rbD->samples;
}
}
QMetalRenderTargetData::ColorAtt colorAtt;
colorAtt.tex = dst;
colorAtt.arrayLayer = is3D ? 0 : it->layer();
colorAtt.slice = is3D ? it->layer() : 0;
colorAtt.level = it->level();
QMetalTexture *resTexD = QRHI_RES(QMetalTexture, it->resolveTexture());
colorAtt.resolveTex = resTexD ? resTexD->d->textureForWrite() : nil;
colorAtt.resolveLayer = it->resolveLayer();
colorAtt.resolveLevel = it->resolveLevel();
d->fb.colorAtt[attIndex] = colorAtt;
}
d->dpr = 1;
if (hasDepthStencil) {
if (m_desc.depthTexture()) {
QMetalTexture *depthTexD = QRHI_RES(QMetalTexture, m_desc.depthTexture());
d->fb.dsTex = depthTexD->d->textureForWrite();
d->fb.hasStencil = rhiD->isStencilSupportingFormat(depthTexD->format());
d->fb.depthNeedsStore = !m_flags.testFlag(DoNotStoreDepthStencilContents) && !m_desc.depthResolveTexture();
d->fb.preserveDs = m_flags.testFlag(QRhiTextureRenderTarget::PreserveDepthStencilContents);
if (d->colorAttCount == 0) {
d->pixelSize = depthTexD->pixelSize();
d->sampleCount = depthTexD->samples;
}
} else {
QMetalRenderBuffer *depthRbD = QRHI_RES(QMetalRenderBuffer, m_desc.depthStencilBuffer());
d->fb.dsTex = depthRbD->d->tex;
d->fb.hasStencil = true;
d->fb.depthNeedsStore = false;
d->fb.preserveDs = false;
if (d->colorAttCount == 0) {
d->pixelSize = depthRbD->pixelSize();
d->sampleCount = depthRbD->samples;
}
}
if (m_desc.depthResolveTexture()) {
QMetalTexture *depthResolveTexD = QRHI_RES(QMetalTexture, m_desc.depthResolveTexture());
d->fb.dsResolveTex = depthResolveTexD->d->textureForWrite();
}
d->dsAttCount = 1;
} else {
d->dsAttCount = 0;
}
if (d->colorAttCount > 0)
d->fb.preserveColor = m_flags.testFlag(QRhiTextureRenderTarget::PreserveColorContents);
QRhiRenderTargetAttachmentTracker::updateResIdList<QMetalTexture, QMetalRenderBuffer>(m_desc, &d->currentResIdList);
rhiD->registerResource(this, false);
return true;
}
QSize QMetalTextureRenderTarget::pixelSize() const
{
if (!QRhiRenderTargetAttachmentTracker::isUpToDate<QMetalTexture, QMetalRenderBuffer>(m_desc, d->currentResIdList))
const_cast<QMetalTextureRenderTarget *>(this)->create();
return d->pixelSize;
}
float QMetalTextureRenderTarget::devicePixelRatio() const
{
return d->dpr;
}
int QMetalTextureRenderTarget::sampleCount() const
{
return d->sampleCount;
}
QMetalShaderResourceBindings::QMetalShaderResourceBindings(QRhiImplementation *rhi)
: QRhiShaderResourceBindings(rhi)
{
}
QMetalShaderResourceBindings::~QMetalShaderResourceBindings()
{
destroy();
}
void QMetalShaderResourceBindings::destroy()
{
sortedBindings.clear();
maxBinding = -1;
QRHI_RES_RHI(QRhiMetal);
if (rhiD)
rhiD->unregisterResource(this);
}
bool QMetalShaderResourceBindings::create()
{
if (!sortedBindings.isEmpty())
destroy();
QRHI_RES_RHI(QRhiMetal);
if (!rhiD->sanityCheckShaderResourceBindings(this))
return false;
rhiD->updateLayoutDesc(this);
std::copy(m_bindings.cbegin(), m_bindings.cend(), std::back_inserter(sortedBindings));
std::sort(sortedBindings.begin(), sortedBindings.end(), QRhiImplementation::sortedBindingLessThan);
if (!sortedBindings.isEmpty())
maxBinding = QRhiImplementation::shaderResourceBindingData(sortedBindings.last())->binding;
else
maxBinding = -1;
boundResourceData.resize(sortedBindings.count());
for (BoundResourceData &bd : boundResourceData)
bd = {};
generation += 1;
rhiD->registerResource(this, false);
return true;
}
void QMetalShaderResourceBindings::updateResources(UpdateFlags flags)
{
sortedBindings.clear();
std::copy(m_bindings.cbegin(), m_bindings.cend(), std::back_inserter(sortedBindings));
if (!flags.testFlag(BindingsAreSorted))
std::sort(sortedBindings.begin(), sortedBindings.end(), QRhiImplementation::sortedBindingLessThan);
for (BoundResourceData &bd : boundResourceData)
bd = {};
generation += 1;
}
QMetalGraphicsPipeline::QMetalGraphicsPipeline(QRhiImplementation *rhi)
: QRhiGraphicsPipeline(rhi),
d(new QMetalGraphicsPipelineData)
{
d->q = this;
d->tess.q = d;
}
QMetalGraphicsPipeline::~QMetalGraphicsPipeline()
{
destroy();
delete d;
}
void QMetalGraphicsPipeline::destroy()
{
d->vs.destroy();
d->fs.destroy();
d->icbCapable = false;
d->tess.compVs[0].destroy();
d->tess.compVs[1].destroy();
d->tess.compVs[2].destroy();
d->tess.compTesc.destroy();
d->tess.vertTese.destroy();
qDeleteAll(d->extraBufMgr.deviceLocalWorkBuffers);
d->extraBufMgr.deviceLocalWorkBuffers.clear();
qDeleteAll(d->extraBufMgr.hostVisibleWorkBuffers);
d->extraBufMgr.hostVisibleWorkBuffers.clear();
delete d->bufferSizeBuffer;
d->bufferSizeBuffer = nullptr;
if (!d->ps && !d->ds
&& !d->tess.vertexComputeState[0] && !d->tess.vertexComputeState[1] && !d->tess.vertexComputeState[2]
&& !d->tess.tessControlComputeState)
{
return;
}
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::GraphicsPipeline;
e.lastActiveFrameSlot = lastActiveFrameSlot;
e.graphicsPipeline.pipelineState = d->ps;
e.graphicsPipeline.depthStencilState = d->ds;
e.graphicsPipeline.tessVertexComputeState = d->tess.vertexComputeState;
e.graphicsPipeline.tessTessControlComputeState = d->tess.tessControlComputeState;
d->ps = nil;
d->ds = nil;
d->tess.vertexComputeState = {};
d->tess.tessControlComputeState = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
static inline MTLVertexFormat toMetalAttributeFormat(QRhiVertexInputAttribute::Format format)
{
switch (format) {
case QRhiVertexInputAttribute::Float4:
return MTLVertexFormatFloat4;
case QRhiVertexInputAttribute::Float3:
return MTLVertexFormatFloat3;
case QRhiVertexInputAttribute::Float2:
return MTLVertexFormatFloat2;
case QRhiVertexInputAttribute::Float:
return MTLVertexFormatFloat;
case QRhiVertexInputAttribute::UNormByte4:
return MTLVertexFormatUChar4Normalized;
case QRhiVertexInputAttribute::UNormByte2:
return MTLVertexFormatUChar2Normalized;
case QRhiVertexInputAttribute::UNormByte:
return MTLVertexFormatUCharNormalized;
case QRhiVertexInputAttribute::UInt4:
return MTLVertexFormatUInt4;
case QRhiVertexInputAttribute::UInt3:
return MTLVertexFormatUInt3;
case QRhiVertexInputAttribute::UInt2:
return MTLVertexFormatUInt2;
case QRhiVertexInputAttribute::UInt:
return MTLVertexFormatUInt;
case QRhiVertexInputAttribute::SInt4:
return MTLVertexFormatInt4;
case QRhiVertexInputAttribute::SInt3:
return MTLVertexFormatInt3;
case QRhiVertexInputAttribute::SInt2:
return MTLVertexFormatInt2;
case QRhiVertexInputAttribute::SInt:
return MTLVertexFormatInt;
case QRhiVertexInputAttribute::Half4:
return MTLVertexFormatHalf4;
case QRhiVertexInputAttribute::Half3:
return MTLVertexFormatHalf3;
case QRhiVertexInputAttribute::Half2:
return MTLVertexFormatHalf2;
case QRhiVertexInputAttribute::Half:
return MTLVertexFormatHalf;
case QRhiVertexInputAttribute::UShort4:
return MTLVertexFormatUShort4;
case QRhiVertexInputAttribute::UShort3:
return MTLVertexFormatUShort3;
case QRhiVertexInputAttribute::UShort2:
return MTLVertexFormatUShort2;
case QRhiVertexInputAttribute::UShort:
return MTLVertexFormatUShort;
case QRhiVertexInputAttribute::SShort4:
return MTLVertexFormatShort4;
case QRhiVertexInputAttribute::SShort3:
return MTLVertexFormatShort3;
case QRhiVertexInputAttribute::SShort2:
return MTLVertexFormatShort2;
case QRhiVertexInputAttribute::SShort:
return MTLVertexFormatShort;
default:
Q_UNREACHABLE();
return MTLVertexFormatFloat4;
}
}
static inline MTLBlendFactor toMetalBlendFactor(QRhiGraphicsPipeline::BlendFactor f)
{
switch (f) {
case QRhiGraphicsPipeline::Zero:
return MTLBlendFactorZero;
case QRhiGraphicsPipeline::One:
return MTLBlendFactorOne;
case QRhiGraphicsPipeline::SrcColor:
return MTLBlendFactorSourceColor;
case QRhiGraphicsPipeline::OneMinusSrcColor:
return MTLBlendFactorOneMinusSourceColor;
case QRhiGraphicsPipeline::DstColor:
return MTLBlendFactorDestinationColor;
case QRhiGraphicsPipeline::OneMinusDstColor:
return MTLBlendFactorOneMinusDestinationColor;
case QRhiGraphicsPipeline::SrcAlpha:
return MTLBlendFactorSourceAlpha;
case QRhiGraphicsPipeline::OneMinusSrcAlpha:
return MTLBlendFactorOneMinusSourceAlpha;
case QRhiGraphicsPipeline::DstAlpha:
return MTLBlendFactorDestinationAlpha;
case QRhiGraphicsPipeline::OneMinusDstAlpha:
return MTLBlendFactorOneMinusDestinationAlpha;
case QRhiGraphicsPipeline::ConstantColor:
return MTLBlendFactorBlendColor;
case QRhiGraphicsPipeline::ConstantAlpha:
return MTLBlendFactorBlendAlpha;
case QRhiGraphicsPipeline::OneMinusConstantColor:
return MTLBlendFactorOneMinusBlendColor;
case QRhiGraphicsPipeline::OneMinusConstantAlpha:
return MTLBlendFactorOneMinusBlendAlpha;
case QRhiGraphicsPipeline::SrcAlphaSaturate:
return MTLBlendFactorSourceAlphaSaturated;
case QRhiGraphicsPipeline::Src1Color:
return MTLBlendFactorSource1Color;
case QRhiGraphicsPipeline::OneMinusSrc1Color:
return MTLBlendFactorOneMinusSource1Color;
case QRhiGraphicsPipeline::Src1Alpha:
return MTLBlendFactorSource1Alpha;
case QRhiGraphicsPipeline::OneMinusSrc1Alpha:
return MTLBlendFactorOneMinusSource1Alpha;
default:
Q_UNREACHABLE();
return MTLBlendFactorZero;
}
}
static inline MTLBlendOperation toMetalBlendOp(QRhiGraphicsPipeline::BlendOp op)
{
switch (op) {
case QRhiGraphicsPipeline::Add:
return MTLBlendOperationAdd;
case QRhiGraphicsPipeline::Subtract:
return MTLBlendOperationSubtract;
case QRhiGraphicsPipeline::ReverseSubtract:
return MTLBlendOperationReverseSubtract;
case QRhiGraphicsPipeline::Min:
return MTLBlendOperationMin;
case QRhiGraphicsPipeline::Max:
return MTLBlendOperationMax;
default:
Q_UNREACHABLE();
return MTLBlendOperationAdd;
}
}
static inline uint toMetalColorWriteMask(QRhiGraphicsPipeline::ColorMask c)
{
uint f = 0;
if (c.testFlag(QRhiGraphicsPipeline::R))
f |= MTLColorWriteMaskRed;
if (c.testFlag(QRhiGraphicsPipeline::G))
f |= MTLColorWriteMaskGreen;
if (c.testFlag(QRhiGraphicsPipeline::B))
f |= MTLColorWriteMaskBlue;
if (c.testFlag(QRhiGraphicsPipeline::A))
f |= MTLColorWriteMaskAlpha;
return f;
}
static inline MTLCompareFunction toMetalCompareOp(QRhiGraphicsPipeline::CompareOp op)
{
switch (op) {
case QRhiGraphicsPipeline::Never:
return MTLCompareFunctionNever;
case QRhiGraphicsPipeline::Less:
return MTLCompareFunctionLess;
case QRhiGraphicsPipeline::Equal:
return MTLCompareFunctionEqual;
case QRhiGraphicsPipeline::LessOrEqual:
return MTLCompareFunctionLessEqual;
case QRhiGraphicsPipeline::Greater:
return MTLCompareFunctionGreater;
case QRhiGraphicsPipeline::NotEqual:
return MTLCompareFunctionNotEqual;
case QRhiGraphicsPipeline::GreaterOrEqual:
return MTLCompareFunctionGreaterEqual;
case QRhiGraphicsPipeline::Always:
return MTLCompareFunctionAlways;
default:
Q_UNREACHABLE();
return MTLCompareFunctionAlways;
}
}
static inline MTLStencilOperation toMetalStencilOp(QRhiGraphicsPipeline::StencilOp op)
{
switch (op) {
case QRhiGraphicsPipeline::StencilZero:
return MTLStencilOperationZero;
case QRhiGraphicsPipeline::Keep:
return MTLStencilOperationKeep;
case QRhiGraphicsPipeline::Replace:
return MTLStencilOperationReplace;
case QRhiGraphicsPipeline::IncrementAndClamp:
return MTLStencilOperationIncrementClamp;
case QRhiGraphicsPipeline::DecrementAndClamp:
return MTLStencilOperationDecrementClamp;
case QRhiGraphicsPipeline::Invert:
return MTLStencilOperationInvert;
case QRhiGraphicsPipeline::IncrementAndWrap:
return MTLStencilOperationIncrementWrap;
case QRhiGraphicsPipeline::DecrementAndWrap:
return MTLStencilOperationDecrementWrap;
default:
Q_UNREACHABLE();
return MTLStencilOperationKeep;
}
}
static inline MTLPrimitiveType toMetalPrimitiveType(QRhiGraphicsPipeline::Topology t)
{
switch (t) {
case QRhiGraphicsPipeline::Triangles:
return MTLPrimitiveTypeTriangle;
case QRhiGraphicsPipeline::TriangleStrip:
return MTLPrimitiveTypeTriangleStrip;
case QRhiGraphicsPipeline::Lines:
return MTLPrimitiveTypeLine;
case QRhiGraphicsPipeline::LineStrip:
return MTLPrimitiveTypeLineStrip;
case QRhiGraphicsPipeline::Points:
return MTLPrimitiveTypePoint;
default:
Q_UNREACHABLE();
return MTLPrimitiveTypeTriangle;
}
}
static inline MTLPrimitiveTopologyClass toMetalPrimitiveTopologyClass(QRhiGraphicsPipeline::Topology t)
{
switch (t) {
case QRhiGraphicsPipeline::Triangles:
case QRhiGraphicsPipeline::TriangleStrip:
case QRhiGraphicsPipeline::TriangleFan:
return MTLPrimitiveTopologyClassTriangle;
case QRhiGraphicsPipeline::Lines:
case QRhiGraphicsPipeline::LineStrip:
return MTLPrimitiveTopologyClassLine;
case QRhiGraphicsPipeline::Points:
return MTLPrimitiveTopologyClassPoint;
default:
Q_UNREACHABLE();
return MTLPrimitiveTopologyClassTriangle;
}
}
static inline MTLCullMode toMetalCullMode(QRhiGraphicsPipeline::CullMode c)
{
switch (c) {
case QRhiGraphicsPipeline::None:
return MTLCullModeNone;
case QRhiGraphicsPipeline::Front:
return MTLCullModeFront;
case QRhiGraphicsPipeline::Back:
return MTLCullModeBack;
default:
Q_UNREACHABLE();
return MTLCullModeNone;
}
}
static inline MTLTriangleFillMode toMetalTriangleFillMode(QRhiGraphicsPipeline::PolygonMode mode)
{
switch (mode) {
case QRhiGraphicsPipeline::Fill:
return MTLTriangleFillModeFill;
case QRhiGraphicsPipeline::Line:
return MTLTriangleFillModeLines;
default:
Q_UNREACHABLE();
return MTLTriangleFillModeFill;
}
}
static inline MTLWinding toMetalTessellationWindingOrder(QShaderDescription::TessellationWindingOrder w)
{
switch (w) {
case QShaderDescription::CwTessellationWindingOrder:
return MTLWindingClockwise;
case QShaderDescription::CcwTessellationWindingOrder:
return MTLWindingCounterClockwise;
default:
// this is reachable, consider a tess.eval. shader not declaring it, the value is then Unknown
return MTLWindingCounterClockwise;
}
}
static inline MTLTessellationPartitionMode toMetalTessellationPartitionMode(QShaderDescription::TessellationPartitioning p)
{
switch (p) {
case QShaderDescription::EqualTessellationPartitioning:
return MTLTessellationPartitionModePow2;
case QShaderDescription::FractionalEvenTessellationPartitioning:
return MTLTessellationPartitionModeFractionalEven;
case QShaderDescription::FractionalOddTessellationPartitioning:
return MTLTessellationPartitionModeFractionalOdd;
default:
// this is reachable, consider a tess.eval. shader not declaring it, the value is then Unknown
return MTLTessellationPartitionModePow2;
}
}
static inline MTLLanguageVersion toMetalLanguageVersion(const QShaderVersion &version)
{
int v = version.version();
return MTLLanguageVersion(((v / 10) << 16) + (v % 10));
}
id<MTLBuffer> QRhiMetalData::allocFromStagingArea(StagingArea *area, quint32 size, quint32 alignment,
int frameSlot, quint32 minBlockSize, quint32 *offset)
{
auto &pool(*area);
const quint32 alignedSize = aligned<quint32>(size, alignment);
if (pool.offset + alignedSize > pool.capacity) {
if (pool.buf) {
// Reusing the StagingBuffer entry type: the handler just releases
// the buffer. lastActiveFrameSlot = frameSlot is what keeps the old
// buffer alive for the rest of this frame, since
// executeDeferredReleases() only gets to this slot after the
// semaphore wait in the next beginFrame() for it.
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingBuffer;
e.lastActiveFrameSlot = frameSlot;
e.stagingBuffer.buffer = pool.buf;
releaseQueue.append(e);
}
pool.capacity = qMax(pool.capacity * 2, qMax(alignedSize, minBlockSize));
pool.buf = [dev newBufferWithLength: pool.capacity options: MTLResourceStorageModeShared];
pool.offset = 0;
if (!pool.buf) {
pool.capacity = 0;
return nil;
}
}
*offset = pool.offset;
pool.offset += alignedSize;
return pool.buf;
}
id<MTLBuffer> QRhiMetalData::allocArgumentBuffer(quint32 size, quint32 alignment, int frameSlot, quint32 *offset)
{
return allocFromStagingArea(&argBufPool[frameSlot], size, alignment, frameSlot, 16384, offset);
}
id<MTLBuffer> QRhiMetalData::newOneShotStagingBuffer(quint32 size, int frameSlot)
{
id<MTLBuffer> buf = [dev newBufferWithLength: size options: MTLResourceStorageModeShared];
if (!buf)
return nil;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingBuffer;
e.lastActiveFrameSlot = frameSlot;
e.stagingBuffer.buffer = buf;
releaseQueue.append(e);
return buf;
}
id<MTLBuffer> QRhiMetalData::allocBufferStaging(quint32 size, int frameSlot, quint32 *offset)
{
if (size > LARGE_STAGING_ALLOC) {
*offset = 0;
return newOneShotStagingBuffer(size, frameSlot);
}
StagingArea &area(bufStagingPool[frameSlot]);
// 4 byte alignment is what MTLBlitCommandEncoder wants on non-Apple GPUs.
const quint32 alignedSize = aligned<quint32>(size, 4u);
area.bytesNeeded += alignedSize;
if (area.offset + alignedSize > area.capacity) {
*offset = 0;
return newOneShotStagingBuffer(size, frameSlot);
}
*offset = area.offset;
area.offset += alignedSize;
return area.buf;
}
void QRhiMetalData::resetAndResizeBufferStagingArea(int frameSlot)
{
StagingArea &area(bufStagingPool[frameSlot]);
const quint32 needed = area.bytesNeeded;
area.bytesNeeded = 0;
area.offset = 0;
bool resize = false;
quint32 newCapacity = 0;
if (needed > area.capacity) {
// Fell back to one-shot buffers last time. Only grow once the demand
// has proven to be recurring: a one-time burst, which is what loading a
// scene looks like, would otherwise size the area permanently right at
// the point where it is not needed any more.
area.lowDemandFrames = 0;
if (++area.highDemandFrames >= STAGING_AREA_HIGH_DEMAND_FRAMES) {
newCapacity = qMin(qNextPowerOfTwo(needed), STAGING_AREA_MAX);
resize = true;
}
} else if (needed <= area.capacity / 4 && area.capacity > 0) {
area.highDemandFrames = 0;
if (++area.lowDemandFrames >= STAGING_AREA_LOW_DEMAND_FRAMES) {
area.lowDemandFrames = 0;
// Nothing at all for a while, e.g. an app that only uploads during
// startup: give the memory back entirely.
newCapacity = needed ? qMax(area.capacity / 2, STAGING_AREA_MIN) : 0;
resize = true;
}
} else {
area.lowDemandFrames = 0;
area.highDemandFrames = 0;
}
if (resize && newCapacity != area.capacity) {
if (area.buf) {
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::StagingBuffer;
e.lastActiveFrameSlot = frameSlot;
e.stagingBuffer.buffer = area.buf;
releaseQueue.append(e);
area.buf = nil;
}
area.capacity = 0;
if (newCapacity) {
area.buf = [dev newBufferWithLength: newCapacity options: MTLResourceStorageModeShared];
if (area.buf)
area.capacity = newCapacity;
}
}
}
id<MTLLibrary> QRhiMetalData::createMetalLib(const QShader &shader, QShader::Variant shaderVariant,
bool preferArgumentBuffers,
QString *error, QByteArray *entryPoint, QShaderKey *activeKey)
{
QVarLengthArray<int, 8> versions;
versions << 30 << 24 << 23 << 22 << 21 << 20 << 12;
// preferArgumentBuffers overrides whatever variant is set in the QShader.
// This is by design, since we cannot expect the client to start specifying
// the ArgumentBuffer variant that is only relevant for Metal. Also not
// compatible with BatchableVertexShader and other variants since
// ArgumentBufferShader is expected to be the argument-buffers version of
// StandardShader, and it cannot be a combination of multiple variants. That
// limitation should be fine for now.
QVarLengthArray<QShader::Variant, 2> variants;
if (preferArgumentBuffers)
variants << QShader::ArgumentBufferShader;
variants << shaderVariant;
const QList<QShaderKey> shaders = shader.availableShaders();
auto findKey = [&shaders, &versions, &variants](QShader::Source source, QShaderKey *result) {
for (const QShader::Variant &variant : variants) {
for (const int &version : versions) {
const QShaderKey key = { source, version, variant };
if (shaders.contains(key)) {
*result = key;
return true;
}
}
}
return false;
};
QShaderKey key;
if (findKey(QShader::Source::MetalLibShader, &key)) {
QShaderCode mtllib = shader.shader(key);
dispatch_data_t data = dispatch_data_create(mtllib.shader().constData(),
size_t(mtllib.shader().size()),
dispatch_get_global_queue(0, 0),
DISPATCH_DATA_DESTRUCTOR_DEFAULT);
NSError *err = nil;
id<MTLLibrary> lib = [dev newLibraryWithData: data error: &err];
dispatch_release(data);
if (!err) {
*entryPoint = mtllib.entryPoint();
*activeKey = key;
return lib;
} else {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to load metallib from baked shader: %s", qPrintable(msg));
}
}
if (!findKey(QShader::Source::MslShader, &key)) {
qWarning() << "No MSL code found in baked shader" << shader;
return nil;
}
QShaderCode mslSource = shader.shader(key);
NSString *src = [NSString stringWithUTF8String: mslSource.shader().constData()];
MTLCompileOptions *opts = [[MTLCompileOptions alloc] init];
opts.languageVersion = toMetalLanguageVersion(key.sourceVersion());
NSError *err = nil;
id<MTLLibrary> lib = [dev newLibraryWithSource: src options: opts error: &err];
[opts release];
// src is autoreleased
// if lib is null and err is non-null, we had errors (fail)
// if lib is non-null and err is non-null, we had warnings (success)
// if lib is non-null and err is null, there were no errors or warnings (success)
if (!lib) {
const QString msg = QString::fromNSString(err.localizedDescription);
*error = msg;
return nil;
}
*entryPoint = mslSource.entryPoint();
*activeKey = key;
return lib;
}
id<MTLFunction> QRhiMetalData::createMSLShaderFunction(id<MTLLibrary> lib, const QByteArray &entryPoint)
{
return [lib newFunctionWithName:[NSString stringWithUTF8String:entryPoint.constData()]];
}
void QMetalGraphicsPipeline::setupAttachmentsInMetalRenderPassDescriptor(void *metalRpDesc, QMetalRenderPassDescriptor *rpD)
{
MTLRenderPipelineDescriptor *rpDesc = reinterpret_cast<MTLRenderPipelineDescriptor *>(metalRpDesc);
if (rpD->colorAttachmentCount) {
// defaults when no targetBlends are provided
rpDesc.colorAttachments[0].pixelFormat = MTLPixelFormat(rpD->colorFormat[0]);
rpDesc.colorAttachments[0].writeMask = MTLColorWriteMaskAll;
rpDesc.colorAttachments[0].blendingEnabled = false;
Q_ASSERT(m_targetBlends.count() == rpD->colorAttachmentCount
|| (m_targetBlends.isEmpty() && rpD->colorAttachmentCount == 1));
for (uint i = 0, ie = uint(m_targetBlends.count()); i != ie; ++i) {
const QRhiGraphicsPipeline::TargetBlend &b(m_targetBlends[int(i)]);
rpDesc.colorAttachments[i].pixelFormat = MTLPixelFormat(rpD->colorFormat[i]);
rpDesc.colorAttachments[i].blendingEnabled = b.enable;
rpDesc.colorAttachments[i].sourceRGBBlendFactor = toMetalBlendFactor(b.srcColor);
rpDesc.colorAttachments[i].destinationRGBBlendFactor = toMetalBlendFactor(b.dstColor);
rpDesc.colorAttachments[i].rgbBlendOperation = toMetalBlendOp(b.opColor);
rpDesc.colorAttachments[i].sourceAlphaBlendFactor = toMetalBlendFactor(b.srcAlpha);
rpDesc.colorAttachments[i].destinationAlphaBlendFactor = toMetalBlendFactor(b.dstAlpha);
rpDesc.colorAttachments[i].alphaBlendOperation = toMetalBlendOp(b.opAlpha);
rpDesc.colorAttachments[i].writeMask = toMetalColorWriteMask(b.colorWrite);
}
}
if (rpD->hasDepthStencil) {
// Must only be set when a depth-stencil buffer will actually be bound,
// validation blows up otherwise.
MTLPixelFormat fmt = MTLPixelFormat(rpD->dsFormat);
rpDesc.depthAttachmentPixelFormat = fmt;
#if defined(Q_OS_MACOS)
if (fmt != MTLPixelFormatDepth16Unorm && fmt != MTLPixelFormatDepth32Float)
#else
if (fmt != MTLPixelFormatDepth32Float)
#endif
rpDesc.stencilAttachmentPixelFormat = fmt;
}
QRHI_RES_RHI(QRhiMetal);
rpDesc.rasterSampleCount = NSUInteger(rhiD->effectiveSampleCount(m_sampleCount));
}
void QMetalGraphicsPipeline::setupMetalDepthStencilDescriptor(void *metalDsDesc)
{
MTLDepthStencilDescriptor *dsDesc = reinterpret_cast<MTLDepthStencilDescriptor *>(metalDsDesc);
dsDesc.depthCompareFunction = m_depthTest ? toMetalCompareOp(m_depthOp) : MTLCompareFunctionAlways;
dsDesc.depthWriteEnabled = m_depthWrite;
if (m_stencilTest) {
dsDesc.frontFaceStencil = [[MTLStencilDescriptor alloc] init];
dsDesc.frontFaceStencil.stencilFailureOperation = toMetalStencilOp(m_stencilFront.failOp);
dsDesc.frontFaceStencil.depthFailureOperation = toMetalStencilOp(m_stencilFront.depthFailOp);
dsDesc.frontFaceStencil.depthStencilPassOperation = toMetalStencilOp(m_stencilFront.passOp);
dsDesc.frontFaceStencil.stencilCompareFunction = toMetalCompareOp(m_stencilFront.compareOp);
dsDesc.frontFaceStencil.readMask = m_stencilReadMask;
dsDesc.frontFaceStencil.writeMask = m_stencilWriteMask;
dsDesc.backFaceStencil = [[MTLStencilDescriptor alloc] init];
dsDesc.backFaceStencil.stencilFailureOperation = toMetalStencilOp(m_stencilBack.failOp);
dsDesc.backFaceStencil.depthFailureOperation = toMetalStencilOp(m_stencilBack.depthFailOp);
dsDesc.backFaceStencil.depthStencilPassOperation = toMetalStencilOp(m_stencilBack.passOp);
dsDesc.backFaceStencil.stencilCompareFunction = toMetalCompareOp(m_stencilBack.compareOp);
dsDesc.backFaceStencil.readMask = m_stencilReadMask;
dsDesc.backFaceStencil.writeMask = m_stencilWriteMask;
}
}
void QMetalGraphicsPipeline::mapStates()
{
d->winding = m_frontFace == CCW ? MTLWindingCounterClockwise : MTLWindingClockwise;
d->cullMode = toMetalCullMode(m_cullMode);
d->triangleFillMode = toMetalTriangleFillMode(m_polygonMode);
d->depthClipMode = m_depthClamp ? MTLDepthClipModeClamp : MTLDepthClipModeClip;
d->depthBias = float(m_depthBias);
d->slopeScaledDepthBias = m_slopeScaledDepthBias;
}
void QMetalGraphicsPipelineData::setupVertexInputDescriptor(MTLVertexDescriptor *desc)
{
// same binding space for vertex and constant buffers - work it around
// should be in native resource binding not SPIR-V, but this will work anyway
const int firstVertexBinding = QRHI_RES(QMetalShaderResourceBindings, q->shaderResourceBindings())->maxBinding + 1;
QRhiVertexInputLayout vertexInputLayout = q->vertexInputLayout();
for (auto it = vertexInputLayout.cbeginAttributes(), itEnd = vertexInputLayout.cendAttributes();
it != itEnd; ++it)
{
const uint loc = uint(it->location());
desc.attributes[loc].format = decltype(desc.attributes[loc].format)(toMetalAttributeFormat(it->format()));
desc.attributes[loc].offset = NSUInteger(it->offset());
desc.attributes[loc].bufferIndex = NSUInteger(firstVertexBinding + it->binding());
}
int bindingIndex = 0;
const NSUInteger viewCount = qMax<NSUInteger>(1, q->multiViewCount());
for (auto it = vertexInputLayout.cbeginBindings(), itEnd = vertexInputLayout.cendBindings();
it != itEnd; ++it, ++bindingIndex)
{
const uint layoutIdx = uint(firstVertexBinding + bindingIndex);
desc.layouts[layoutIdx].stepFunction =
it->classification() == QRhiVertexInputBinding::PerInstance
? MTLVertexStepFunctionPerInstance : MTLVertexStepFunctionPerVertex;
desc.layouts[layoutIdx].stepRate = NSUInteger(it->instanceStepRate());
if (desc.layouts[layoutIdx].stepFunction == MTLVertexStepFunctionPerInstance)
desc.layouts[layoutIdx].stepRate *= viewCount;
desc.layouts[layoutIdx].stride = it->stride();
}
}
void QMetalGraphicsPipelineData::setupStageInputDescriptor(MTLStageInputOutputDescriptor *desc)
{
// same binding space for vertex and constant buffers - work it around
// should be in native resource binding not SPIR-V, but this will work anyway
const int firstVertexBinding = QRHI_RES(QMetalShaderResourceBindings, q->shaderResourceBindings())->maxBinding + 1;
QRhiVertexInputLayout vertexInputLayout = q->vertexInputLayout();
for (auto it = vertexInputLayout.cbeginAttributes(), itEnd = vertexInputLayout.cendAttributes();
it != itEnd; ++it)
{
const uint loc = uint(it->location());
desc.attributes[loc].format = decltype(desc.attributes[loc].format)(toMetalAttributeFormat(it->format()));
desc.attributes[loc].offset = NSUInteger(it->offset());
desc.attributes[loc].bufferIndex = NSUInteger(firstVertexBinding + it->binding());
}
int bindingIndex = 0;
for (auto it = vertexInputLayout.cbeginBindings(), itEnd = vertexInputLayout.cendBindings();
it != itEnd; ++it, ++bindingIndex)
{
const uint layoutIdx = uint(firstVertexBinding + bindingIndex);
if (desc.indexBufferIndex) {
desc.layouts[layoutIdx].stepFunction =
it->classification() == QRhiVertexInputBinding::PerInstance
? MTLStepFunctionThreadPositionInGridY : MTLStepFunctionThreadPositionInGridXIndexed;
} else {
desc.layouts[layoutIdx].stepFunction =
it->classification() == QRhiVertexInputBinding::PerInstance
? MTLStepFunctionThreadPositionInGridY : MTLStepFunctionThreadPositionInGridX;
}
desc.layouts[layoutIdx].stepRate = NSUInteger(it->instanceStepRate());
desc.layouts[layoutIdx].stride = it->stride();
}
}
void QRhiMetalData::trySeedingRenderPipelineFromBinaryArchive(MTLRenderPipelineDescriptor *rpDesc)
{
if (binArch) {
NSArray *binArchArray = [NSArray arrayWithObjects: binArch, nil];
rpDesc.binaryArchives = binArchArray;
}
}
void QRhiMetalData::addRenderPipelineToBinaryArchive(MTLRenderPipelineDescriptor *rpDesc)
{
if (binArch) {
NSError *err = nil;
if (![binArch addRenderPipelineFunctionsWithDescriptor: rpDesc error: &err]) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to collect render pipeline functions to binary archive: %s", qPrintable(msg));
}
}
}
static inline bool usesTextures(const QShaderDescription &desc)
{
return !desc.combinedImageSamplers().isEmpty()
|| !desc.separateImages().isEmpty()
|| !desc.storageImages().isEmpty();
}
static bool hasArgumentBufferVariant(const QShader &shader)
{
for (const QShaderKey &k : shader.availableShaders()) {
if (k.sourceVariant() == QShader::ArgumentBufferShader)
return true;
}
return false;
}
static void setupArgumentBufferEncoder(QMetalShader *shader)
{
const int index = shader->nativeShaderInfo.extraBufferBindings.value(QShaderPrivate::MslArgumentBufferBinding, -1);
if (index >= 0) {
shader->argumentBufferIndex = index;
shader->argumentEncoder = [shader->func newArgumentEncoderWithBufferIndex: NSUInteger(index)];
}
}
bool QMetalGraphicsPipeline::createVertexFragmentPipeline()
{
QRHI_RES_RHI(QRhiMetal);
// A pipeline that supports indirect command buffers cannot have textures
// bound directly to its functions, so prefer the shader variant that
// reaches them through an argument buffer.
const bool wantArgumentBuffers = m_flags.testFlag(UsesIndirectDraws) && rhiD->caps.indirectCommandBuffers;
MTLVertexDescriptor *vertexDesc = [MTLVertexDescriptor vertexDescriptor];
d->setupVertexInputDescriptor(vertexDesc);
MTLRenderPipelineDescriptor *rpDesc = [[MTLRenderPipelineDescriptor alloc] init];
rpDesc.vertexDescriptor = vertexDesc;
// Mutability cannot be determined (slotted buffers could be set as
// MTLMutabilityImmutable, but then we potentially need a different
// descriptor for each buffer combination as this depends on the actual
// buffers not just the resource binding layout), so leave
// rpDesc.vertex/fragmentBuffers at the defaults.
for (const QRhiShaderStage &shaderStage : std::as_const(m_shaderStages)) {
const QShader shader = shaderStage.shader();
const bool argumentBufferBuild = wantArgumentBuffers && hasArgumentBufferVariant(shader);
auto cacheIt = rhiD->d->shaderCache.constFind({ shaderStage, argumentBufferBuild });
if (cacheIt != rhiD->d->shaderCache.constEnd()) {
switch (shaderStage.type()) {
case QRhiShaderStage::Vertex:
d->vs = *cacheIt;
[d->vs.lib retain];
[d->vs.func retain];
[d->vs.argumentEncoder retain];
rpDesc.vertexFunction = d->vs.func;
break;
case QRhiShaderStage::Fragment:
d->fs = *cacheIt;
[d->fs.lib retain];
[d->fs.func retain];
[d->fs.argumentEncoder retain];
rpDesc.fragmentFunction = d->fs.func;
break;
default:
break;
}
} else {
QString error;
QByteArray entryPoint;
QShaderKey activeKey;
id<MTLLibrary> lib = rhiD->d->createMetalLib(shader, shaderStage.shaderVariant(),
argumentBufferBuild,
&error, &entryPoint, &activeKey);
if (!lib) {
qWarning("MSL shader compilation failed: %s", qPrintable(error));
return false;
}
id<MTLFunction> func = rhiD->d->createMSLShaderFunction(lib, entryPoint);
if (!func) {
qWarning("MSL function for entry point %s not found", entryPoint.constData());
[lib release];
return false;
}
if (rhiD->d->shaderCache.count() >= QRhiMetal::MAX_SHADER_CACHE_ENTRIES) {
// Use the simplest strategy: too many cached shaders -> drop them all.
for (QMetalShader &s : rhiD->d->shaderCache)
s.destroy();
rhiD->d->shaderCache.clear();
}
switch (shaderStage.type()) {
case QRhiShaderStage::Vertex:
d->vs.lib = lib;
d->vs.func = func;
d->vs.nativeResourceBindingMap = shader.nativeResourceBindingMap(activeKey);
d->vs.desc = shader.description();
d->vs.nativeShaderInfo = shader.nativeShaderInfo(activeKey);
setupArgumentBufferEncoder(&d->vs);
rhiD->d->shaderCache.insert({ shaderStage, argumentBufferBuild }, d->vs);
[d->vs.lib retain];
[d->vs.func retain];
[d->vs.argumentEncoder retain];
rpDesc.vertexFunction = func;
break;
case QRhiShaderStage::Fragment:
d->fs.lib = lib;
d->fs.func = func;
d->fs.nativeResourceBindingMap = shader.nativeResourceBindingMap(activeKey);
d->fs.desc = shader.description();
d->fs.nativeShaderInfo = shader.nativeShaderInfo(activeKey);
setupArgumentBufferEncoder(&d->fs);
rhiD->d->shaderCache.insert({ shaderStage, argumentBufferBuild }, d->fs);
[d->fs.lib retain];
[d->fs.func retain];
[d->fs.argumentEncoder retain];
rpDesc.fragmentFunction = func;
break;
default:
[func release];
[lib release];
break;
}
}
}
QMetalRenderPassDescriptor *rpD = QRHI_RES(QMetalRenderPassDescriptor, m_renderPassDesc);
setupAttachmentsInMetalRenderPassDescriptor(rpDesc, rpD);
// Safe for an indirect command buffer if the stage has no textures at all,
// or reaches them through an argument buffer.
const auto icbSafe = [](const QMetalShader &s) {
return !usesTextures(s.desc) || s.argumentBufferIndex >= 0;
};
d->icbCapable = wantArgumentBuffers && icbSafe(d->vs) && icbSafe(d->fs);
if (d->icbCapable)
rpDesc.supportIndirectCommandBuffers = YES;
if (m_multiViewCount >= 2)
rpDesc.inputPrimitiveTopology = toMetalPrimitiveTopologyClass(m_topology);
rhiD->d->trySeedingRenderPipelineFromBinaryArchive(rpDesc);
if (rhiD->rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
rhiD->d->addRenderPipelineToBinaryArchive(rpDesc);
NSError *err = nil;
d->ps = [rhiD->d->dev newRenderPipelineStateWithDescriptor: rpDesc error: &err];
[rpDesc release];
if (!d->ps) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to create render pipeline state: %s", qPrintable(msg));
return false;
}
MTLDepthStencilDescriptor *dsDesc = [[MTLDepthStencilDescriptor alloc] init];
setupMetalDepthStencilDescriptor(dsDesc);
d->ds = [rhiD->d->dev newDepthStencilStateWithDescriptor: dsDesc];
[dsDesc release];
d->primitiveType = toMetalPrimitiveType(m_topology);
mapStates();
return true;
}
int QMetalGraphicsPipelineData::Tessellation::vsCompVariantToIndex(QShader::Variant vertexCompVariant)
{
switch (vertexCompVariant) {
case QShader::NonIndexedVertexAsComputeShader:
return 0;
case QShader::UInt32IndexedVertexAsComputeShader:
return 1;
case QShader::UInt16IndexedVertexAsComputeShader:
return 2;
default:
break;
}
return -1;
}
id<MTLComputePipelineState> QMetalGraphicsPipelineData::Tessellation::vsCompPipeline(QRhiMetal *rhiD, QShader::Variant vertexCompVariant)
{
const int varIndex = vsCompVariantToIndex(vertexCompVariant);
if (varIndex >= 0 && vertexComputeState[varIndex])
return vertexComputeState[varIndex];
id<MTLFunction> func = nil;
if (varIndex >= 0)
func = compVs[varIndex].func;
if (!func) {
qWarning("No compute function found for vertex shader translated for tessellation, this should not happen");
return nil;
}
const QMap<int, int> &ebb(compVs[varIndex].nativeShaderInfo.extraBufferBindings);
const int indexBufferBinding = ebb.value(QShaderPrivate::MslTessVertIndicesBufferBinding, -1);
MTLComputePipelineDescriptor *cpDesc = [MTLComputePipelineDescriptor new];
cpDesc.computeFunction = func;
cpDesc.threadGroupSizeIsMultipleOfThreadExecutionWidth = YES;
cpDesc.stageInputDescriptor = [MTLStageInputOutputDescriptor stageInputOutputDescriptor];
if (indexBufferBinding >= 0) {
if (vertexCompVariant == QShader::UInt32IndexedVertexAsComputeShader) {
cpDesc.stageInputDescriptor.indexType = MTLIndexTypeUInt32;
cpDesc.stageInputDescriptor.indexBufferIndex = indexBufferBinding;
} else if (vertexCompVariant == QShader::UInt16IndexedVertexAsComputeShader) {
cpDesc.stageInputDescriptor.indexType = MTLIndexTypeUInt16;
cpDesc.stageInputDescriptor.indexBufferIndex = indexBufferBinding;
}
}
q->setupStageInputDescriptor(cpDesc.stageInputDescriptor);
rhiD->d->trySeedingComputePipelineFromBinaryArchive(cpDesc);
if (rhiD->rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
rhiD->d->addComputePipelineToBinaryArchive(cpDesc);
NSError *err = nil;
id<MTLComputePipelineState> ps = [rhiD->d->dev newComputePipelineStateWithDescriptor: cpDesc
options: MTLPipelineOptionNone
reflection: nil
error: &err];
[cpDesc release];
if (!ps) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to create compute pipeline state: %s", qPrintable(msg));
} else {
vertexComputeState[varIndex] = ps;
}
// not retained, the only owner is vertexComputeState and so the QRhiGraphicsPipeline
return ps;
}
id<MTLComputePipelineState> QMetalGraphicsPipelineData::Tessellation::tescCompPipeline(QRhiMetal *rhiD)
{
if (tessControlComputeState)
return tessControlComputeState;
MTLComputePipelineDescriptor *cpDesc = [MTLComputePipelineDescriptor new];
cpDesc.computeFunction = compTesc.func;
rhiD->d->trySeedingComputePipelineFromBinaryArchive(cpDesc);
if (rhiD->rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
rhiD->d->addComputePipelineToBinaryArchive(cpDesc);
NSError *err = nil;
id<MTLComputePipelineState> ps = [rhiD->d->dev newComputePipelineStateWithDescriptor: cpDesc
options: MTLPipelineOptionNone
reflection: nil
error: &err];
[cpDesc release];
if (!ps) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to create compute pipeline state: %s", qPrintable(msg));
} else {
tessControlComputeState = ps;
}
// not retained, the only owner is tessControlComputeState and so the QRhiGraphicsPipeline
return ps;
}
static inline bool indexTaken(quint32 index, quint64 indices)
{
return (indices >> index) & 0x1;
}
static inline void takeIndex(quint32 index, quint64 &indices)
{
indices |= 1 << index;
}
static inline int nextAttributeIndex(quint64 indices)
{
// Maximum number of vertex attributes per vertex descriptor. There does
// not appear to be a way to query this from the implementation.
// that all GPU families have a value of 31.
static const int maxVertexAttributes = 31;
for (int index = 0; index < maxVertexAttributes; ++index) {
if (!indexTaken(index, indices))
return index;
}
Q_UNREACHABLE_RETURN(-1);
}
static inline int aligned(quint32 offset, quint32 alignment)
{
return ((offset + alignment - 1) / alignment) * alignment;
}
template<typename T>
static void addUnusedVertexAttribute(const T &variable, QRhiMetal *rhiD, quint32 &offset, quint32 &vertexAlignment)
{
int elements = 1;
for (const int dim : variable.arrayDims)
elements *= dim;
if (variable.type == QShaderDescription::VariableType::Struct) {
for (int element = 0; element < elements; ++element) {
for (const auto &member : variable.structMembers) {
addUnusedVertexAttribute(member, rhiD, offset, vertexAlignment);
}
}
} else {
const QRhiVertexInputAttribute::Format format = rhiD->shaderDescVariableFormatToVertexInputFormat(variable.type);
const quint32 size = rhiD->byteSizePerVertexForVertexInputFormat(format);
// MSL specification 3.0 says alignment = size for non packed scalars and vectors
const quint32 alignment = size;
vertexAlignment = std::max(vertexAlignment, alignment);
for (int element = 0; element < elements; ++element) {
// adjust alignment
offset = aligned(offset, alignment);
offset += size;
}
}
}
template<typename T>
static void addVertexAttribute(const T &variable, int binding, QRhiMetal *rhiD, int &index, quint32 &offset, MTLVertexAttributeDescriptorArray *attributes, quint64 &indices, quint32 &vertexAlignment)
{
int elements = 1;
for (const int dim : variable.arrayDims)
elements *= dim;
if (variable.type == QShaderDescription::VariableType::Struct) {
for (int element = 0; element < elements; ++element) {
for (const auto &member : variable.structMembers) {
addVertexAttribute(member, binding, rhiD, index, offset, attributes, indices, vertexAlignment);
}
}
} else {
const QRhiVertexInputAttribute::Format format = rhiD->shaderDescVariableFormatToVertexInputFormat(variable.type);
const quint32 size = rhiD->byteSizePerVertexForVertexInputFormat(format);
// MSL specification 3.0 says alignment = size for non packed scalars and vectors
const quint32 alignment = size;
vertexAlignment = std::max(vertexAlignment, alignment);
for (int element = 0; element < elements; ++element) {
Q_ASSERT(!indexTaken(index, indices));
// adjust alignment
offset = aligned(offset, alignment);
attributes[index].bufferIndex = binding;
attributes[index].format = toMetalAttributeFormat(format);
attributes[index].offset = offset;
takeIndex(index, indices);
index++;
if (indexTaken(index, indices))
index = nextAttributeIndex(indices);
offset += size;
}
}
}
static inline bool matches(const QList<QShaderDescription::BlockVariable> &a, const QList<QShaderDescription::BlockVariable> &b)
{
if (a.size() == b.size()) {
bool match = true;
for (int i = 0; i < a.size() && match; ++i) {
match &= a[i].type == b[i].type
&& a[i].arrayDims == b[i].arrayDims
&& matches(a[i].structMembers, b[i].structMembers);
}
return match;
}
return false;
}
static inline bool matches(const QShaderDescription::InOutVariable &a, const QShaderDescription::InOutVariable &b)
{
return a.location == b.location
&& a.type == b.type
&& a.perPatch == b.perPatch
&& matches(a.structMembers, b.structMembers);
}
//
// Create the tessellation evaluation render pipeline state
//
// The tesc runs as a compute shader in a compute pipeline and writes per patch and per patch
// control point data into separate storage buffers. The tese runs as a vertex shader in a render
// pipeline. Our task is to generate a render pipeline descriptor for the tese that pulls vertices
// from these buffers.
//
// As the buffers we are pulling vertices from are written by a compute pipeline, they follow the
// MSL alignment conventions which we must take into account when generating our
// MTLVertexDescriptor. We must include the user defined tese input attributes, and any builtins
// that were used.
//
// SPIRV-Cross generates the MSL tese shader code with input attribute indices that reflect the
// specified GLSL locations. Interface blocks are flattened with each member having an incremented
// attribute index. SPIRV-Cross reports an error on compilation if there are clashes in the index
// address space.
//
// After the user specified attributes are processed, SPIRV-Cross places the in-use builtins at the
// next available (lowest value) attribute index. Tese builtins are processed in the following
// order:
//
// in gl_PerVertex
// {
// vec4 gl_Position;
// float gl_PointSize;
// float gl_ClipDistance[];
// };
//
// patch in float gl_TessLevelOuter[4];
// patch in float gl_TessLevelInner[2];
//
// Enumerations in QShaderDescription::BuiltinType are defined in this order.
//
// For quads, SPIRV-Cross places MTLQuadTessellationFactorsHalf per patch in the tessellation
// factor buffer. For triangles it uses MTLTriangleTessellationFactorsHalf.
//
// It should be noted that SPIRV-Cross handles the following builtin inputs internally, with no
// host side support required.
//
// in vec3 gl_TessCoord;
// in int gl_PatchVerticesIn;
// in int gl_PrimitiveID;
//
id<MTLRenderPipelineState> QMetalGraphicsPipelineData::Tessellation::teseFragRenderPipeline(QRhiMetal *rhiD, QMetalGraphicsPipeline *pipeline)
{
if (pipeline->d->ps)
return pipeline->d->ps;
MTLRenderPipelineDescriptor *rpDesc = [[MTLRenderPipelineDescriptor alloc] init];
MTLVertexDescriptor *vertexDesc = [MTLVertexDescriptor vertexDescriptor];
// tesc output buffers
const QMap<int, int> &ebb(compTesc.nativeShaderInfo.extraBufferBindings);
const int tescOutputBufferBinding = ebb.value(QShaderPrivate::MslTessVertTescOutputBufferBinding, -1);
const int tescPatchOutputBufferBinding = ebb.value(QShaderPrivate::MslTessTescPatchOutputBufferBinding, -1);
const int tessFactorBufferBinding = ebb.value(QShaderPrivate::MslTessTescTessLevelBufferBinding, -1);
quint32 offsetInTescOutput = 0;
quint32 offsetInTescPatchOutput = 0;
quint32 offsetInTessFactorBuffer = 0;
quint32 tescOutputAlignment = 0;
quint32 tescPatchOutputAlignment = 0;
quint32 tessFactorAlignment = 0;
QSet<int> usedBuffers;
// tesc output variables in ascending location order
QMap<int, QShaderDescription::InOutVariable> tescOutVars;
for (const auto &tescOutVar : compTesc.desc.outputVariables())
tescOutVars[tescOutVar.location] = tescOutVar;
// tese input variables in ascending location order
QMap<int, QShaderDescription::InOutVariable> teseInVars;
for (const auto &teseInVar : vertTese.desc.inputVariables())
teseInVars[teseInVar.location] = teseInVar;
// bit mask tracking usage of vertex attribute indices
quint64 indices = 0;
for (QShaderDescription::InOutVariable &tescOutVar : tescOutVars) {
int index = tescOutVar.location;
int binding = -1;
quint32 *offset = nullptr;
quint32 *alignment = nullptr;
if (tescOutVar.perPatch) {
binding = tescPatchOutputBufferBinding;
offset = &offsetInTescPatchOutput;
alignment = &tescPatchOutputAlignment;
} else {
tescOutVar.arrayDims.removeLast();
binding = tescOutputBufferBinding;
offset = &offsetInTescOutput;
alignment = &tescOutputAlignment;
}
if (teseInVars.contains(index)) {
if (!matches(teseInVars[index], tescOutVar)) {
qWarning() << "mismatched tessellation control output -> tesssellation evaluation input at location" << index;
qWarning() << " tesc out:" << tescOutVar;
qWarning() << " tese in:" << teseInVars[index];
}
if (binding != -1) {
addVertexAttribute(tescOutVar, binding, rhiD, index, *offset, vertexDesc.attributes, indices, *alignment);
usedBuffers << binding;
} else {
qWarning() << "baked tessellation control shader missing output buffer binding information";
addUnusedVertexAttribute(tescOutVar, rhiD, *offset, *alignment);
}
} else {
qWarning() << "missing tessellation evaluation input for tessellation control output:" << tescOutVar;
addUnusedVertexAttribute(tescOutVar, rhiD, *offset, *alignment);
}
teseInVars.remove(tescOutVar.location);
}
for (const QShaderDescription::InOutVariable &teseInVar : teseInVars)
qWarning() << "missing tessellation control output for tessellation evaluation input:" << teseInVar;
// tesc output builtins in ascending location order
QMap<QShaderDescription::BuiltinType, QShaderDescription::BuiltinVariable> tescOutBuiltins;
for (const auto &tescOutBuiltin : compTesc.desc.outputBuiltinVariables())
tescOutBuiltins[tescOutBuiltin.type] = tescOutBuiltin;
// tese input builtins in ascending location order
QMap<QShaderDescription::BuiltinType, QShaderDescription::BuiltinVariable> teseInBuiltins;
for (const auto &teseInBuiltin : vertTese.desc.inputBuiltinVariables())
teseInBuiltins[teseInBuiltin.type] = teseInBuiltin;
const bool trianglesMode = vertTese.desc.tessellationMode() == QShaderDescription::TrianglesTessellationMode;
bool tessLevelAdded = false;
for (const QShaderDescription::BuiltinVariable &builtin : tescOutBuiltins) {
QShaderDescription::InOutVariable variable;
int binding = -1;
quint32 *offset = nullptr;
quint32 *alignment = nullptr;
switch (builtin.type) {
case QShaderDescription::BuiltinType::PositionBuiltin:
variable.type = QShaderDescription::VariableType::Vec4;
binding = tescOutputBufferBinding;
offset = &offsetInTescOutput;
alignment = &tescOutputAlignment;
break;
case QShaderDescription::BuiltinType::PointSizeBuiltin:
variable.type = QShaderDescription::VariableType::Float;
binding = tescOutputBufferBinding;
offset = &offsetInTescOutput;
alignment = &tescOutputAlignment;
break;
case QShaderDescription::BuiltinType::ClipDistanceBuiltin:
variable.type = QShaderDescription::VariableType::Float;
variable.arrayDims = builtin.arrayDims;
binding = tescOutputBufferBinding;
offset = &offsetInTescOutput;
alignment = &tescOutputAlignment;
break;
case QShaderDescription::BuiltinType::TessLevelOuterBuiltin:
variable.type = QShaderDescription::VariableType::Half4;
binding = tessFactorBufferBinding;
offset = &offsetInTessFactorBuffer;
tessLevelAdded = trianglesMode;
alignment = &tessFactorAlignment;
break;
case QShaderDescription::BuiltinType::TessLevelInnerBuiltin:
if (trianglesMode) {
if (!tessLevelAdded) {
variable.type = QShaderDescription::VariableType::Half4;
binding = tessFactorBufferBinding;
offsetInTessFactorBuffer = 0;
offset = &offsetInTessFactorBuffer;
alignment = &tessFactorAlignment;
tessLevelAdded = true;
} else {
teseInBuiltins.remove(builtin.type);
continue;
}
} else {
variable.type = QShaderDescription::VariableType::Half2;
binding = tessFactorBufferBinding;
offsetInTessFactorBuffer = 8;
offset = &offsetInTessFactorBuffer;
alignment = &tessFactorAlignment;
}
break;
default:
Q_UNREACHABLE();
break;
}
if (teseInBuiltins.contains(builtin.type)) {
if (binding != -1) {
int index = nextAttributeIndex(indices);
addVertexAttribute(variable, binding, rhiD, index, *offset, vertexDesc.attributes, indices, *alignment);
usedBuffers << binding;
} else {
qWarning() << "baked tessellation control shader missing output buffer binding information";
addUnusedVertexAttribute(variable, rhiD, *offset, *alignment);
}
} else {
addUnusedVertexAttribute(variable, rhiD, *offset, *alignment);
}
teseInBuiltins.remove(builtin.type);
}
for (const QShaderDescription::BuiltinVariable &builtin : teseInBuiltins) {
switch (builtin.type) {
case QShaderDescription::BuiltinType::PositionBuiltin:
case QShaderDescription::BuiltinType::PointSizeBuiltin:
case QShaderDescription::BuiltinType::ClipDistanceBuiltin:
qWarning() << "missing tessellation control output for tessellation evaluation builtin input:" << builtin;
break;
default:
break;
}
}
if (usedBuffers.contains(tescOutputBufferBinding)) {
vertexDesc.layouts[tescOutputBufferBinding].stepFunction = MTLVertexStepFunctionPerPatchControlPoint;
vertexDesc.layouts[tescOutputBufferBinding].stride = aligned(offsetInTescOutput, tescOutputAlignment);
}
if (usedBuffers.contains(tescPatchOutputBufferBinding)) {
vertexDesc.layouts[tescPatchOutputBufferBinding].stepFunction = MTLVertexStepFunctionPerPatch;
vertexDesc.layouts[tescPatchOutputBufferBinding].stride = aligned(offsetInTescPatchOutput, tescPatchOutputAlignment);
}
if (usedBuffers.contains(tessFactorBufferBinding)) {
vertexDesc.layouts[tessFactorBufferBinding].stepFunction = MTLVertexStepFunctionPerPatch;
vertexDesc.layouts[tessFactorBufferBinding].stride = trianglesMode ? sizeof(MTLTriangleTessellationFactorsHalf) : sizeof(MTLQuadTessellationFactorsHalf);
}
rpDesc.vertexDescriptor = vertexDesc;
rpDesc.vertexFunction = vertTese.func;
rpDesc.fragmentFunction = pipeline->d->fs.func;
// The portable, cross-API approach is to use CCW, the results are then
// identical (assuming the applied clipSpaceCorrMatrix) for all the 3D
// APIs. The tess.eval. GLSL shader is thus expected to specify ccw. If it
// doesn't, things may not work as expected.
rpDesc.tessellationOutputWindingOrder = toMetalTessellationWindingOrder(vertTese.desc.tessellationWindingOrder());
rpDesc.tessellationPartitionMode = toMetalTessellationPartitionMode(vertTese.desc.tessellationPartitioning());
QMetalRenderPassDescriptor *rpD = QRHI_RES(QMetalRenderPassDescriptor, pipeline->renderPassDescriptor());
pipeline->setupAttachmentsInMetalRenderPassDescriptor(rpDesc, rpD);
rhiD->d->trySeedingRenderPipelineFromBinaryArchive(rpDesc);
if (rhiD->rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
rhiD->d->addRenderPipelineToBinaryArchive(rpDesc);
NSError *err = nil;
id<MTLRenderPipelineState> ps = [rhiD->d->dev newRenderPipelineStateWithDescriptor: rpDesc error: &err];
[rpDesc release];
if (!ps) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to create render pipeline state for tessellation: %s", qPrintable(msg));
} else {
// ps is stored in the QMetalGraphicsPipelineData so the end result in this
// regard is no different from what createVertexFragmentPipeline does
pipeline->d->ps = ps;
}
return ps;
}
QMetalBuffer *QMetalGraphicsPipelineData::ExtraBufferManager::acquireWorkBuffer(QRhiMetal *rhiD, quint32 size, WorkBufType type)
{
QVector<QMetalBuffer *> *workBuffers = type == WorkBufType::DeviceLocal ? &deviceLocalWorkBuffers : &hostVisibleWorkBuffers;
// Check if something is reusable as-is.
for (QMetalBuffer *workBuf : *workBuffers) {
if (workBuf && workBuf->lastActiveFrameSlot == -1 && workBuf->size() >= size) {
workBuf->lastActiveFrameSlot = rhiD->currentFrameSlot;
return workBuf;
}
}
// Once the pool is above a certain threshold, see if there is something
// unused (but too small) and recreate that our size.
if (workBuffers->count() > QMTL_FRAMES_IN_FLIGHT * 8) {
for (QMetalBuffer *workBuf : *workBuffers) {
if (workBuf && workBuf->lastActiveFrameSlot == -1) {
workBuf->setSize(size);
if (workBuf->create()) {
workBuf->lastActiveFrameSlot = rhiD->currentFrameSlot;
return workBuf;
}
}
}
}
// Add a new buffer to the pool.
QMetalBuffer *buf;
if (type == WorkBufType::DeviceLocal) {
// for GPU->GPU data (non-slotted, not necessarily host writable)
buf = new QMetalBuffer(rhiD, QRhiBuffer::Static, QRhiBuffer::UsageFlags(QMetalBuffer::WorkBufPoolUsage), size);
} else {
// for CPU->GPU (non-slotted, host writable/coherent)
buf = new QMetalBuffer(rhiD, QRhiBuffer::Dynamic, QRhiBuffer::UsageFlags(QMetalBuffer::WorkBufPoolUsage), size);
}
if (buf->create()) {
buf->lastActiveFrameSlot = rhiD->currentFrameSlot;
workBuffers->append(buf);
return buf;
}
qWarning("Failed to acquire work buffer of size %u", size);
return nullptr;
}
bool QMetalGraphicsPipeline::createTessellationPipelines(const QShader &tessVert, const QShader &tesc, const QShader &tese, const QShader &tessFrag)
{
QRHI_RES_RHI(QRhiMetal);
QString error;
QByteArray entryPoint;
QShaderKey activeKey;
const QShaderDescription tescDesc = tesc.description();
const QShaderDescription teseDesc = tese.description();
d->tess.inControlPointCount = uint(m_patchControlPointCount);
d->tess.outControlPointCount = tescDesc.tessellationOutputVertexCount();
if (!d->tess.outControlPointCount)
d->tess.outControlPointCount = teseDesc.tessellationOutputVertexCount();
if (!d->tess.outControlPointCount) {
qWarning("Failed to determine output vertex count from the tessellation control or evaluation shader, cannot tessellate");
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
if (m_multiViewCount >= 2)
qWarning("Multiview is not supported with tessellation");
// Now the vertex shader is a compute shader.
// It should have three dedicated *VertexAsComputeShader variants.
// What the requested variant was (Standard or Batchable) plays no role here.
// (the Qt Quick scenegraph does not use tessellation with its materials)
// Create all three versions.
bool variantsPresent[3] = {};
const QVector<QShaderKey> tessVertKeys = tessVert.availableShaders();
for (const QShaderKey &k : tessVertKeys) {
switch (k.sourceVariant()) {
case QShader::NonIndexedVertexAsComputeShader:
variantsPresent[0] = true;
break;
case QShader::UInt32IndexedVertexAsComputeShader:
variantsPresent[1] = true;
break;
case QShader::UInt16IndexedVertexAsComputeShader:
variantsPresent[2] = true;
break;
default:
break;
}
}
if (!(variantsPresent[0] && variantsPresent[1] && variantsPresent[2])) {
qWarning("Vertex shader is not prepared for Metal tessellation. Cannot tessellate. "
"Perhaps the relevant variants (UInt32IndexedVertexAsComputeShader et al) were not generated? "
"Try passing --msltess to qsb.");
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
int varIndex = 0; // Will map NonIndexed as 0, UInt32 as 1, UInt16 as 2. Do not change this ordering.
for (QShader::Variant variant : {
QShader::NonIndexedVertexAsComputeShader,
QShader::UInt32IndexedVertexAsComputeShader,
QShader::UInt16IndexedVertexAsComputeShader })
{
id<MTLLibrary> lib = rhiD->d->createMetalLib(tessVert, variant, false, &error, &entryPoint, &activeKey);
if (!lib) {
qWarning("MSL shader compilation failed for vertex-as-compute shader %d: %s", int(variant), qPrintable(error));
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
id<MTLFunction> func = rhiD->d->createMSLShaderFunction(lib, entryPoint);
if (!func) {
qWarning("MSL function for entry point %s not found", entryPoint.constData());
[lib release];
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
QMetalShader &compVs(d->tess.compVs[varIndex]);
compVs.lib = lib;
compVs.func = func;
compVs.desc = tessVert.description();
compVs.nativeResourceBindingMap = tessVert.nativeResourceBindingMap(activeKey);
compVs.nativeShaderInfo = tessVert.nativeShaderInfo(activeKey);
// pre-create all three MTLComputePipelineStates
if (!d->tess.vsCompPipeline(rhiD, variant)) {
qWarning("Failed to pre-generate compute pipeline for vertex compute shader (tessellation variant %d)", int(variant));
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
++varIndex;
}
// Pipeline #2 is a compute that runs the tessellation control (compute) shader
id<MTLLibrary> tessControlLib = rhiD->d->createMetalLib(tesc, QShader::StandardShader, false, &error, &entryPoint, &activeKey);
if (!tessControlLib) {
qWarning("MSL shader compilation failed for tessellation control compute shader: %s", qPrintable(error));
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
id<MTLFunction> tessControlFunc = rhiD->d->createMSLShaderFunction(tessControlLib, entryPoint);
if (!tessControlFunc) {
qWarning("MSL function for entry point %s not found", entryPoint.constData());
[tessControlLib release];
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
d->tess.compTesc.lib = tessControlLib;
d->tess.compTesc.func = tessControlFunc;
d->tess.compTesc.desc = tesc.description();
d->tess.compTesc.nativeResourceBindingMap = tesc.nativeResourceBindingMap(activeKey);
d->tess.compTesc.nativeShaderInfo = tesc.nativeShaderInfo(activeKey);
if (!d->tess.tescCompPipeline(rhiD)) {
qWarning("Failed to pre-generate compute pipeline for tessellation control shader");
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
// Pipeline #3 is a render pipeline with the tessellation evaluation (vertex) + the fragment shader
id<MTLLibrary> tessEvalLib = rhiD->d->createMetalLib(tese, QShader::StandardShader, false, &error, &entryPoint, &activeKey);
if (!tessEvalLib) {
qWarning("MSL shader compilation failed for tessellation evaluation vertex shader: %s", qPrintable(error));
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
id<MTLFunction> tessEvalFunc = rhiD->d->createMSLShaderFunction(tessEvalLib, entryPoint);
if (!tessEvalFunc) {
qWarning("MSL function for entry point %s not found", entryPoint.constData());
[tessEvalLib release];
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
d->tess.vertTese.lib = tessEvalLib;
d->tess.vertTese.func = tessEvalFunc;
d->tess.vertTese.desc = tese.description();
d->tess.vertTese.nativeResourceBindingMap = tese.nativeResourceBindingMap(activeKey);
d->tess.vertTese.nativeShaderInfo = tese.nativeShaderInfo(activeKey);
id<MTLLibrary> fragLib = rhiD->d->createMetalLib(tessFrag, QShader::StandardShader, false, &error, &entryPoint, &activeKey);
if (!fragLib) {
qWarning("MSL shader compilation failed for fragment shader: %s", qPrintable(error));
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
id<MTLFunction> fragFunc = rhiD->d->createMSLShaderFunction(fragLib, entryPoint);
if (!fragFunc) {
qWarning("MSL function for entry point %s not found", entryPoint.constData());
[fragLib release];
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
d->fs.lib = fragLib;
d->fs.func = fragFunc;
d->fs.desc = tessFrag.description();
d->fs.nativeShaderInfo = tessFrag.nativeShaderInfo(activeKey);
d->fs.nativeResourceBindingMap = tessFrag.nativeResourceBindingMap(activeKey);
if (!d->tess.teseFragRenderPipeline(rhiD, this)) {
qWarning("Failed to pre-generate render pipeline for tessellation evaluation + fragment shader");
d->tess.enabled = false;
d->tess.failed = true;
return false;
}
MTLDepthStencilDescriptor *dsDesc = [[MTLDepthStencilDescriptor alloc] init];
setupMetalDepthStencilDescriptor(dsDesc);
d->ds = [rhiD->d->dev newDepthStencilStateWithDescriptor: dsDesc];
[dsDesc release];
// no primitiveType
mapStates();
return true;
}
bool QMetalGraphicsPipeline::create()
{
destroy(); // no early test, always invoke and leave it to destroy to decide what to clean up
QRHI_RES_RHI(QRhiMetal);
rhiD->pipelineCreationStart();
if (!rhiD->sanityCheckGraphicsPipeline(this))
return false;
// See if tessellation is involved. Things will be very different, if so.
QShader tessVert;
QShader tesc;
QShader tese;
QShader tessFrag;
for (const QRhiShaderStage &shaderStage : std::as_const(m_shaderStages)) {
switch (shaderStage.type()) {
case QRhiShaderStage::Vertex:
tessVert = shaderStage.shader();
break;
case QRhiShaderStage::TessellationControl:
tesc = shaderStage.shader();
break;
case QRhiShaderStage::TessellationEvaluation:
tese = shaderStage.shader();
break;
case QRhiShaderStage::Fragment:
tessFrag = shaderStage.shader();
break;
default:
break;
}
}
d->tess.enabled = tesc.isValid() && tese.isValid() && m_topology == Patches && m_patchControlPointCount > 0;
d->tess.failed = false;
bool ok = d->tess.enabled ? createTessellationPipelines(tessVert, tesc, tese, tessFrag) : createVertexFragmentPipeline();
if (!ok)
return false;
// SPIRV-Cross buffer size buffers
int buffers = 0;
QVarLengthArray<QMetalShader *, 6> shaders;
if (d->tess.enabled) {
shaders.append(&d->tess.compVs[0]);
shaders.append(&d->tess.compVs[1]);
shaders.append(&d->tess.compVs[2]);
shaders.append(&d->tess.compTesc);
shaders.append(&d->tess.vertTese);
} else {
shaders.append(&d->vs);
}
shaders.append(&d->fs);
for (QMetalShader *shader : shaders) {
if (shader->nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding)) {
const int binding = shader->nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding];
shader->nativeResourceBindingMap[binding] = {binding, -1};
int maxNativeBinding = 0;
for (const QShaderDescription::StorageBlock &block : shader->desc.storageBlocks())
maxNativeBinding = qMax(maxNativeBinding, shader->nativeResourceBindingMap[block.binding].first);
// we use one buffer to hold data for all graphics shader stages, each with a different offset.
// buffer offsets must be 32byte aligned - adjust buffer count accordingly
buffers += ((maxNativeBinding + 1 + 7) / 8) * 8;
}
}
if (buffers) {
if (!d->bufferSizeBuffer)
d->bufferSizeBuffer = new QMetalBuffer(rhiD, QRhiBuffer::Static,
QRhiBuffer::UsageFlags(int(QRhiBuffer::StorageBuffer)
| QMetalBuffer::InternalHostWritable),
buffers * sizeof(int));
d->bufferSizeBuffer->setSize(buffers * sizeof(int));
d->bufferSizeBuffer->create();
}
rhiD->pipelineCreationEnd();
lastActiveFrameSlot = -1;
generation += 1;
rhiD->registerResource(this);
return true;
}
QMetalComputePipeline::QMetalComputePipeline(QRhiImplementation *rhi)
: QRhiComputePipeline(rhi),
d(new QMetalComputePipelineData)
{
}
QMetalComputePipeline::~QMetalComputePipeline()
{
destroy();
delete d;
}
void QMetalComputePipeline::destroy()
{
d->cs.destroy();
if (!d->ps)
return;
delete d->bufferSizeBuffer;
d->bufferSizeBuffer = nullptr;
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::ComputePipeline;
e.lastActiveFrameSlot = lastActiveFrameSlot;
e.computePipeline.pipelineState = d->ps;
d->ps = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->d->releaseQueue.append(e);
rhiD->unregisterResource(this);
}
}
void QRhiMetalData::trySeedingComputePipelineFromBinaryArchive(MTLComputePipelineDescriptor *cpDesc)
{
if (binArch) {
NSArray *binArchArray = [NSArray arrayWithObjects: binArch, nil];
cpDesc.binaryArchives = binArchArray;
}
}
void QRhiMetalData::addComputePipelineToBinaryArchive(MTLComputePipelineDescriptor *cpDesc)
{
if (binArch) {
NSError *err = nil;
if (![binArch addComputePipelineFunctionsWithDescriptor: cpDesc error: &err]) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to collect compute pipeline functions to binary archive: %s", qPrintable(msg));
}
}
}
bool QMetalComputePipeline::create()
{
if (d->ps)
destroy();
QRHI_RES_RHI(QRhiMetal);
rhiD->pipelineCreationStart();
auto cacheIt = rhiD->d->shaderCache.constFind({ m_shaderStage, false });
if (cacheIt != rhiD->d->shaderCache.constEnd()) {
d->cs = *cacheIt;
} else {
const QShader shader = m_shaderStage.shader();
QString error;
QByteArray entryPoint;
QShaderKey activeKey;
id<MTLLibrary> lib = rhiD->d->createMetalLib(shader, m_shaderStage.shaderVariant(), false,
&error, &entryPoint, &activeKey);
if (!lib) {
qWarning("MSL shader compilation failed: %s", qPrintable(error));
return false;
}
id<MTLFunction> func = rhiD->d->createMSLShaderFunction(lib, entryPoint);
if (!func) {
qWarning("MSL function for entry point %s not found", entryPoint.constData());
[lib release];
return false;
}
d->cs.lib = lib;
d->cs.func = func;
d->cs.localSize = shader.description().computeShaderLocalSize();
d->cs.nativeResourceBindingMap = shader.nativeResourceBindingMap(activeKey);
d->cs.desc = shader.description();
d->cs.nativeShaderInfo = shader.nativeShaderInfo(activeKey);
// Compute never needs argument buffers on its own (they are there for
// indirect command buffers, which are graphics-only), hence not asking
// for that shader variant above. It can still be requested explicitly
// via the QRhiShaderStage, in which case the textures and samplers have
// to go through an argument buffer here as well.
setupArgumentBufferEncoder(&d->cs);
// SPIRV-Cross buffer size buffers
if (d->cs.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding)) {
const int binding = d->cs.nativeShaderInfo.extraBufferBindings[QShaderPrivate::MslBufferSizeBufferBinding];
d->cs.nativeResourceBindingMap[binding] = {binding, -1};
}
if (rhiD->d->shaderCache.count() >= QRhiMetal::MAX_SHADER_CACHE_ENTRIES) {
for (QMetalShader &s : rhiD->d->shaderCache)
s.destroy();
rhiD->d->shaderCache.clear();
}
rhiD->d->shaderCache.insert({ m_shaderStage, false }, d->cs);
}
[d->cs.lib retain];
[d->cs.func retain];
[d->cs.argumentEncoder retain];
if (d->cs.argumentBufferIndex >= 0 && !rhiD->caps.indirectCommandBuffers) {
// Sampler states are created with supportArgumentBuffers only when this
// cap is present, and Metal faults the GPU without any warning when one
// that lacks it is used with an argument buffer.
qWarning("The ArgumentBufferShader variant of a compute shader cannot be used on this device");
return false;
}
d->localSize = MTLSizeMake(d->cs.localSize[0], d->cs.localSize[1], d->cs.localSize[2]);
MTLComputePipelineDescriptor *cpDesc = [MTLComputePipelineDescriptor new];
cpDesc.computeFunction = d->cs.func;
rhiD->d->trySeedingComputePipelineFromBinaryArchive(cpDesc);
if (rhiD->rhiFlags.testFlag(QRhi::EnablePipelineCacheDataSave))
rhiD->d->addComputePipelineToBinaryArchive(cpDesc);
NSError *err = nil;
d->ps = [rhiD->d->dev newComputePipelineStateWithDescriptor: cpDesc
options: MTLPipelineOptionNone
reflection: nil
error: &err];
[cpDesc release];
if (!d->ps) {
const QString msg = QString::fromNSString(err.localizedDescription);
qWarning("Failed to create compute pipeline state: %s", qPrintable(msg));
return false;
}
// SPIRV-Cross buffer size buffers
if (d->cs.nativeShaderInfo.extraBufferBindings.contains(QShaderPrivate::MslBufferSizeBufferBinding)) {
int buffers = 0;
for (const QShaderDescription::StorageBlock &block : d->cs.desc.storageBlocks())
buffers = qMax(buffers, d->cs.nativeResourceBindingMap[block.binding].first);
buffers += 1;
if (!d->bufferSizeBuffer)
d->bufferSizeBuffer = new QMetalBuffer(rhiD, QRhiBuffer::Static,
QRhiBuffer::UsageFlags(int(QRhiBuffer::StorageBuffer)
| QMetalBuffer::InternalHostWritable),
buffers * sizeof(int));
d->bufferSizeBuffer->setSize(buffers * sizeof(int));
d->bufferSizeBuffer->create();
}
rhiD->pipelineCreationEnd();
lastActiveFrameSlot = -1;
generation += 1;
rhiD->registerResource(this);
return true;
}
QMetalCommandBuffer::QMetalCommandBuffer(QRhiImplementation *rhi)
: QRhiCommandBuffer(rhi),
d(new QMetalCommandBufferData)
{
resetState();
}
QMetalCommandBuffer::~QMetalCommandBuffer()
{
destroy();
delete d;
}
void QMetalCommandBuffer::destroy()
{
// nothing to do here, we do not own the MTL cb object
}
const QRhiNativeHandles *QMetalCommandBuffer::nativeHandles()
{
nativeHandlesStruct.commandBuffer = (MTLCommandBuffer *) d->cb;
nativeHandlesStruct.encoder = (MTLRenderCommandEncoder *) d->currentRenderPassEncoder;
return &nativeHandlesStruct;
}
void QMetalCommandBuffer::resetState(double lastGpuTime)
{
d->lastGpuTime = lastGpuTime;
d->currentRenderPassEncoder = nil;
d->currentComputePassEncoder = nil;
d->tessellationComputeEncoder = nil;
d->currentPassRpDesc = nil;
resetPerPassState();
}
void QMetalCommandBuffer::resetPerPassState()
{
recordingPass = NoPass;
currentTarget = nullptr;
d->openDebugGroups.clear();
resetPerPassCachedState();
}
void QMetalCommandBuffer::resetPerPassCachedState()
{
currentGraphicsPipeline = nullptr;
currentComputePipeline = nullptr;
currentPipelineGeneration = 0;
pushConstantData.clear();
pushConstantsNeedRebind = false;
currentGraphicsSrb = nullptr;
currentComputeSrb = nullptr;
currentSrbGeneration = 0;
currentResSlot = -1;
currentIndexBuffer = nullptr;
currentIndexOffset = 0;
currentIndexFormat = QRhiCommandBuffer::IndexUInt16;
currentCullMode = -1;
currentTriangleFillMode = -1;
currentDepthClipMode = -1;
currentFrontFaceWinding = -1;
currentDepthBiasValues = { 0.0f, 0.0f };
hasCustomScissorSet = false;
currentScissor = {};
currentViewport = {};
hasBlendConstantsSet = false;
currentBlendConstants = {};
hasStencilRefSet = false;
currentStencilRef = 0;
d->currentShaderResourceBindingState = {};
d->currentDepthStencilState = nil;
d->currentFirstVertexBinding = -1;
d->currentVertexInputsBuffers.clear();
d->currentVertexInputOffsets.clear();
}
QMetalSwapChain::QMetalSwapChain(QRhiImplementation *rhi)
: QRhiSwapChain(rhi),
rtWrapper(rhi, this),
cbWrapper(rhi),
d(new QMetalSwapChainData)
{
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
d->sem[i] = nullptr;
d->msaaTex[i] = nil;
}
}
QMetalSwapChain::~QMetalSwapChain()
{
destroy();
delete d;
}
void QMetalSwapChain::destroy()
{
if (!d->layer)
return;
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
if (d->sem[i]) {
// the semaphores cannot be released if they do not have the initial value
waitUntilCompleted(i);
dispatch_release(d->sem[i]);
d->sem[i] = nullptr;
}
}
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
[d->msaaTex[i] release];
d->msaaTex[i] = nil;
}
d->layer = nullptr;
m_proxyData = {};
[d->curDrawable release];
d->curDrawable = nil;
QRHI_RES_RHI(QRhiMetal);
if (rhiD) {
rhiD->swapchains.remove(this);
rhiD->unregisterResource(this);
}
}
QRhiCommandBuffer *QMetalSwapChain::currentFrameCommandBuffer()
{
return &cbWrapper;
}
QRhiRenderTarget *QMetalSwapChain::currentFrameRenderTarget()
{
return &rtWrapper;
}
// view.layer should ideally be called on the main thread, otherwise the UI
// Thread Checker in Xcode drops a warning. Hence trying to proxy it through
// QRhiSwapChainProxyData instead of just calling this function directly.
static inline CAMetalLayer *layerForWindow(QWindow *window)
{
Q_ASSERT(window);
CALayer *layer = nullptr;
#ifdef Q_OS_MACOS
if (auto *cocoaWindow = window->nativeInterface<QNativeInterface::Private::QCocoaWindow>())
layer = cocoaWindow->contentLayer();
#else
layer = reinterpret_cast<UIView *>(window->winId()).layer;
#endif
Q_ASSERT(layer);
return static_cast<CAMetalLayer *>(layer);
}
// If someone calls this, it is hopefully from the main thread, and they will
// then set the returned data on the QRhiSwapChain, so it won't need to query
// the layer on its own later on.
QRhiSwapChainProxyData QRhiMetal::updateSwapChainProxyData(QWindow *window)
{
QRhiSwapChainProxyData d;
d.reserved[0] = layerForWindow(window);
return d;
}
QSize QMetalSwapChain::surfacePixelSize()
{
Q_ASSERT(m_window);
CAMetalLayer *layer = d->layer;
if (!layer)
layer = qrhi_objectFromProxyData<CAMetalLayer>(&m_proxyData, m_window, QRhi::Metal, 0);
Q_ASSERT(layer);
int height = (int)layer.bounds.size.height;
int width = (int)layer.bounds.size.width;
width *= layer.contentsScale;
height *= layer.contentsScale;
return QSize(width, height);
}
bool QMetalSwapChain::isFormatSupported(Format f)
{
if (f == HDRExtendedSrgbLinear) {
return hdrInfo().limits.colorComponentValue.maxPotentialColorComponentValue > 1.0f;
} else if (f == HDR10) {
return hdrInfo().limits.colorComponentValue.maxPotentialColorComponentValue > 1.0f;
} else if (f == HDRExtendedDisplayP3Linear) {
return hdrInfo().limits.colorComponentValue.maxPotentialColorComponentValue > 1.0f;
}
return f == SDR;
}
QRhiRenderPassDescriptor *QMetalSwapChain::newCompatibleRenderPassDescriptor()
{
QRHI_RES_RHI(QRhiMetal);
chooseFormats(); // ensure colorFormat and similar are filled out
QMetalRenderPassDescriptor *rpD = new QMetalRenderPassDescriptor(m_rhi);
rpD->colorAttachmentCount = 1;
rpD->hasDepthStencil = m_depthStencil != nullptr;
rpD->colorFormat[0] = int(d->colorFormat);
#ifdef Q_OS_MACOS
// m_depthStencil may not be built yet so cannot rely on computed fields in it
rpD->dsFormat = rhiD->d->dev.depth24Stencil8PixelFormatSupported
? MTLPixelFormatDepth24Unorm_Stencil8 : MTLPixelFormatDepth32Float_Stencil8;
#else
rpD->dsFormat = MTLPixelFormatDepth32Float_Stencil8;
#endif
rpD->hasShadingRateMap = m_shadingRateMap != nullptr;
rpD->updateSerializedFormat();
rhiD->registerResource(rpD, false);
return rpD;
}
void QMetalSwapChain::chooseFormats()
{
QRHI_RES_RHI(QRhiMetal);
samples = rhiD->effectiveSampleCount(m_sampleCount);
// pick a format that is allowed for CAMetalLayer.pixelFormat
if (m_format == HDRExtendedSrgbLinear || m_format == HDRExtendedDisplayP3Linear) {
d->colorFormat = MTLPixelFormatRGBA16Float;
d->rhiColorFormat = QRhiTexture::RGBA16F;
return;
}
if (m_format == HDR10) {
d->colorFormat = MTLPixelFormatRGB10A2Unorm;
d->rhiColorFormat = QRhiTexture::RGB10A2;
return;
}
d->colorFormat = m_flags.testFlag(sRGB) ? MTLPixelFormatBGRA8Unorm_sRGB : MTLPixelFormatBGRA8Unorm;
d->rhiColorFormat = QRhiTexture::BGRA8;
}
void QMetalSwapChain::waitUntilCompleted(int slot)
{
// wait+signal is the general pattern to ensure the commands for a
// given frame slot have completed (if sem is 1, we go 0 then 1; if
// sem is 0 we go -1, block, completion increments to 0, then us to 1)
dispatch_semaphore_t sem = d->sem[slot];
dispatch_semaphore_wait(sem, DISPATCH_TIME_FOREVER);
dispatch_semaphore_signal(sem);
}
bool QMetalSwapChain::createOrResize()
{
Q_ASSERT(m_window);
const bool needsRegistration = !window || window != m_window;
if (window && window != m_window)
destroy();
// else no destroy(), this is intentional
QRHI_RES_RHI(QRhiMetal);
if (needsRegistration || !rhiD->swapchains.contains(this))
rhiD->swapchains.insert(this);
window = m_window;
if (window->surfaceType() != QSurface::MetalSurface) {
qWarning("QMetalSwapChain only supports MetalSurface windows");
return false;
}
d->layer = qrhi_objectFromProxyData<CAMetalLayer>(&m_proxyData, window, QRhi::Metal, 0);
Q_ASSERT(d->layer);
chooseFormats();
if (d->colorFormat != d->layer.pixelFormat)
d->layer.pixelFormat = d->colorFormat;
if (m_format == HDRExtendedSrgbLinear) {
d->layer.colorspace = CGColorSpaceCreateWithName(kCGColorSpaceExtendedLinearSRGB);
d->layer.wantsExtendedDynamicRangeContent = YES;
} else if (m_format == HDR10) {
d->layer.colorspace = CGColorSpaceCreateWithName(kCGColorSpaceITUR_2100_PQ);
d->layer.wantsExtendedDynamicRangeContent = YES;
} else if (m_format == HDRExtendedDisplayP3Linear) {
d->layer.colorspace = CGColorSpaceCreateWithName(kCGColorSpaceExtendedLinearDisplayP3);
d->layer.wantsExtendedDynamicRangeContent = YES;
}
if (m_flags.testFlag(UsedAsTransferSource))
d->layer.framebufferOnly = NO;
#ifdef Q_OS_MACOS
if (m_flags.testFlag(NoVSync))
d->layer.displaySyncEnabled = NO;
#endif
if (m_flags.testFlag(SurfaceHasPreMulAlpha)) {
d->layer.opaque = NO;
} else if (m_flags.testFlag(SurfaceHasNonPreMulAlpha)) {
// The CoreAnimation compositor is said to expect premultiplied alpha,
// so this is then wrong when it comes to the blending operations but
// there's nothing we can do. Fortunately Qt Quick always outputs
// premultiplied alpha so it is not a problem there.
d->layer.opaque = NO;
} else {
d->layer.opaque = YES;
}
// Now set the layer's drawableSize which will stay set to the same value
// until the next createOrResize(), thus ensuring atomicity with regards to
// the drawable size in frames.
int width = (int)d->layer.bounds.size.width;
int height = (int)d->layer.bounds.size.height;
CGSize layerSize = CGSizeMake(width, height);
const float scaleFactor = d->layer.contentsScale;
layerSize.width *= scaleFactor;
layerSize.height *= scaleFactor;
d->layer.drawableSize = layerSize;
m_currentPixelSize = QSizeF::fromCGSize(layerSize).toSize();
pixelSize = m_currentPixelSize;
[d->layer setDevice: rhiD->d->dev];
[d->curDrawable release];
d->curDrawable = nil;
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
d->lastGpuTime[i] = 0;
if (!d->sem[i])
d->sem[i] = dispatch_semaphore_create(QMTL_FRAMES_IN_FLIGHT - 1);
}
currentFrameSlot = 0;
frameCount = 0;
ds = m_depthStencil ? QRHI_RES(QMetalRenderBuffer, m_depthStencil) : nullptr;
if (m_depthStencil && m_depthStencil->sampleCount() != m_sampleCount) {
qWarning("Depth-stencil buffer's sampleCount (%d) does not match color buffers' sample count (%d). Expect problems.",
m_depthStencil->sampleCount(), m_sampleCount);
}
if (m_depthStencil && m_depthStencil->pixelSize() != pixelSize) {
if (m_depthStencil->flags().testFlag(QRhiRenderBuffer::UsedWithSwapChainOnly)) {
m_depthStencil->setPixelSize(pixelSize);
if (!m_depthStencil->create())
qWarning("Failed to rebuild swapchain's associated depth-stencil buffer for size %dx%d",
pixelSize.width(), pixelSize.height());
} else {
qWarning("Depth-stencil buffer's size (%dx%d) does not match the layer size (%dx%d). Expect problems.",
m_depthStencil->pixelSize().width(), m_depthStencil->pixelSize().height(),
pixelSize.width(), pixelSize.height());
}
}
rtWrapper.setRenderPassDescriptor(m_renderPassDesc); // for the public getter in QRhiRenderTarget
rtWrapper.d->pixelSize = pixelSize;
rtWrapper.d->dpr = scaleFactor;
rtWrapper.d->sampleCount = samples;
rtWrapper.d->colorAttCount = 1;
rtWrapper.d->dsAttCount = ds ? 1 : 0;
qCDebug(QRHI_LOG_INFO, "got CAMetalLayer, pixel size %dx%d (scale %.2f)",
pixelSize.width(), pixelSize.height(), scaleFactor);
if (samples > 1) {
MTLTextureDescriptor *desc = [[MTLTextureDescriptor alloc] init];
desc.textureType = MTLTextureType2DMultisample;
desc.pixelFormat = d->colorFormat;
desc.width = NSUInteger(pixelSize.width());
desc.height = NSUInteger(pixelSize.height());
desc.sampleCount = NSUInteger(samples);
desc.resourceOptions = MTLResourceStorageModePrivate;
desc.storageMode = MTLStorageModePrivate;
desc.usage = MTLTextureUsageRenderTarget;
for (int i = 0; i < QMTL_FRAMES_IN_FLIGHT; ++i) {
if (d->msaaTex[i]) {
QRhiMetalData::DeferredReleaseEntry e;
e.type = QRhiMetalData::DeferredReleaseEntry::RenderBuffer;
e.lastActiveFrameSlot = 1; // because currentFrameSlot is reset to 0
e.renderbuffer.texture = d->msaaTex[i];
rhiD->d->releaseQueue.append(e);
}
d->msaaTex[i] = [rhiD->d->dev newTextureWithDescriptor: desc];
}
[desc release];
}
rhiD->registerResource(this);
return true;
}
QRhiSwapChainHdrInfo QMetalSwapChain::hdrInfo()
{
QRhiSwapChainHdrInfo info;
info.limitsType = QRhiSwapChainHdrInfo::ColorComponentValue;
info.limits.colorComponentValue.maxColorComponentValue = 1;
info.limits.colorComponentValue.maxPotentialColorComponentValue = 1;
info.luminanceBehavior = QRhiSwapChainHdrInfo::DisplayReferred; // 1.0 = SDR white
info.sdrWhiteLevel = 200; // typical value, but dummy (don't know the real one); won't matter due to being display-referred
if (m_window) {
// Must use m_window, not window, given this may be called before createOrResize().
#if defined(Q_OS_MACOS)
NSView *view = reinterpret_cast<NSView *>(m_window->winId());
NSScreen *screen = view.window.screen;
info.limits.colorComponentValue.maxColorComponentValue = screen.maximumExtendedDynamicRangeColorComponentValue;
info.limits.colorComponentValue.maxPotentialColorComponentValue = screen.maximumPotentialExtendedDynamicRangeColorComponentValue;
#elif defined(Q_OS_IOS)
UIView *view = reinterpret_cast<UIView *>(m_window->winId());
UIScreen *screen = view.window.windowScene.screen;
info.limits.colorComponentValue.maxColorComponentValue =
view.window.windowScene.screen.currentEDRHeadroom;
info.limits.colorComponentValue.maxPotentialColorComponentValue =
screen.potentialEDRHeadroom;
#endif
}
return info;
}
QT_END_NAMESPACE