Volatile dynamic buffers in Metal

colincornaby · Dec 3, 2023 · 35a886b · 35a886b
1 parent cb0002a
commit 35a886b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/Sources/Plasma/FeatureLib/pfMetalPipeline/plMetalDevice.h b/Sources/Plasma/FeatureLib/pfMetalPipeline/plMetalDevice.h
@@ -162,6 +162,7 @@ class plMetalDevice
     // Currently requires a CA drawable and not a Metal drawable. In since CA drawable is only abstract implementation I know about, not sure where we would find others?
     void                CreateNewCommandBuffer(CA::MetalDrawable* drawable);
     MTL::CommandBuffer* GetCurrentCommandBuffer();
+    MTL::CommandBuffer* GetCurrentDrawableCommandBuffer() { return fCurrentCommandBuffer; }
     CA::MetalDrawable*  GetCurrentDrawable() const;
     /// Submit the command buffer to the GPU and draws all the render passes. Clears the current command buffer.
     void                SubmitCommandBuffer();

diff --git a/Sources/Plasma/FeatureLib/pfMetalPipeline/plMetalPipeline.cpp b/Sources/Plasma/FeatureLib/pfMetalPipeline/plMetalPipeline.cpp
@@ -1953,12 +1953,8 @@ bool plMetalPipeline::ICheckDynBuffers(plDrawableSpans* drawable, plGBufferGroup
 
     // If our vertex buffer ref is volatile and the timestamp is off
     // then it needs to be refilled
-    // MTL::PurgeableState bufferState = vRef->fVertexBuffer->setPurgeableState(MTL::PurgeableStateNonVolatile);
     if (vRef->Expired(fVtxRefTime)) {
         IRefreshDynVertices(group, vRef);
-        // fDevice.GetCurrentCommandBuffer()->addCompletedHandler( ^(MTL::CommandBuffer *buffer) {
-        // vRef->fVertexBuffer->setPurgeableState(MTL::PurgeableStateVolatile);
-        // });
     }
 
     if (iRef->IsDirty()) {
@@ -1990,12 +1986,19 @@ bool plMetalPipeline::IRefreshDynVertices(plGBufferGroup* group, plMetalVertexBu
     vRef->PrepareForWrite();
 
     MTL::Buffer* vertexBuffer = vRef->GetBuffer();
+    // Metal note: we don't need to check if the buffer is purged, Plasma always wants to refill.
+    // This works a bit differently than a typical volatile resource pattern where we'd want
+    // to check if the resource is empty before refilling.
+    vertexBuffer->setPurgeableState(MTL::PurgeableStateNonVolatile);
     if (!vertexBuffer || vertexBuffer->length() < size) {
         // Plasma will present different length buffers at different times
         vertexBuffer = fDevice.fMetalDevice->newBuffer(vData, size, MTL::ResourceStorageModeManaged)->autorelease();
         if (vRef->Volatile()) {
-            fDevice.GetCurrentCommandBuffer()->addCompletedHandler(^(MTL::CommandBuffer* buffer){
-                // vRef->fVertexBuffer->setPurgeableState(MTL::PurgeableStateVolatile);
+            // We need to manually mark the buffer as eligible for freeing after render
+            // Only allow this resource to be volatile after the on screen command buffer.
+            // It should not be freed after something like a shadow render command buffer.
+            fDevice.GetCurrentDrawableCommandBuffer()->addCompletedHandler(^(MTL::CommandBuffer* buffer) {
+                vertexBuffer->setPurgeableState(MTL::PurgeableStateVolatile);
             });
         }
         vRef->SetBuffer(vertexBuffer);