/**
 * @file vulkan_image.h
 * @author Travis Vroman (travis@kohiengine.com)
 * @brief The implementation of the Vulkan image, which can be thought of as a texture.
 * @version 1.0
 * @date 2022-01-11
 *
 * @copyright Kohi Game Engine is Copyright (c) Travis Vroman 2021-2022
 *
 */

#pragma once

#include "vulkan_types.h"
#include <vulkan/vulkan_core.h>

/**
 * @brief Creates a new Vulkan image.
 *
 * @param context A pointer to the Vulkan context.
 * @param type The type of texture. Provides hints to creation.
 * @param width The width of the image. For cubemaps, this is for each side of the cube.
 * @param height The height of the image. For cubemaps, this is for each side of the cube.
 * @param format The format of the image.
 * @param tiling The image tiling mode.
 * @param usage The image usage.
 * @param memory_flags Memory flags for the memory used by the image.
 * @param create_view Indicates if a view should be created with the image.
 * @param view_aspect_flags Aspect flags to be used when creating the view, if applicable.
 * @param name A name for the image.
 * @param mip_levels The number of mip map levels to use. Default is 1.
 * @param out_image A pointer to hold the newly-created image.
 */
void vulkan_image_create (
	vulkan_context *context,
	ktexture_type type,
	u32 width,
	u32 height,
	u16 layer_count,
	VkFormat format,
	VkImageTiling tiling,
	VkImageUsageFlags usage,
	VkMemoryPropertyFlags memory_flags,
	b32 create_view,
	VkImageAspectFlags view_aspect_flags,
	const char *name,
	u32 mip_levels,
	vulkan_image *out_image);

/**
 * @brief Destroys the given image.
 *
 * @param context A pointer to the Vulkan context.
 * @param image A pointer to the image to be destroyed.
 */
void vulkan_image_destroy (vulkan_context *context, vulkan_image *image);

/**
 * @brief Destroys and recrates internal image and view resources based on current create
 * infos which are cached on the provided image. If changing properties (i.e. resizing),
 * modify those create infos first.
 *
 * @param context A pointer to the Vulkan context.
 * @param image A pointer to the image to be recreated.
 */
void vulkan_image_recreate (vulkan_context *context, vulkan_image *image);

/**
 * @brief Transitions the provided image from old_layout to new_layout.
 *
 * @param context A pointer to the Vulkan context.
 * @param command_buffer A pointer to the command buffer to be used.
 * @param image A pointer to the image whose layout will be transitioned.
 * @param format The image format.
 * @param old_layout The old layout.
 * @param new_layout The new layout.
 */
void vulkan_image_transition_layout (
	vulkan_context *context,
	vulkan_command_buffer *command_buffer,
	vulkan_image *image,
	VkFormat format,
	VkImageLayout old_layout,
	VkImageLayout new_layout);

/**
 * @brief Generates mipmaps for the given image based on mip_levels set in the image.
 * mip_levels must be > 1 for this to succeed.
 *
 * @param context A pointer to the Vulkan context.
 * @param image A pointer to the image to generate mips for.
 * @param command_buffer A pointer to the command buffer to be used for this operation.
 * @returns True on success; otherwise false.
 */
b8 vulkan_image_mipmaps_generate (
	vulkan_context *context,
	vulkan_image *image,
	vulkan_command_buffer *command_buffer);

/**
 * @brief Copies data in buffer to provided image.
 * @param context The Vulkan context.
 * @param image A pointer to the image to copy the buffer's data to.
 * @param buffer The buffer whose data will be copied.
 * @param buffer_offset The offset in bytes from the beginning of the buffer.
 * @param px_x The pixel position on the x axis. Must be nonzero.
 * @param px_y The pixel position on the y axis. Must be nonzero.
 * @param layer The layer index. Pass -1 to set data on all layers. NOTE: only do this if writing the entire extent of the image!
 * @param width The width in pixels of the area to write.
 * @param height The height in pixels of the area to write.
 * @param command_buffer A pointer to the command buffer to be used for this operation.
 */
void vulkan_image_copy_from_buffer (
	vulkan_context *context,
	vulkan_image *image,
	VkBuffer buffer,
	u64 buffer_size,
	u64 buffer_offset,
	u32 px_x, u32 px_y, i32 layer,
	u32 width, u32 height,
	vulkan_command_buffer *command_buffer);

/**
 * @brief Copies data in the provided image to the given buffer.
 *
 * @param context The Vulkan context.
 * @param image The image to copy the image's data from.
 * @param buffer The buffer to copy to.
 * @param command_buffer The command buffer to be used for the copy.
 */
void vulkan_image_copy_to_buffer (
	vulkan_context *context,
	vulkan_image *image,
	VkBuffer buffer,
	vulkan_command_buffer *command_buffer);

/**
 * @brief Copies a single pixel's data from the given image to the provided buffer.
 *
 * @param context The Vulkan context.
 * @param image The image to copy the image's data from.
 * @param buffer The buffer to copy to.
 * @param x The x-coordinate start of the pixel region to copy.
 * @param y The y-coordinate start of the pixel region to copy.
 * @param width The width in pixels of the region to copy.
 * @param height The height in pixels of the region to copy.
 * @param command_buffer The command buffer to be used for the copy.
 */
void vulkan_image_copy_region_to_buffer (
	vulkan_context *context,
	vulkan_image *image,
	VkBuffer buffer,
	u32 x,
	u32 y,
	u32 width,
	u32 height,
	vulkan_command_buffer *command_buffer);