append()

bool MayaFlux::Kakshya::TextureCollection::append

(

const std::shared_ptr< Core::VKImage > &

image

)

Copy image into the next layer.

An image of another size is scaled to fit inside the layer, keeping its aspect ratio, centred on a zeroed background. The format is converted.

Returns

True when the image was stored. False for a null image, when the device cannot blit its format into the collection's, or when a linear collection is full.

Definition at line 49 of file TextureCollection.cpp.

{
    if (!image || !image->is_initialized()) {
        MF_ERROR(Journal::Component::Kakshya, Journal::Context::ContainerProcessing,
            "TextureCollection::append called with an uninitialised image");
        return false;
    }
 
    if (is_full()) {
        if (!m_full_reported) {
            MF_WARN(Journal::Component::Kakshya, Journal::Context::ContainerProcessing,
                "TextureCollection is full at {} layers ({} byte cap)", get_layer_count(), m_spec.max_bytes);
            m_full_reported = true;
        }
        return false;
    }
 
    const bool reuse = m_spec.ring_layers > 0 && m_write_head >= m_spec.ring_layers;
    const auto slot = reuse
        ? static_cast<uint32_t>(m_write_head % m_spec.ring_layers)
        : get_layer_count();
 
    auto target = reuse
        ? layer_image(slot)
        : TextureLoom::instance().create_2d(get_width(), get_height(), get_format());
 
    if (!target || !copy_into(image, target))
        return false;
 
    if (reuse) {
        hold_layer(slot);
    } else {
        append_image_layer(std::move(target));
    }
 
    ++m_write_head;
    return true;
}

References MayaFlux::Kakshya::TextureContainer::append_image_layer(), MayaFlux::Journal::ContainerProcessing, copy_into(), MayaFlux::Portal::Graphics::TextureLoom::create_2d(), MayaFlux::Kakshya::TextureContainer::get_format(), MayaFlux::Kakshya::TextureContainer::get_height(), MayaFlux::Kakshya::TextureContainer::get_layer_count(), MayaFlux::Kakshya::TextureContainer::get_width(), MayaFlux::Kakshya::TextureContainer::hold_layer(), image, MayaFlux::Portal::Graphics::TextureLoom::instance(), is_full(), MayaFlux::Journal::Kakshya, MayaFlux::Kakshya::TextureContainer::layer_image(), m_full_reported, m_spec, m_write_head, MayaFlux::Kakshya::TextureCollectionSpec::max_bytes, MF_ERROR, MF_WARN, and MayaFlux::Kakshya::TextureCollectionSpec::ring_layers.

Here is the call graph for this function: