Kohi Game Engine
vulkan_image.h
Go to the documentation of this file.
1 
12 #pragma once
13 
14 #include "vulkan_types.h"
15 #include <vulkan/vulkan_core.h>
16 
34 void vulkan_image_create(
35  vulkan_context* context,
36  ktexture_type type,
37  u32 width,
38  u32 height,
39  u16 layer_count,
40  VkFormat format,
41  VkImageTiling tiling,
42  VkImageUsageFlags usage,
43  VkMemoryPropertyFlags memory_flags,
44  b32 create_view,
45  VkImageAspectFlags view_aspect_flags,
46  const char* name,
47  u32 mip_levels,
48  vulkan_image* out_image);
49 
56 void vulkan_image_destroy(vulkan_context* context, vulkan_image* image);
57 
66 void vulkan_image_recreate(vulkan_context* context, vulkan_image* image);
67 
78 void vulkan_image_transition_layout(
79  vulkan_context* context,
80  vulkan_command_buffer* command_buffer,
81  vulkan_image* image,
82  VkFormat format,
83  VkImageLayout old_layout,
84  VkImageLayout new_layout);
85 
95 b8 vulkan_image_mipmaps_generate(
96  vulkan_context* context,
97  vulkan_image* image,
98  vulkan_command_buffer* command_buffer);
99 
108 void vulkan_image_copy_from_buffer(
109  vulkan_context* context,
110  vulkan_image* image,
111  VkBuffer buffer,
112  u64 offset,
113  vulkan_command_buffer* command_buffer);
114 
123 void vulkan_image_copy_to_buffer(
124  vulkan_context* context,
125  vulkan_image* image,
126  VkBuffer buffer,
127  vulkan_command_buffer* command_buffer);
128 
141 void vulkan_image_copy_region_to_buffer(
142  vulkan_context* context,
143  vulkan_image* image,
144  VkBuffer buffer,
145  u32 x,
146  u32 y,
147  u32 width,
148  u32 height,
149  vulkan_command_buffer* command_buffer);
u32
unsigned int u32
Unsigned 32-bit integer.
Definition: defines.h:25
b8
_Bool b8
8-bit boolean type
Definition: defines.h:58
u16
unsigned short u16
Unsigned 16-bit integer.
Definition: defines.h:22
b32
int b32
32-bit boolean type, used for APIs which require it
Definition: defines.h:55
u64
unsigned long long u64
Unsigned 64-bit integer.
Definition: defines.h:28
ktexture_type
ktexture_type
Represents various types of textures.
Definition: kresource_types.h:10
vulkan_command_buffer
Represents a Vulkan-specific command buffer, which holds a list of commands and is submitted to a que...
Definition: vulkan_types.h:246
vulkan_context
The overall Vulkan context for the backend. Holds and maintains global renderer backend state,...
Definition: vulkan_types.h:681
vulkan_image
A representation of a Vulkan image. This can be thought of as a texture. Also contains the view and m...
Definition: vulkan_types.h:158
vulkan_image_transition_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)
Transitions the provided image from old_layout to new_layout.
vulkan_image_copy_from_buffer
void vulkan_image_copy_from_buffer(vulkan_context *context, vulkan_image *image, VkBuffer buffer, u64 offset, vulkan_command_buffer *command_buffer)
Copies data in buffer to provided image.
vulkan_image_copy_to_buffer
void vulkan_image_copy_to_buffer(vulkan_context *context, vulkan_image *image, VkBuffer buffer, vulkan_command_buffer *command_buffer)
Copies data in the provided image to the given buffer.
vulkan_image_destroy
void vulkan_image_destroy(vulkan_context *context, vulkan_image *image)
Destroys the given image.
vulkan_image_recreate
void vulkan_image_recreate(vulkan_context *context, vulkan_image *image)
Destroys and recrates internal image and view resources based on current create infos which are cache...
vulkan_image_mipmaps_generate
b8 vulkan_image_mipmaps_generate(vulkan_context *context, vulkan_image *image, vulkan_command_buffer *command_buffer)
Generates mipmaps for the given image based on mip_levels set in the image. mip_levels must be > 1 fo...
vulkan_image_create
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)
Creates a new Vulkan image.
vulkan_image_copy_region_to_buffer
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)
Copies a single pixel's data from the given image to the provided buffer.
vulkan_types.h
This file contains a collection fo Vulkan-specific types used for the Vulkan backend.