Function example_task_callback

tests/2_daxa_api/6_task_graph/main.cpp:11–68

DAXA_DECL_TASK_HEAD_END

void example_task_callback(daxa::TaskInterface ti)
{
    auto const & AI = ExampleTaskHead::Info::AT;

    // There are two ways to get the info for any attachment:
    {
        // daxa::TaskBufferAttachmentIndex index:
        [[maybe_unused]] daxa::TaskBufferAttachmentInfo const & buffer0_attachment0 = ti.get(AI.buffer0);
        // daxa::TaskBufferView assigned to the buffer attachment:
        [[maybe_unused]] daxa::TaskBufferAttachmentInfo const & buffer0_attachment1 = ti.get(buffer0_attachment0.view);
    }
    // The Buffer Attachment info contents:
    {
        [[maybe_unused]] daxa::BufferId id = ti.get(AI.buffer0).id;
        [[maybe_unused]] char const * name = ti.get(AI.buffer0).name;
        [[maybe_unused]] daxa::TaskAccess access = ti.get(AI.buffer0).task_access;
        [[maybe_unused]] u8 shader_array_size = ti.get(AI.buffer0).shader_array_size;
        [[maybe_unused]] bool shader_as_address = ti.get(AI.buffer0).shader_as_address;
        [[maybe_unused]] daxa::TaskBufferView view = ti.get(AI.buffer0).view;
        [[maybe_unused]] std::span<daxa::BufferId const> ids = ti.get(AI.buffer0).ids;
    }
    // The Image Attachment info contents:
    {
        [[maybe_unused]] char const * name = ti.get(AI.image0).name;
        [[maybe_unused]] daxa::TaskAccess access = ti.get(AI.image0).task_access;
        [[maybe_unused]] daxa::ImageViewType view_type = ti.get(AI.image0).view_type;
        [[maybe_unused]] u8 shader_array_size = ti.get(AI.image0).shader_array_size;
        [[maybe_unused]] bool is_mip_array = ti.get(AI.image0).is_mip_array;
        [[maybe_unused]] daxa::TaskImageView view = ti.get(AI.image0).view;
        [[maybe_unused]] daxa::ImageId id = ti.get(AI.image0).id;
        [[maybe_unused]] std::span<daxa::ImageViewId const> view_ids = ti.get(AI.image0).view_ids;
    }
    // The interface has multiple convenience functions for easier access to the underlying resources attributes:
    {
        // Overloaded for buffer, blas, tlas, image
        [[maybe_unused]] daxa::BufferInfo info = ti.info(AI.buffer0).value();
        // Overloaded for buffer, blas, tlas
        [[maybe_unused]] daxa::DeviceAddress address = ti.device_address(AI.buffer0).value();

        [[maybe_unused]] std::byte * host_address = ti.buffer_host_address(AI.buffer0).value();
        [[maybe_unused]] daxa::ImageViewInfo img_view_info = ti.image_view_info(AI.image0).value();

        // In case the task resource has an array of real resources, one can use the optional second parameter to access those:
        [[maybe_unused]] daxa::BufferInfo info2 = ti.info(AI.buffer0, 123 /*resource index*/).value();
    }
    // The attachment infos are also provided, directly via a span:
    for ([[maybe_unused]] daxa::TaskAttachmentInfo const & attach : ti.attachment_infos)
    {
    }
    // The tasks shader side struct of ids and addresses is automatically filled and serialized to a blob:
    [[maybe_unused]] auto generated_blob = ti.attachment_shader_blob;
    // The head also declared an aligned struct with the right size as a dummy on the c++ side.
    // This can be used to declare shader/c++ shared structs containing this blob :
    [[maybe_unused]] ExampleTaskHead::AttachmentShaderBlob blob = {};
    // The blob also declares a constructor and assignment operator to take in the byte span generated by the taskgraph:
    blob = generated_blob;
    [[maybe_unused]] ExampleTaskHead::AttachmentShaderBlob blob2{ti.attachment_shader_blob};
}