begin_rendering()

void MayaFlux::Portal::Graphics::RenderFlow::begin_rendering	(	CommandBufferID	cmd_id,
		const std::shared_ptr< Core::Window > &	window,
		vk::Image	swapchain_image,
		const std::array< float, 4 > &	clear_color = default_color,
		vk::ImageView	depth_image_view = nullptr
	)

Begin dynamic rendering to a window.

Parameters

cmd_id	Command buffer ID
window	Target window
swapchain_image	Swapchain image to render to
clear_color	Clear color (RGBA)
depth_image_view	Optional depth attachment view (nullptr = no depth)

Uses vkCmdBeginRendering - no render pass objects needed. When depth_image_view is provided, depth clear value is 1.0.

Definition at line 519 of file RenderFlow.cpp.

{
    auto cmd = m_shader_foundry->get_command_buffer(cmd_id);
    if (!cmd) {
        MF_RT_ERROR(Journal::Component::Portal, Journal::Context::Rendering,
            "Invalid command buffer ID: {}", cmd_id);
        return;
    }
 
    if (!window) {
        MF_RT_ERROR(Journal::Component::Portal, Journal::Context::Rendering,
            "Cannot begin rendering for null window");
        return;
    }
 
    if (!swapchain_image) {
        MF_RT_ERROR(Journal::Component::Portal, Journal::Context::Rendering,
            "Cannot begin rendering with null swapchain image");
        return;
    }
 
    auto it = m_window_associations.find(window);
    if (it == m_window_associations.end()) {
        MF_WARN(Journal::Component::Portal, Journal::Context::Rendering,
            "Window '{}' not registered for rendering. "
            "Call register_window_for_rendering() first.",
            window->get_create_info().title);
        m_window_associations.emplace(window, WindowRenderAssociation { .window = window, .swapchain_image = swapchain_image });
    } else {
        it->second.swapchain_image = swapchain_image;
    }
 
    uint32_t width = 0, height = 0;
    m_display_service->get_swapchain_extent(window, width, height);
 
    if (width == 0 || height == 0) {
        MF_RT_ERROR(Journal::Component::Portal, Journal::Context::Rendering,
            "Invalid swapchain extent for window '{}': {}x{}",
            window->get_create_info().title, width, height);
        return;
    }
 
    vk::ImageView image_view = get_current_image_view(window);
    if (!image_view) {
        MF_RT_ERROR(Journal::Component::Portal, Journal::Context::Rendering,
            "Failed to get image view for window '{}'",
            window->get_create_info().title);
        return;
    }
 
    vk::ImageMemoryBarrier pre_barrier {};
    pre_barrier.oldLayout = vk::ImageLayout::eUndefined;
    pre_barrier.newLayout = vk::ImageLayout::eColorAttachmentOptimal;
    pre_barrier.srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
    pre_barrier.dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
    pre_barrier.image = swapchain_image;
    pre_barrier.subresourceRange.aspectMask = vk::ImageAspectFlagBits::eColor;
    pre_barrier.subresourceRange.baseMipLevel = 0;
    pre_barrier.subresourceRange.levelCount = 1;
    pre_barrier.subresourceRange.baseArrayLayer = 0;
    pre_barrier.subresourceRange.layerCount = 1;
    pre_barrier.srcAccessMask = vk::AccessFlagBits::eNone;
    pre_barrier.dstAccessMask = vk::AccessFlagBits::eColorAttachmentWrite;
 
    cmd.pipelineBarrier(
        vk::PipelineStageFlagBits::eTopOfPipe,
        vk::PipelineStageFlagBits::eColorAttachmentOutput,
        vk::DependencyFlags {},
        0, nullptr,
        0, nullptr,
        1, &pre_barrier);
 
    vk::RenderingAttachmentInfo color_attachment {};
    color_attachment.sType = vk::StructureType::eRenderingAttachmentInfo;
    color_attachment.pNext = nullptr;
    color_attachment.imageView = image_view;
    color_attachment.imageLayout = vk::ImageLayout::eColorAttachmentOptimal;
    color_attachment.resolveMode = vk::ResolveModeFlagBits::eNone;
    color_attachment.resolveImageView = nullptr;
    color_attachment.resolveImageLayout = vk::ImageLayout::eUndefined;
    color_attachment.loadOp = vk::AttachmentLoadOp::eClear;
    color_attachment.storeOp = vk::AttachmentStoreOp::eStore;
 
    if (clear_color != default_color) {
        color_attachment.clearValue.color = vk::ClearColorValue(clear_color);
    } else {
        color_attachment.clearValue.color = vk::ClearColorValue(window->get_create_info().clear_color);
    }
 
    vk::RenderingAttachmentInfo depth_attachment {};
    if (depth_image_view) {
        depth_attachment.sType = vk::StructureType::eRenderingAttachmentInfo;
        depth_attachment.pNext = nullptr;
        depth_attachment.imageView = depth_image_view;
        depth_attachment.imageLayout = vk::ImageLayout::eDepthStencilAttachmentOptimal;
        depth_attachment.resolveMode = vk::ResolveModeFlagBits::eNone;
        depth_attachment.resolveImageView = nullptr;
        depth_attachment.resolveImageLayout = vk::ImageLayout::eUndefined;
        depth_attachment.loadOp = vk::AttachmentLoadOp::eClear;
        depth_attachment.storeOp = vk::AttachmentStoreOp::eDontCare;
        depth_attachment.clearValue.depthStencil = vk::ClearDepthStencilValue { 1.0F, 0 };
    }
 
    vk::RenderingInfo rendering_info {};
    rendering_info.sType = vk::StructureType::eRenderingInfo;
    rendering_info.pNext = nullptr;
    rendering_info.flags = vk::RenderingFlagBits::eContentsSecondaryCommandBuffers;
    rendering_info.renderArea.offset = vk::Offset2D { 0, 0 };
    rendering_info.renderArea.extent = vk::Extent2D { width, height };
    rendering_info.layerCount = 1;
    rendering_info.colorAttachmentCount = 1;
    rendering_info.pColorAttachments = &color_attachment;
    rendering_info.pDepthAttachment = depth_image_view ? &depth_attachment : nullptr;
    rendering_info.pStencilAttachment = nullptr;
 
    cmd.beginRendering(rendering_info);
 
    MF_TRACE(Journal::Component::Portal, Journal::Context::Rendering,
        "Began dynamic rendering for window '{}' ({}x{}, depth: {})",
        window->get_create_info().title, width, height,
        depth_image_view ? "yes" : "no");
}

References MayaFlux::Portal::Graphics::default_color, MayaFlux::Portal::Graphics::ShaderFoundry::get_command_buffer(), get_current_image_view(), MayaFlux::Registry::Service::DisplayService::get_swapchain_extent, m_display_service, m_shader_foundry, m_window_associations, MF_RT_ERROR, MF_TRACE, MF_WARN, MayaFlux::Journal::Portal, MayaFlux::Journal::Rendering, and MayaFlux::Portal::Graphics::RenderFlow::WindowRenderAssociation::window.

Here is the call graph for this function: