read_texture_pixels()

void MayaFlux::Buffers::DataReadProcessor::read_texture_pixels

(

)

Download the base level of a TextureBuffer or NodeTextureBuffer image.

Blocks the graphics cycle for the transfer, reusing one staging buffer.

Definition at line 223 of file DataReadProcessor.cpp.

{
    arm([](DataReadProcessor& self, const std::shared_ptr<VKBuffer>& vk, PendingRead& pending) {
        using Portal::Graphics::TextureLoom;
 
        std::shared_ptr<Core::VKImage> image;
        if (const auto texture = std::dynamic_pointer_cast<TextureBuffer>(vk)) {
            image = resolve_gpu_image(*texture);
        } else if (const auto node_texture = std::dynamic_pointer_cast<NodeTextureBuffer>(vk)) {
            image = resolve_gpu_image(*node_texture);
        }
 
        auto& loom = TextureLoom::instance();
        if (!loom.is_initialized()) {
            MF_RT_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
                "DataReadProcessor texture pixel reads require an initialized TextureLoom");
            return false;
        }
 
        const auto format = TextureLoom::readable_format(image);
        if (!format) {
            MF_RT_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
                "DataReadProcessor texture pixel reads require an initialized TextureBuffer or NodeTextureBuffer "
                "image that is a single-layer 2D image with a mapped format and transfer-source usage");
            return false;
        }
 
        const auto original_layout = image->get_current_layout();
        if (original_layout != vk::ImageLayout::eShaderReadOnlyOptimal
            && original_layout != vk::ImageLayout::eGeneral) {
            MF_RT_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
                "DataReadProcessor texture image has no readable pixel data");
            return false;
        }
 
        const size_t byte_count = TextureLoom::calculate_image_size(
            image->get_width(), image->get_height(), 1, *format);
        if (!self.m_texture_staging || self.m_texture_staging->get_size_bytes() < byte_count) {
            self.m_texture_staging = create_image_staging_buffer(byte_count);
        }
 
        vk::PipelineStageFlags restore_stage = vk::PipelineStageFlagBits::eFragmentShader;
        if (original_layout == vk::ImageLayout::eGeneral) {
            restore_stage |= vk::PipelineStageFlagBits::eComputeShader;
        }
 
        pending.image = loom.download_image(image, self.m_texture_staging, original_layout, restore_stage);
        return pending.image.has_value();
    });
}

References arm(), MayaFlux::Journal::BufferProcessing, MayaFlux::Journal::Buffers, MayaFlux::Buffers::create_image_staging_buffer(), format, MayaFlux::Buffers::DataReadProcessor::PendingRead::image, image, m_texture_staging, MF_RT_ERROR, and MayaFlux::Buffers::resolve_gpu_image().

Referenced by MayaFlux::Kriya::detail::arm_graphics_read().

Here is the call graph for this function:

Here is the caller graph for this function: