text.cpp

Go to the documentation of this file.

/*
Copyright (c) 2024 Rahul Satish Vadhyar
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#include "text.hpp"
#include "helper.hpp"
#include "shaders/textVert.hpp"
#include "shaders/textFrag.hpp"
 
void Chronos::Engine::Text::init(Chronos::Engine::Device* device,
    VkCommandPool commandPool, Chronos::Engine::SwapChain* swapChain,
    VkSampler textureSampler, VkRenderPass* renderPass,
    Chronos::Engine::FontTypes fontStyle)
{
 
    // set the fontstyle
    this->fontStyle = fontStyle;
 
    // initalize the font
    uint32_t fontWidth = fontStyle.fontWidth;
    uint32_t fontHeight = fontStyle.fontHeight;
    firstChar = fontStyle.firstChar;
 
    // unsigned char fontpixels[fontHeight][256];
    // this causes a memory leak... too bad, MSVC is fucked
    // MSVC can't take variable multi dimensional arrays, else the above
    // commented line would have worked.
    fontpixels = new unsigned char[fontHeight][256];
    fontStyle.getFontData(stbFontData, fontpixels, fontHeight);
 
    // create the font texture from the raw data
    /*
    freetype-devel, use this instead and refer
    https://github.com/RahulVadhyar/StreetChase/blob/main/TextClass.hpp to
    render and freetype font.
    */
    fontTexture.create(*device, commandPool, (void*)&(fontpixels)[0][0],
    static_cast<size_t>(fontWidth), static_cast<size_t>(fontHeight),
    static_cast<VkDeviceSize>(fontWidth * fontHeight), VK_FORMAT_R8_UNORM,
    "Text Texture");
 
    // create the vertex buffer
    VkDeviceSize bufferSize = maxTextLength * sizeof(glm::vec4);
    Chronos::Engine::createBuffer(*device, bufferSize,
    VK_BUFFER_USAGE_VERTEX_BUFFER_BIT,
    VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
        | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT, // want to be visible to
                            // host and device
    &vertexBuffer, &vertexBufferMemory);
 
    // create the uniform buffers for color changing
    colorBuffers.resize(MAX_FRAMES_IN_FLIGHT);
    for (size_t i = 0; i < MAX_FRAMES_IN_FLIGHT; i++) {
    colorBuffers[i].create(*device);
    }
    Chronos::Engine::Object::init(device, commandPool, swapChain,
    textureSampler, renderPass, Chronos::Engine::ObjectType::TypeText,
    textVert_spv, textVert_spv_len,
     textFrag_spv, textFrag_spv_len);
}
 
std::vector<VkDescriptorType> Chronos::Engine::Text::getDescriptorTypes()
{
    return std::vector<VkDescriptorType> {
    VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
    VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER, VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER
    };
}
 
std::vector<VkShaderStageFlagBits> Chronos::Engine::Text::getDescriptorStages()
{
    return std::vector<VkShaderStageFlagBits> { VK_SHADER_STAGE_FRAGMENT_BIT,
    VK_SHADER_STAGE_VERTEX_BIT, VK_SHADER_STAGE_FRAGMENT_BIT };
}
 
void Chronos::Engine::Text::createDescriptorSets()
{
    std::vector<VkDescriptorSetLayout> layouts(
    MAX_FRAMES_IN_FLIGHT, descriptorSetLayout);
    VkDescriptorSetAllocateInfo allocInfo {};
    allocInfo.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO;
    allocInfo.descriptorPool = descriptorPool;
    allocInfo.descriptorSetCount = static_cast<uint32_t>(MAX_FRAMES_IN_FLIGHT);
    allocInfo.pSetLayouts = layouts.data();
    descriptorSets.resize(MAX_FRAMES_IN_FLIGHT);
    if (vkAllocateDescriptorSets(
        device->device, &allocInfo, descriptorSets.data())
    != VK_SUCCESS) {
    throw std::runtime_error("failed to allocate descriptor sets!");
    }
    for (size_t i = 0; i < MAX_FRAMES_IN_FLIGHT; i++) {
 
    VkDescriptorImageInfo imageInfo {};
    imageInfo.imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
    imageInfo.imageView = fontTexture.textureImageView;
    imageInfo.sampler = textureSampler;
 
    VkDescriptorBufferInfo bufferInfo {};
    bufferInfo.buffer = uniformBuffers[i].buffer;
    bufferInfo.offset = 0;
    bufferInfo.range = sizeof(UniformBufferObject);
 
    VkDescriptorBufferInfo bufferInfo2 {};
    bufferInfo2.buffer = colorBuffers[i].buffer;
    bufferInfo2.offset = 0;
    bufferInfo2.range = sizeof(UniformColorBufferObject);
 
    std::array<VkWriteDescriptorSet, 3> descriptorWrites {};
 
    descriptorWrites[0].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
    descriptorWrites[0].dstSet = descriptorSets[i];
    descriptorWrites[0].dstBinding = 0;
    descriptorWrites[0].dstArrayElement = 0;
    descriptorWrites[0].descriptorType
        = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
    descriptorWrites[0].descriptorCount = 1;
    descriptorWrites[0].pImageInfo = &imageInfo;
 
    descriptorWrites[1].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
    descriptorWrites[1].dstSet = descriptorSets[i];
    descriptorWrites[1].dstBinding = 1;
    descriptorWrites[1].dstArrayElement = 0;
    descriptorWrites[1].descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
    descriptorWrites[1].descriptorCount = 1;
    descriptorWrites[1].pBufferInfo = &bufferInfo;
 
    descriptorWrites[2].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
    descriptorWrites[2].dstSet = descriptorSets[i];
    descriptorWrites[2].dstBinding = 2;
    descriptorWrites[2].dstArrayElement = 0;
    descriptorWrites[2].descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
    descriptorWrites[2].descriptorCount = 1;
    descriptorWrites[2].pBufferInfo = &bufferInfo2;
 
    vkUpdateDescriptorSets(device->device,
        static_cast<uint32_t>(descriptorWrites.size()),
        descriptorWrites.data(), 0, nullptr);
    }
};
 
Chronos::Engine::PipelineAttributes
Chronos::Engine::Text::getPipelineAttributes()
{
    PipelineAttributes pipelineAttributes;
    pipelineAttributes.bindingDescriptions
    = std::vector<VkVertexInputBindingDescription> { 2 };
    pipelineAttributes.bindingDescriptions[0].binding = 0;
    pipelineAttributes.bindingDescriptions[0].stride = sizeof(glm::vec4);
    pipelineAttributes.bindingDescriptions[0].inputRate
    = VK_VERTEX_INPUT_RATE_VERTEX;
 
    pipelineAttributes.bindingDescriptions[1].binding = 1;
    pipelineAttributes.bindingDescriptions[1].stride = sizeof(glm::vec4);
    pipelineAttributes.bindingDescriptions[1].inputRate
    = VK_VERTEX_INPUT_RATE_VERTEX;
 
    pipelineAttributes.attributeDescriptions
    = std::vector<VkVertexInputAttributeDescription> { 2 };
    pipelineAttributes.attributeDescriptions[0].binding = 0;
    pipelineAttributes.attributeDescriptions[0].location = 0;
    pipelineAttributes.attributeDescriptions[0].format
    = VK_FORMAT_R32G32_SFLOAT;
    pipelineAttributes.attributeDescriptions[0].offset = 0;
 
    pipelineAttributes.attributeDescriptions[1].binding = 1;
    pipelineAttributes.attributeDescriptions[1].location = 1;
    pipelineAttributes.attributeDescriptions[1].format
    = VK_FORMAT_R32G32_SFLOAT;
    pipelineAttributes.attributeDescriptions[1].offset = sizeof(glm::vec2);
 
    pipelineAttributes.topology = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP;
    pipelineAttributes.frontFace = VK_FRONT_FACE_CLOCKWISE;
 
    pipelineAttributes.colorBlendAttachment.blendEnable = VK_TRUE;
    pipelineAttributes.colorBlendAttachment.colorWriteMask
    = VK_COLOR_COMPONENT_R_BIT | VK_COLOR_COMPONENT_G_BIT
    | VK_COLOR_COMPONENT_B_BIT | VK_COLOR_COMPONENT_A_BIT;
    pipelineAttributes.colorBlendAttachment.srcColorBlendFactor
    = VK_BLEND_FACTOR_SRC_ALPHA;
    pipelineAttributes.colorBlendAttachment.dstColorBlendFactor
    = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
    pipelineAttributes.colorBlendAttachment.colorBlendOp = VK_BLEND_OP_ADD;
    pipelineAttributes.colorBlendAttachment.srcAlphaBlendFactor
    = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
    pipelineAttributes.colorBlendAttachment.dstAlphaBlendFactor
    = VK_BLEND_FACTOR_ZERO;
    pipelineAttributes.colorBlendAttachment.alphaBlendOp = VK_BLEND_OP_ADD;
 
    return pipelineAttributes;
}
 
void Chronos::Engine::Text::destroy()
{
    Chronos::Engine::Object::destroy();
    vkDestroyBuffer(device->device, vertexBuffer, nullptr);
    vkFreeMemory(device->device, vertexBufferMemory, nullptr);
    for (size_t i = 0; i < MAX_FRAMES_IN_FLIGHT; i++) {
    colorBuffers[i].destroy();
    }
    fontTexture.destroy();
    delete[] fontpixels;
}
 
void Chronos::Engine::Text::updateBuffer()
{
    // update the vertex buffer with new text on update
    if (vkMapMemory(device->device, vertexBufferMemory, 0, VK_WHOLE_SIZE, 0,
        (void**)&mappedMemory)
    != VK_SUCCESS) {
    throw std::runtime_error("failed to map memory!");
    }
 
    numLetters = 0;
 
    assert(mappedMemory != nullptr);
 
    const float charW = 1.5f * params.scale / swapChain->swapChainExtent.width;
    const float charH = 1.5f * params.scale / swapChain->swapChainExtent.height;
 
    float fbW = (float)swapChain->swapChainExtent.width;
    float fbH = (float)swapChain->swapChainExtent.height;
    float x = (0 / fbW * 2.0f);
    float y = (0 / fbH * 2.0f);
 
    // Calculate text width
    float textWidth = 0;
    for (auto letter : params.text) {
    stb_fontchar* charData = &stbFontData[(uint32_t)letter - firstChar];
    textWidth += charData->advance * charW;
    }
    // switch (alignment) {
    // case Right:
    //     x -= textWidth;
    //     break;
    // case Center:
    x -= textWidth / 2.0f;
    //     break;
    // case Left:
    //     break;
    // }
 
    // Generate a uv mapped quad per char in the new text
    for (auto letter : params.text) {
    stb_fontchar* charData = &stbFontData[(uint32_t)letter - firstChar];
 
    mappedMemory->x = (x + (float)charData->x0 * charW);
    mappedMemory->y = (y + (float)charData->y0 * charH);
    mappedMemory->z = charData->s0;
    mappedMemory->w = charData->t0;
    mappedMemory++;
 
    mappedMemory->x = (x + (float)charData->x1 * charW);
    mappedMemory->y = (y + (float)charData->y0 * charH);
    mappedMemory->z = charData->s1;
    mappedMemory->w = charData->t0;
    mappedMemory++;
 
    mappedMemory->x = (x + (float)charData->x0 * charW);
    mappedMemory->y = (y + (float)charData->y1 * charH);
    mappedMemory->z = charData->s0;
    mappedMemory->w = charData->t1;
    mappedMemory++;
 
    mappedMemory->x = (x + (float)charData->x1 * charW);
    mappedMemory->y = (y + (float)charData->y1 * charH);
    mappedMemory->z = charData->s1;
    mappedMemory->w = charData->t1;
    mappedMemory++;
 
    x += charData->advance * charW;
    numLetters++;
    }
 
    vkUnmapMemory(device->device, vertexBufferMemory);
    mappedMemory = nullptr;
}
 
void Chronos::Engine::Text::clear()
{
    if (vkMapMemory(device->device, vertexBufferMemory, 0, VK_WHOLE_SIZE, 0,
        (void**)&mappedMemory)
    != VK_SUCCESS) {
    throw std::runtime_error("failed to map memory!");
    }
    numLetters = 0;
    mappedMemory = nullptr;
 
    vkUnmapMemory(device->device, vertexBufferMemory);
    mappedMemory = nullptr;
}
 
void Chronos::Engine::Text::update(uint32_t currentFrame)
{
    updateBuffer();
    uniformBuffers[currentFrame].update(swapChain->swapChainExtent, params.x,
    params.y, params.rotation + 90, 1.0f, -1.0f);
    colorBuffers[currentFrame].update(
    { params.color[0], params.color[1], params.color[2] });
}
 
void Chronos::Engine::Text::render(uint32_t currentFrame, uint32_t imageIndex,
    float bgColor[3], VkViewport& viewport, VkRect2D& scissor,
    std::vector<VkCommandBuffer>& commandBuffers)
{
    vkCmdBindPipeline(commandBuffers[currentFrame],
    VK_PIPELINE_BIND_POINT_GRAPHICS, this->graphicsPipeline);
    vkCmdSetViewport(commandBuffers[currentFrame], 0, 1, &viewport);
    vkCmdSetScissor(commandBuffers[currentFrame], 0, 1, &scissor);
    VkBuffer vertexBuffers[] = { this->vertexBuffer };
    VkDeviceSize offsets[] = { 0 };
    vkCmdBindVertexBuffers(
    commandBuffers[currentFrame], 0, 1, vertexBuffers, offsets);
    vkCmdBindVertexBuffers(
    commandBuffers[currentFrame], 1, 1, vertexBuffers, offsets);
    vkCmdBindDescriptorSets(commandBuffers[currentFrame],
    VK_PIPELINE_BIND_POINT_GRAPHICS, this->pipelineLayout, 0, 1,
    &this->descriptorSets[currentFrame], 0, nullptr);
    for (uint32_t j = 0; j < this->numLetters; j++) {
    vkCmdDraw(commandBuffers[currentFrame], 4, 1, j * 4, 0);
    }
}