clear_gpu_buffer()

MAYAFLUX_API bool MayaFlux::Buffers::clear_gpu_buffer

(

const std::shared_ptr< VKBuffer > &

target

)

Zero a registered GPU buffer in place (auto-detects host-visible vs device-local)

Parameters

target

Buffer to clear

Returns

True if the buffer was cleared

Mapped buffers are cleared on the host. Unmapped buffers are filled on the GPU with no staging allocation, and the call blocks until the fill is done. Handles and device addresses are unchanged. Logs an error and returns false if the buffer is null or unregistered, lacks transfer destination usage, or the BufferService is unavailable. Never throws.

Definition at line 707 of file StagingUtils.cpp.

{
    if (!target || !target->is_initialized()) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
            "clear_gpu_buffer: buffer is null or not registered");
        return false;
    }
 
    if (target->is_host_visible() && target->get_mapped_ptr()) {
        std::memset(target->get_mapped_ptr(), 0, target->get_size_bytes());
        return true;
    }
 
    if (!(target->get_usage_flags() & vk::BufferUsageFlagBits::eTransferDst)) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
            "clear_gpu_buffer: unmapped buffer usage lacks transfer destination");
        return false;
    }
 
    auto* buffer_service = Registry::BackendRegistry::instance()
                               .get_service<Registry::Service::BufferService>();
 
    if (!buffer_service || !buffer_service->execute_immediate) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
            "clear_gpu_buffer: BufferService unavailable");
        return false;
    }
 
    const vk::Buffer buffer = target->get_buffer_resources().buffer;
    buffer_service->execute_immediate([buffer](void* command_buffer) {
        vk::CommandBuffer cmd(static_cast<VkCommandBuffer>(command_buffer));
        cmd.fillBuffer(buffer, 0, VK_WHOLE_SIZE, 0);
    });
 
    return true;
}

References buffer, MayaFlux::Journal::BufferProcessing, MayaFlux::Journal::Buffers, cmd, MayaFlux::Registry::BackendRegistry::get_service(), MayaFlux::Registry::BackendRegistry::instance(), and MF_ERROR.

Referenced by MayaFlux::Buffers::VKBuffer::clear().

Here is the call graph for this function:

Here is the caller graph for this function: