download_compute_mesh()

MAYAFLUX_API std::optional< Kakshya::MeshData > MayaFlux::Buffers::download_compute_mesh

(

const std::shared_ptr< ComputeMeshBuffer > &

buffer

)

Download a ComputeMeshBuffer's current live geometry to CPU.

One-shot and blocking, via download_from_gpu_async: call it off the graphics thread. Downloads exactly ComputeMeshBuffer::get_live_vertex_count() vertices rather than the worst-case allocation.

Parameters

buffer

Source buffer. setup_processors() must have run.

Returns

The geometry as non-indexed triangles, or nullopt if the buffer is null, has no readable counter, or the live vertex count is zero.

Definition at line 460 of file StagingUtils.cpp.

{
    if (!buffer) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
            "download_compute_mesh: null buffer");
        return std::nullopt;
    }
 
    const auto vertex_count = buffer->get_live_vertex_count();
    if (!vertex_count) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
            "download_compute_mesh: no mesh processor (setup_processors() has not been called) "
            "or the counter buffer is not host-visible or not allocated yet");
        return std::nullopt;
    }
    if (*vertex_count == 0) {
        MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
            "download_compute_mesh: live vertex count is zero");
        return std::nullopt;
    }
 
    std::vector<uint8_t> bytes(static_cast<size_t>(*vertex_count) * sizeof(Kakshya::MeshVertex));
    std::shared_ptr<VKBuffer> staging;
    download_from_gpu_async(buffer, bytes.data(), bytes.size(), staging);
 
    return triangle_soup_mesh(bytes);
}

References buffer, MayaFlux::Journal::BufferProcessing, MayaFlux::Journal::Buffers, download_from_gpu_async(), MF_ERROR, and triangle_soup_mesh().

Referenced by MayaFlux::IO::download_compute_mesh().

Here is the call graph for this function:

Here is the caller graph for this function: