Chronos::Engine::ColorBuffer Class Reference

This is a buffer for storing and updating the color of the shape. More...

#include <buffers.hpp>

Inheritance diagram for Chronos::Engine::ColorBuffer:

Collaboration diagram for Chronos::Engine::ColorBuffer:

Public Member Functions
void	create (Chronos::Engine::Device device)
	Creates the buffer and maps the memory.
void	update (glm::vec3 color)
	Updates the buffer with the new color.
Public Member Functions inherited from Chronos::Engine::Buffer
void	create (Chronos::Engine::Device device, VkBufferUsageFlags flags, VkMemoryPropertyFlags properties)
	This is used to initialize the buffer.
void	copy (void *data, VkCommandPool commandPool)
	Copies the data to the buffer.
void	destroy ()
	Destroys the buffer and frees the memory.

Private Attributes
void *	data

Additional Inherited Members
Public Attributes inherited from Chronos::Engine::Buffer
VkBuffer	buffer
	The buffer.
VkDeviceSize	size
	The size of the buffer.
VkDeviceMemory	memory
	The device memory of the buffer.

Detailed Description

This is a buffer for storing and updating the color of the shape.

It is used to store the color of the shape and update it on the fly.

Definition at line 149 of file buffers.hpp.

Member Function Documentation

create()

void Chronos::Engine::ColorBuffer::create

(

Chronos::Engine::Device

device

)

Creates the buffer and maps the memory.

It uses the inherited function create to create the buffer

Parameters

device

The device on which the buffer should be stored.

Definition at line 105 of file buffers.cpp.

{
    size = sizeof(UniformColorBufferObject);
    Buffer::create(device, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT,
    VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT
        | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT); // want to be visible to
                             // host and device
    vkMapMemory(device.device, memory, 0, size, 0, &data);
    LOG(3,
    "Color buffer object created for buffer ["
        + std::to_string((uint64_t)buffer) + "]")
}

References Chronos::Engine::Buffer::create(), Chronos::Engine::Device::device, and LOG.

Here is the call graph for this function:

update()

void Chronos::Engine::ColorBuffer::update

(

glm::vec3

color

)

Updates the buffer with the new color.

Parameters

color

The new color of the shape.

Definition at line 118 of file buffers.cpp.

{
    // copy the color to the buffer
    UniformColorBufferObject ubo {};
    ubo.color = color;
    memcpy(data, &ubo, sizeof(ubo));
    LOG(4,
    "Color buffer object updated for buffer ["
        + std::to_string((uint64_t)buffer) + "]")
}

References Chronos::Engine::UniformColorBufferObject::color, and LOG.

Member Data Documentation

data

void* Chronos::Engine::ColorBuffer::data

private

Definition at line 169 of file buffers.hpp.

---

The documentation for this class was generated from the following files:

• Source/Rendering/buffers.hpp
• Source/Rendering/buffers.cpp