rename executeCommandBuffers -> submit

shader-slang · Oct 11, 2024 · 97ba8cf · 97ba8cf
1 parent b58c00d
commit 97ba8cf
Show file tree

Hide file tree

Showing 15 changed files with 20 additions and 31 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -173,7 +173,7 @@
 | API                          | CPU | CUDA | D3D11 | D3D12 | Vulkan | Metal | WGPU |
 |------------------------------|-----|------|-------|-------|--------|-------|------|
 | `getDesc`                    | yes | yes  | yes   | yes   | yes    | yes   | yes  |
-| `executeCommandBuffers`      | yes | yes  | yes   | yes   | yes    | yes   | yes  |
+| `submit`                     | yes | yes  | yes   | yes   | yes    | yes   | yes  |
 | `getNativeHandle`            | :x: | :x:  | :x:   | yes   | yes    | yes   | yes  |
 | `waitOnHost`                 | yes | yes  | yes   | yes   | yes    | :x:   | yes  |
 | `waitForFenceValuesOnDevice` | :x: | :x:  | :x:   | yes   | yes    | yes   | :x:  |

diff --git a/include/slang-rhi.h b/include/slang-rhi.h
@@ -1937,20 +1937,16 @@ class ICommandQueue : public ISlangUnknown
 public:
     virtual SLANG_NO_THROW QueueType SLANG_MCALL getType() = 0;
 
-    virtual SLANG_NO_THROW void SLANG_MCALL executeCommandBuffers(
-        GfxCount count,
-        ICommandBuffer* const* commandBuffers,
-        IFence* fenceToSignal,
-        uint64_t newFenceValue
-    ) = 0;
+    virtual SLANG_NO_THROW void SLANG_MCALL
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fenceToSignal, uint64_t newFenceValue) = 0;
 
     inline void executeCommandBuffer(
         ICommandBuffer* commandBuffer,
         IFence* fenceToSignal = nullptr,
         uint64_t newFenceValue = 0
     )
     {
-        executeCommandBuffers(1, &commandBuffer, fenceToSignal, newFenceValue);
+        submit(1, &commandBuffer, fenceToSignal, newFenceValue);
     }
 
     virtual SLANG_NO_THROW Result SLANG_MCALL getNativeHandle(NativeHandle* outHandle) = 0;
@@ -1997,7 +1993,7 @@ class ITransientResourceHeap : public ISlangUnknown
     virtual SLANG_NO_THROW Result SLANG_MCALL finish() = 0;
 
     // Command buffers are one-time use. Once it is submitted to the queue via
-    // `executeCommandBuffers` a command buffer is no longer valid to be used any more. Command
+    // `submit` a command buffer is no longer valid to be used any more. Command
     // buffers must be closed before submission. The current D3D12 implementation has a limitation
     // that only one command buffer maybe recorded at a time. User must finish recording a command
     // buffer before creating another command buffer.

diff --git a/src/cuda/cuda-command-queue.cpp b/src/cuda/cuda-command-queue.cpp
@@ -20,7 +20,7 @@ CommandQueueImpl::~CommandQueueImpl()
     currentRootObject = nullptr;
 }
 
-void CommandQueueImpl::executeCommandBuffers(
+void CommandQueueImpl::submit(
     GfxCount count,
     ICommandBuffer* const* commandBuffers,
     IFence* fence,

diff --git a/src/cuda/cuda-command-queue.h b/src/cuda/cuda-command-queue.h
@@ -19,8 +19,7 @@ class CommandQueueImpl : public CommandQueue<DeviceImpl>
     ~CommandQueueImpl();
 
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override;
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override;
 
     virtual SLANG_NO_THROW void SLANG_MCALL waitOnHost() override;
 

diff --git a/src/d3d12/d3d12-command-queue.cpp b/src/d3d12/d3d12-command-queue.cpp
@@ -31,7 +31,7 @@ Result CommandQueueImpl::init(uint32_t queueIndex)
     return SLANG_OK;
 }
 
-void CommandQueueImpl::executeCommandBuffers(
+void CommandQueueImpl::submit(
     GfxCount count,
     ICommandBuffer* const* commandBuffers,
     IFence* fence,

diff --git a/src/d3d12/d3d12-command-queue.h b/src/d3d12/d3d12-command-queue.h
@@ -21,8 +21,7 @@ class CommandQueueImpl : public CommandQueue<DeviceImpl>
     Result init(uint32_t queueIndex);
 
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override;
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override;
 
     virtual SLANG_NO_THROW void SLANG_MCALL waitOnHost() override;
 

diff --git a/src/debug-layer/debug-command-queue.cpp b/src/debug-layer/debug-command-queue.cpp
@@ -14,7 +14,7 @@ QueueType DebugCommandQueue::getType()
     return baseObject->getType();
 }
 
-void DebugCommandQueue::executeCommandBuffers(
+void DebugCommandQueue::submit(
     GfxCount count,
     ICommandBuffer* const* commandBuffers,
     IFence* fence,
@@ -42,13 +42,13 @@ void DebugCommandQueue::executeCommandBuffers(
             if (cmdBufferImpl->m_transientHeap != getDebugObj(commandBuffers[0])->m_transientHeap)
             {
                 RHI_VALIDATION_ERROR(
-                    "Command buffers passed to a single executeCommandBuffers "
+                    "Command buffers passed to a single submit "
                     "call must be allocated from the same transient heap."
                 );
             }
         }
     }
-    baseObject->executeCommandBuffers(count, innerCommandBuffers.data(), getInnerObj(fence), valueToSignal);
+    baseObject->submit(count, innerCommandBuffers.data(), getInnerObj(fence), valueToSignal);
     if (fence)
     {
         getDebugObj(fence)->maxValueToSignal = max(getDebugObj(fence)->maxValueToSignal, valueToSignal);

diff --git a/src/debug-layer/debug-command-queue.h b/src/debug-layer/debug-command-queue.h
@@ -15,8 +15,7 @@ class DebugCommandQueue : public DebugObject<ICommandQueue>
     ICommandQueue* getInterface(const Guid& guid);
     virtual SLANG_NO_THROW QueueType SLANG_MCALL getType() override;
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override;
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override;
     virtual SLANG_NO_THROW void SLANG_MCALL waitOnHost() override;
     virtual SLANG_NO_THROW Result SLANG_MCALL
     waitForFenceValuesOnDevice(GfxCount fenceCount, IFence** fences, uint64_t* waitValues) override;

diff --git a/src/immediate-device.cpp b/src/immediate-device.cpp
@@ -611,8 +611,7 @@ class CommandQueueImpl : public ImmediateCommandQueueBase
     ~CommandQueueImpl() {}
 
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override
     {
         // TODO: implement fence signal.
         SLANG_RHI_ASSERT(fence == nullptr);

diff --git a/src/metal/metal-command-queue.cpp b/src/metal/metal-command-queue.cpp
@@ -84,7 +84,7 @@ void CommandQueueImpl::queueSubmitImpl(
     }
 }
 
-void CommandQueueImpl::executeCommandBuffers(
+void CommandQueueImpl::submit(
     GfxCount count,
     ICommandBuffer* const* commandBuffers,
     IFence* fence,

diff --git a/src/metal/metal-command-queue.h b/src/metal/metal-command-queue.h
@@ -32,8 +32,7 @@ class CommandQueueImpl : public CommandQueue<DeviceImpl>
     void queueSubmitImpl(uint32_t count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal);
 
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override;
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override;
 };
 
 } // namespace rhi::metal
diff --git a/src/vulkan/vk-command-queue.cpp b/src/vulkan/vk-command-queue.cpp
@@ -130,7 +130,7 @@ void CommandQueueImpl::queueSubmitImpl(
     m_pendingWaitSemaphores[1] = VK_NULL_HANDLE;
 }
 
-void CommandQueueImpl::executeCommandBuffers(
+void CommandQueueImpl::submit(
     GfxCount count,
     ICommandBuffer* const* commandBuffers,
     IFence* fence,

diff --git a/src/vulkan/vk-command-queue.h b/src/vulkan/vk-command-queue.h
@@ -37,8 +37,7 @@ class CommandQueueImpl : public CommandQueue<DeviceImpl>
     void queueSubmitImpl(uint32_t count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal);
 
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override;
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override;
 };
 
 } // namespace rhi::vk
diff --git a/src/wgpu/wgpu-command-queue.cpp b/src/wgpu/wgpu-command-queue.cpp
@@ -55,7 +55,7 @@ Result CommandQueueImpl::waitForFenceValuesOnDevice(GfxCount fenceCount, IFence*
     return SLANG_OK;
 }
 
-void CommandQueueImpl::executeCommandBuffers(
+void CommandQueueImpl::submit(
     GfxCount count,
     ICommandBuffer* const* commandBuffers,
     IFence* fence,

diff --git a/src/wgpu/wgpu-command-queue.h b/src/wgpu/wgpu-command-queue.h
@@ -18,8 +18,7 @@ class CommandQueueImpl : public CommandQueue<DeviceImpl>
     virtual SLANG_NO_THROW Result SLANG_MCALL
     waitForFenceValuesOnDevice(GfxCount fenceCount, IFence** fences, uint64_t* waitValues) override;
     virtual SLANG_NO_THROW void SLANG_MCALL
-    executeCommandBuffers(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal)
-        override;
+    submit(GfxCount count, ICommandBuffer* const* commandBuffers, IFence* fence, uint64_t valueToSignal) override;
 };
 
 } // namespace rhi::wgpu