2016-05-24 23:44:15 +02:00
/*
* Vulkan Example - Example for VK_EXT_debug_marker extension . To be used in conjuction with a debugging app like RenderDoc ( https : //renderdoc.org)
*
* Copyright ( C ) 2016 by Sascha Willems - www . saschawillems . de
*
* This code is licensed under the MIT license ( MIT ) ( http : //opensource.org/licenses/MIT)
*/
# include <stdio.h>
# include <stdlib.h>
# include <string.h>
# include <assert.h>
# include <vector>
# define GLM_FORCE_RADIANS
# define GLM_FORCE_DEPTH_ZERO_TO_ONE
# include <glm/glm.hpp>
# include <glm/gtc/matrix_transform.hpp>
# include <vulkan/vulkan.h>
# include "vulkanexamplebase.h"
# define VERTEX_BUFFER_BIND_ID 0
# define ENABLE_VALIDATION false
// Setup and functions for the VK_EXT_debug_marker_extension
// Extension spec can be found at https://github.com/KhronosGroup/Vulkan-Docs/blob/1.0-VK_EXT_debug_marker/doc/specs/vulkan/appendices/VK_EXT_debug_marker.txt
2016-05-25 22:54:25 +02:00
// Note that the extension will only be present if run from an offline debugging application
2016-05-24 23:44:15 +02:00
namespace DebugReportExt
{
bool active = false ;
PFN_vkDebugMarkerSetObjectNameEXT pfnDebugMarkerSetObjectName = VK_NULL_HANDLE ;
PFN_vkCmdDebugMarkerBeginEXT pfnCmdDebugMarkerBegin = VK_NULL_HANDLE ;
PFN_vkCmdDebugMarkerEndEXT pfnCmdDebugMarkerEnd = VK_NULL_HANDLE ;
PFN_vkCmdDebugMarkerInsertEXT pfnCmdDebugMarkerInsert = VK_NULL_HANDLE ;
// Get fcuntion pointers for the debug report extensions from the device (avoids instance dispatch)
void setupDebugMarkers ( VkDevice device )
{
// Debug marker extension will be enabled by the base class on the device if
// VK_EXT_debug_marker is present (see vulkanexamplebae.cpp)
// If the extension is present, the "enableDebugMarkers" property will be set
// todo : not public yet!
// todo : assert(enableDebugMarkers)
pfnDebugMarkerSetObjectName = ( PFN_vkDebugMarkerSetObjectNameEXT ) vkGetDeviceProcAddr ( device , " vkDebugMarkerSetObjectNameEXT " ) ;
pfnCmdDebugMarkerBegin = ( PFN_vkCmdDebugMarkerBeginEXT ) vkGetDeviceProcAddr ( device , " vkCmdDebugMarkerBeginEXT " ) ;
pfnCmdDebugMarkerEnd = ( PFN_vkCmdDebugMarkerEndEXT ) vkGetDeviceProcAddr ( device , " vkCmdDebugMarkerEndEXT " ) ;
pfnCmdDebugMarkerInsert = ( PFN_vkCmdDebugMarkerInsertEXT ) vkGetDeviceProcAddr ( device , " vkCmdDebugMarkerInsertEXT " ) ;
// Set flag if at least one function pointer is present
active = pfnDebugMarkerSetObjectName ;
}
// Sets the debug name of an object
// All Objects in Vulkan are represented by their 64-bit handles which are passed into this function
// along with the object type
void setObjectName ( VkDevice device , uint64_t object , VkDebugReportObjectTypeEXT objectType , const char * name )
{
// Check for valid function (may not be present if not runnin in a debugging application)
if ( pfnDebugMarkerSetObjectName )
{
VkDebugMarkerObjectNameInfoEXT nameInfo = { } ;
nameInfo . sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_OBJECT_NAME_INFO_EXT ;
nameInfo . objectType = objectType ;
nameInfo . object = object ;
nameInfo . pObjectName = name ;
pfnDebugMarkerSetObjectName ( device , & nameInfo ) ;
}
}
// Start a new debug marker region
void beginDebugMarkerRegion ( VkCommandBuffer cmdbuffer , const char * pMarkerName , glm : : vec4 color )
{
// Check for valid function (may not be present if not runnin in a debugging application)
if ( pfnCmdDebugMarkerBegin )
{
VkDebugMarkerMarkerInfoEXT markerInfo = { } ;
markerInfo . sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT ;
memcpy ( markerInfo . color , & color [ 0 ] , sizeof ( float ) * 4 ) ;
markerInfo . pMarkerName = pMarkerName ;
pfnCmdDebugMarkerBegin ( cmdbuffer , & markerInfo ) ;
}
}
// Insert a new debug marker into the command buffer
2016-05-25 22:54:25 +02:00
void insertDebugMarker ( VkCommandBuffer cmdbuffer , std : : string markerName , glm : : vec4 color )
2016-05-24 23:44:15 +02:00
{
// Check for valid function (may not be present if not runnin in a debugging application)
if ( pfnCmdDebugMarkerInsert )
{
VkDebugMarkerMarkerInfoEXT markerInfo = { } ;
markerInfo . sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT ;
memcpy ( markerInfo . color , & color [ 0 ] , sizeof ( float ) * 4 ) ;
2016-05-25 22:54:25 +02:00
markerInfo . pMarkerName = markerName . c_str ( ) ;
2016-05-24 23:44:15 +02:00
pfnCmdDebugMarkerInsert ( cmdbuffer , & markerInfo ) ;
}
}
// End the current debug marker region
void endDebugMarkerRegion ( VkCommandBuffer cmdBuffer )
{
// Check for valid function (may not be present if not runnin in a debugging application)
if ( pfnCmdDebugMarkerEnd )
{
pfnCmdDebugMarkerEnd ( cmdBuffer ) ;
}
}
} ;
2016-05-25 22:54:25 +02:00
// Vertex layout used in this example
struct Vertex {
glm : : vec3 pos ;
glm : : vec3 normal ;
glm : : vec2 uv ;
glm : : vec3 color ;
} ;
2016-05-26 11:31:52 +02:00
struct Scene {
struct {
VkBuffer buf ;
VkDeviceMemory mem ;
} vertices ;
struct {
VkBuffer buf ;
VkDeviceMemory mem ;
} indices ;
// Store mesh offsets for vertex and indexbuffers
struct Mesh
{
uint32_t indexStart ;
uint32_t indexCount ;
std : : string name ;
} ;
std : : vector < Mesh > meshes ;
void draw ( VkCommandBuffer cmdBuffer )
{
VkDeviceSize offsets [ 1 ] = { 0 } ;
vkCmdBindVertexBuffers ( cmdBuffer , VERTEX_BUFFER_BIND_ID , 1 , & vertices . buf , offsets ) ;
vkCmdBindIndexBuffer ( cmdBuffer , indices . buf , 0 , VK_INDEX_TYPE_UINT32 ) ;
for ( auto mesh : meshes )
{
// Add debug marker for mesh name
DebugReportExt : : insertDebugMarker ( cmdBuffer , " Draw \" " + mesh . name + " \" " , glm : : vec4 ( 0.0f ) ) ;
vkCmdDrawIndexed ( cmdBuffer , mesh . indexCount , 1 , mesh . indexStart , 0 , 0 ) ;
}
}
} ;
2016-05-24 23:44:15 +02:00
class VulkanExample : public VulkanExampleBase
{
public :
2016-05-25 22:54:25 +02:00
bool wireframe = false ;
2016-05-24 23:44:15 +02:00
struct {
vkTools : : VulkanTexture colorMap ;
} textures ;
struct {
VkPipelineVertexInputStateCreateInfo inputState ;
std : : vector < VkVertexInputBindingDescription > bindingDescriptions ;
std : : vector < VkVertexInputAttributeDescription > attributeDescriptions ;
} vertices ;
2016-05-26 11:31:52 +02:00
Scene scene , sceneGlow ;
2016-05-24 23:44:15 +02:00
struct {
vkTools : : UniformData vsScene ;
} uniformData ;
struct {
glm : : mat4 projection ;
glm : : mat4 model ;
glm : : vec4 lightPos = glm : : vec4 ( 0.0f , 5.0f , 15.0f , 1.0f ) ;
} uboVS ;
struct {
VkPipeline solid ;
VkPipeline wireframe ;
} pipelines ;
VkPipelineLayout pipelineLayout ;
VkDescriptorSet descriptorSet ;
VkDescriptorSetLayout descriptorSetLayout ;
VulkanExample ( ) : VulkanExampleBase ( ENABLE_VALIDATION )
{
zoom = - 8.5f ;
zoomSpeed = 2.5f ;
rotationSpeed = 0.5f ;
rotation = { - 4.35f , 16.25f , 0.0f } ;
cameraPos = { 0.1f , 1.1f , 0.0f } ;
enableTextOverlay = true ;
title = " Vulkan Example - VK_EXT_debug_marker " ;
}
~ VulkanExample ( )
{
// Clean up used Vulkan resources
// Note : Inherited destructor cleans up resources stored in base class
vkDestroyPipeline ( device , pipelines . solid , nullptr ) ;
vkDestroyPipelineLayout ( device , pipelineLayout , nullptr ) ;
vkDestroyDescriptorSetLayout ( device , descriptorSetLayout , nullptr ) ;
// Destroy and free mesh resources
2016-05-25 22:54:25 +02:00
vkDestroyBuffer ( device , scene . vertices . buf , nullptr ) ;
vkFreeMemory ( device , scene . vertices . mem , nullptr ) ;
vkDestroyBuffer ( device , scene . indices . buf , nullptr ) ;
vkFreeMemory ( device , scene . indices . mem , nullptr ) ;
2016-05-24 23:44:15 +02:00
textureLoader - > destroyTexture ( textures . colorMap ) ;
vkTools : : destroyUniformData ( device , & uniformData . vsScene ) ;
}
2016-05-26 11:31:52 +02:00
// Load a model file as separate meshes into a scene
void loadModel ( std : : string filename , Scene * scene )
2016-05-24 23:44:15 +02:00
{
VulkanMeshLoader * meshLoader = new VulkanMeshLoader ( ) ;
# if defined(__ANDROID__)
meshLoader - > assetManager = androidApp - > activity - > assetManager ;
# endif
2016-05-25 22:54:25 +02:00
meshLoader - > LoadMesh ( filename ) ;
2016-05-26 11:31:52 +02:00
scene - > meshes . resize ( meshLoader - > m_Entries . size ( ) ) ;
2016-05-24 23:44:15 +02:00
// Generate vertex buffer
float scale = 1.0f ;
std : : vector < Vertex > vertexBuffer ;
// Iterate through all meshes in the file
// and extract the vertex information used in this demo
for ( uint32_t m = 0 ; m < meshLoader - > m_Entries . size ( ) ; m + + )
{
for ( uint32_t i = 0 ; i < meshLoader - > m_Entries [ m ] . Vertices . size ( ) ; i + + )
{
Vertex vertex ;
vertex . pos = meshLoader - > m_Entries [ m ] . Vertices [ i ] . m_pos * scale ;
vertex . normal = meshLoader - > m_Entries [ m ] . Vertices [ i ] . m_normal ;
vertex . uv = meshLoader - > m_Entries [ m ] . Vertices [ i ] . m_tex ;
vertex . color = meshLoader - > m_Entries [ m ] . Vertices [ i ] . m_color ;
vertexBuffer . push_back ( vertex ) ;
}
}
uint32_t vertexBufferSize = vertexBuffer . size ( ) * sizeof ( Vertex ) ;
// Generate index buffer from loaded mesh file
std : : vector < uint32_t > indexBuffer ;
for ( uint32_t m = 0 ; m < meshLoader - > m_Entries . size ( ) ; m + + )
{
uint32_t indexBase = indexBuffer . size ( ) ;
for ( uint32_t i = 0 ; i < meshLoader - > m_Entries [ m ] . Indices . size ( ) ; i + + )
{
indexBuffer . push_back ( meshLoader - > m_Entries [ m ] . Indices [ i ] + indexBase ) ;
}
2016-05-26 11:31:52 +02:00
scene - > meshes [ m ] . indexStart = indexBase ;
scene - > meshes [ m ] . indexCount = meshLoader - > m_Entries [ m ] . Indices . size ( ) ;
2016-05-24 23:44:15 +02:00
}
uint32_t indexBufferSize = indexBuffer . size ( ) * sizeof ( uint32_t ) ;
// Static mesh should always be device local
bool useStaging = true ;
if ( useStaging )
{
struct {
VkBuffer buffer ;
VkDeviceMemory memory ;
} vertexStaging , indexStaging ;
// Create staging buffers
// Vertex data
createBuffer (
VK_BUFFER_USAGE_TRANSFER_SRC_BIT ,
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT ,
vertexBufferSize ,
vertexBuffer . data ( ) ,
& vertexStaging . buffer ,
& vertexStaging . memory ) ;
// Index data
createBuffer (
VK_BUFFER_USAGE_TRANSFER_SRC_BIT ,
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT ,
indexBufferSize ,
indexBuffer . data ( ) ,
& indexStaging . buffer ,
& indexStaging . memory ) ;
// Create device local buffers
// Vertex buffer
createBuffer (
VK_BUFFER_USAGE_VERTEX_BUFFER_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT ,
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT ,
vertexBufferSize ,
nullptr ,
2016-05-26 11:31:52 +02:00
& scene - > vertices . buf ,
& scene - > vertices . mem ) ;
2016-05-24 23:44:15 +02:00
// Index buffer
createBuffer (
VK_BUFFER_USAGE_INDEX_BUFFER_BIT | VK_BUFFER_USAGE_TRANSFER_DST_BIT ,
VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT ,
indexBufferSize ,
nullptr ,
2016-05-26 11:31:52 +02:00
& scene - > indices . buf ,
& scene - > indices . mem ) ;
2016-05-24 23:44:15 +02:00
// Copy from staging buffers
VkCommandBuffer copyCmd = VulkanExampleBase : : createCommandBuffer ( VK_COMMAND_BUFFER_LEVEL_PRIMARY , true ) ;
VkBufferCopy copyRegion = { } ;
copyRegion . size = vertexBufferSize ;
vkCmdCopyBuffer (
copyCmd ,
vertexStaging . buffer ,
2016-05-26 11:31:52 +02:00
scene - > vertices . buf ,
2016-05-24 23:44:15 +02:00
1 ,
& copyRegion ) ;
copyRegion . size = indexBufferSize ;
vkCmdCopyBuffer (
copyCmd ,
indexStaging . buffer ,
2016-05-26 11:31:52 +02:00
scene - > indices . buf ,
2016-05-24 23:44:15 +02:00
1 ,
& copyRegion ) ;
VulkanExampleBase : : flushCommandBuffer ( copyCmd , queue , true ) ;
vkDestroyBuffer ( device , vertexStaging . buffer , nullptr ) ;
vkFreeMemory ( device , vertexStaging . memory , nullptr ) ;
vkDestroyBuffer ( device , indexStaging . buffer , nullptr ) ;
vkFreeMemory ( device , indexStaging . memory , nullptr ) ;
}
else
{
// Vertex buffer
createBuffer (
VK_BUFFER_USAGE_VERTEX_BUFFER_BIT ,
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT ,
vertexBufferSize ,
vertexBuffer . data ( ) ,
2016-05-26 11:31:52 +02:00
& scene - > vertices . buf ,
& scene - > vertices . mem ) ;
2016-05-24 23:44:15 +02:00
// Index buffer
createBuffer (
VK_BUFFER_USAGE_INDEX_BUFFER_BIT ,
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT ,
indexBufferSize ,
indexBuffer . data ( ) ,
2016-05-26 11:31:52 +02:00
& scene - > indices . buf ,
& scene - > indices . mem ) ;
2016-05-24 23:44:15 +02:00
}
delete ( meshLoader ) ;
2016-05-26 11:31:52 +02:00
}
void loadScene ( )
{
loadModel ( getAssetPath ( ) + " models/treasure.dae " , & scene ) ;
loadModel ( getAssetPath ( ) + " models/treasure_glow.dae " , & sceneGlow ) ;
2016-05-25 22:54:25 +02:00
// Name the meshes
// ASSIMP does not load mesh names from the COLLADA file used in this example
// so we need to set them manually
// These names are used in command buffer creation for setting debug markers
2016-05-26 11:31:52 +02:00
// Scene
2016-05-25 22:54:25 +02:00
std : : vector < std : : string > names = { " hill " , " rocks " , " cave " , " tree " , " mushroom stems " , " blue mushroom caps " , " red mushroom caps " , " grass blades " , " chest box " , " chest fittings " } ;
for ( size_t i = 0 ; i < names . size ( ) ; i + + )
{
scene . meshes [ i ] . name = names [ i ] ;
}
2016-05-26 11:31:52 +02:00
// Glow
std : : vector < std : : string > namesGlow = { " emeralds " , " mushroom stems " , " blue mushroom caps " , " chest fittings " } ;
for ( size_t i = 0 ; i < namesGlow . size ( ) ; i + + )
{
sceneGlow . meshes [ i ] . name = namesGlow [ i ] ;
}
2016-05-25 22:54:25 +02:00
// Name the buffers for debugging
2016-05-26 11:31:52 +02:00
// Scene
2016-05-25 22:54:25 +02:00
DebugReportExt : : setObjectName ( device , ( uint64_t ) scene . vertices . buf , VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT , " Scene vertex buffer " ) ;
DebugReportExt : : setObjectName ( device , ( uint64_t ) scene . indices . buf , VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT , " Scene index buffer " ) ;
2016-05-26 11:31:52 +02:00
// Glow
DebugReportExt : : setObjectName ( device , ( uint64_t ) sceneGlow . vertices . buf , VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT , " Glow vertex buffer " ) ;
DebugReportExt : : setObjectName ( device , ( uint64_t ) sceneGlow . indices . buf , VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT , " Glow index buffer " ) ;
2016-05-24 23:44:15 +02:00
}
void loadTextures ( )
{
textureLoader - > loadTexture (
getAssetPath ( ) + " models/voyager/voyager.ktx " ,
VK_FORMAT_BC3_UNORM_BLOCK ,
& textures . colorMap ) ;
}
2016-05-25 22:54:25 +02:00
void reBuildCommandBuffers ( )
{
if ( ! checkCommandBuffers ( ) )
{
destroyCommandBuffers ( ) ;
createCommandBuffers ( ) ;
}
buildCommandBuffers ( ) ;
}
void buildCommandBuffers ( )
{
VkCommandBufferBeginInfo cmdBufInfo = vkTools : : initializers : : commandBufferBeginInfo ( ) ;
VkClearValue clearValues [ 2 ] ;
clearValues [ 0 ] . color = defaultClearColor ;
clearValues [ 1 ] . depthStencil = { 1.0f , 0 } ;
VkRenderPassBeginInfo renderPassBeginInfo = vkTools : : initializers : : renderPassBeginInfo ( ) ;
renderPassBeginInfo . renderPass = renderPass ;
renderPassBeginInfo . renderArea . offset . x = 0 ;
renderPassBeginInfo . renderArea . offset . y = 0 ;
renderPassBeginInfo . renderArea . extent . width = width ;
renderPassBeginInfo . renderArea . extent . height = height ;
renderPassBeginInfo . clearValueCount = 2 ;
renderPassBeginInfo . pClearValues = clearValues ;
for ( int32_t i = 0 ; i < drawCmdBuffers . size ( ) ; + + i )
{
// Set target frame buffer
renderPassBeginInfo . framebuffer = frameBuffers [ i ] ;
VK_CHECK_RESULT ( vkBeginCommandBuffer ( drawCmdBuffers [ i ] , & cmdBufInfo ) ) ;
// Start a new debug marker region
DebugReportExt : : beginDebugMarkerRegion ( drawCmdBuffers [ i ] , " Render scene " , glm : : vec4 ( 1.0f , 0.0f , 0.0f , 0.0f ) ) ;
vkCmdBeginRenderPass ( drawCmdBuffers [ i ] , & renderPassBeginInfo , VK_SUBPASS_CONTENTS_INLINE ) ;
VkViewport viewport = vkTools : : initializers : : viewport ( ( float ) width , ( float ) height , 0.0f , 1.0f ) ;
vkCmdSetViewport ( drawCmdBuffers [ i ] , 0 , 1 , & viewport ) ;
VkRect2D scissor = vkTools : : initializers : : rect2D ( wireframe ? width / 2 : width , height , 0 , 0 ) ;
vkCmdSetScissor ( drawCmdBuffers [ i ] , 0 , 1 , & scissor ) ;
vkCmdBindDescriptorSets ( drawCmdBuffers [ i ] , VK_PIPELINE_BIND_POINT_GRAPHICS , pipelineLayout , 0 , 1 , & descriptorSet , 0 , NULL ) ;
// Solid rendering
// Start a new debug marker region
DebugReportExt : : beginDebugMarkerRegion ( drawCmdBuffers [ i ] , " Solid draw " , glm : : vec4 ( 1.0f , 0.0f , 0.0f , 0.0f ) ) ;
vkCmdBindPipeline ( drawCmdBuffers [ i ] , VK_PIPELINE_BIND_POINT_GRAPHICS , pipelines . solid ) ;
2016-05-26 11:31:52 +02:00
scene . draw ( drawCmdBuffers [ i ] ) ;
2016-05-25 22:54:25 +02:00
DebugReportExt : : endDebugMarkerRegion ( drawCmdBuffers [ i ] ) ;
// Wireframe rendering
if ( wireframe )
{
// Insert debug marker
DebugReportExt : : beginDebugMarkerRegion ( drawCmdBuffers [ i ] , " Wireframe draw " , glm : : vec4 ( 1.0f , 0.0f , 0.0f , 0.0f ) ) ;
scissor . offset . x = width / 2 ;
vkCmdSetScissor ( drawCmdBuffers [ i ] , 0 , 1 , & scissor ) ;
vkCmdBindPipeline ( drawCmdBuffers [ i ] , VK_PIPELINE_BIND_POINT_GRAPHICS , pipelines . wireframe ) ;
2016-05-26 11:31:52 +02:00
scene . draw ( drawCmdBuffers [ i ] ) ;
2016-05-25 22:54:25 +02:00
DebugReportExt : : endDebugMarkerRegion ( drawCmdBuffers [ i ] ) ;
}
vkCmdEndRenderPass ( drawCmdBuffers [ i ] ) ;
// End current debug marker region
DebugReportExt : : endDebugMarkerRegion ( drawCmdBuffers [ i ] ) ;
VK_CHECK_RESULT ( vkEndCommandBuffer ( drawCmdBuffers [ i ] ) ) ;
}
}
2016-05-24 23:44:15 +02:00
void setupVertexDescriptions ( )
{
// Binding description
vertices . bindingDescriptions . resize ( 1 ) ;
vertices . bindingDescriptions [ 0 ] =
vkTools : : initializers : : vertexInputBindingDescription (
VERTEX_BUFFER_BIND_ID ,
sizeof ( Vertex ) ,
VK_VERTEX_INPUT_RATE_VERTEX ) ;
// Attribute descriptions
// Describes memory layout and shader positions
vertices . attributeDescriptions . resize ( 4 ) ;
// Location 0 : Position
vertices . attributeDescriptions [ 0 ] =
vkTools : : initializers : : vertexInputAttributeDescription (
VERTEX_BUFFER_BIND_ID ,
0 ,
VK_FORMAT_R32G32B32_SFLOAT ,
0 ) ;
// Location 1 : Normal
vertices . attributeDescriptions [ 1 ] =
vkTools : : initializers : : vertexInputAttributeDescription (
VERTEX_BUFFER_BIND_ID ,
1 ,
VK_FORMAT_R32G32B32_SFLOAT ,
sizeof ( float ) * 3 ) ;
// Location 2 : Texture coordinates
vertices . attributeDescriptions [ 2 ] =
vkTools : : initializers : : vertexInputAttributeDescription (
VERTEX_BUFFER_BIND_ID ,
2 ,
VK_FORMAT_R32G32_SFLOAT ,
sizeof ( float ) * 6 ) ;
// Location 3 : Color
vertices . attributeDescriptions [ 3 ] =
vkTools : : initializers : : vertexInputAttributeDescription (
VERTEX_BUFFER_BIND_ID ,
3 ,
VK_FORMAT_R32G32B32_SFLOAT ,
sizeof ( float ) * 8 ) ;
vertices . inputState = vkTools : : initializers : : pipelineVertexInputStateCreateInfo ( ) ;
vertices . inputState . vertexBindingDescriptionCount = vertices . bindingDescriptions . size ( ) ;
vertices . inputState . pVertexBindingDescriptions = vertices . bindingDescriptions . data ( ) ;
vertices . inputState . vertexAttributeDescriptionCount = vertices . attributeDescriptions . size ( ) ;
vertices . inputState . pVertexAttributeDescriptions = vertices . attributeDescriptions . data ( ) ;
}
void setupDescriptorPool ( )
{
// Example uses one ubo and one combined image sampler
std : : vector < VkDescriptorPoolSize > poolSizes =
{
vkTools : : initializers : : descriptorPoolSize ( VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER , 1 ) ,
vkTools : : initializers : : descriptorPoolSize ( VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER , 1 ) ,
} ;
VkDescriptorPoolCreateInfo descriptorPoolInfo =
vkTools : : initializers : : descriptorPoolCreateInfo (
poolSizes . size ( ) ,
poolSizes . data ( ) ,
1 ) ;
VK_CHECK_RESULT ( vkCreateDescriptorPool ( device , & descriptorPoolInfo , nullptr , & descriptorPool ) ) ;
}
void setupDescriptorSetLayout ( )
{
std : : vector < VkDescriptorSetLayoutBinding > setLayoutBindings =
{
// Binding 0 : Vertex shader uniform buffer
vkTools : : initializers : : descriptorSetLayoutBinding (
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER ,
VK_SHADER_STAGE_VERTEX_BIT ,
0 ) ,
// Binding 1 : Fragment shader combined sampler
vkTools : : initializers : : descriptorSetLayoutBinding (
VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ,
VK_SHADER_STAGE_FRAGMENT_BIT ,
1 ) ,
} ;
VkDescriptorSetLayoutCreateInfo descriptorLayout =
vkTools : : initializers : : descriptorSetLayoutCreateInfo (
setLayoutBindings . data ( ) ,
setLayoutBindings . size ( ) ) ;
VK_CHECK_RESULT ( vkCreateDescriptorSetLayout ( device , & descriptorLayout , nullptr , & descriptorSetLayout ) ) ;
VkPipelineLayoutCreateInfo pPipelineLayoutCreateInfo =
vkTools : : initializers : : pipelineLayoutCreateInfo (
& descriptorSetLayout ,
1 ) ;
VK_CHECK_RESULT ( vkCreatePipelineLayout ( device , & pPipelineLayoutCreateInfo , nullptr , & pipelineLayout ) ) ;
}
void setupDescriptorSet ( )
{
VkDescriptorSetAllocateInfo allocInfo =
vkTools : : initializers : : descriptorSetAllocateInfo (
descriptorPool ,
& descriptorSetLayout ,
1 ) ;
VK_CHECK_RESULT ( vkAllocateDescriptorSets ( device , & allocInfo , & descriptorSet ) ) ;
VkDescriptorImageInfo texDescriptor =
vkTools : : initializers : : descriptorImageInfo (
textures . colorMap . sampler ,
textures . colorMap . view ,
VK_IMAGE_LAYOUT_GENERAL ) ;
std : : vector < VkWriteDescriptorSet > writeDescriptorSets =
{
// Binding 0 : Vertex shader uniform buffer
vkTools : : initializers : : writeDescriptorSet (
descriptorSet ,
VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER ,
0 ,
& uniformData . vsScene . descriptor ) ,
// Binding 1 : Color map
vkTools : : initializers : : writeDescriptorSet (
descriptorSet ,
VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ,
1 ,
& texDescriptor )
} ;
vkUpdateDescriptorSets ( device , writeDescriptorSets . size ( ) , writeDescriptorSets . data ( ) , 0 , NULL ) ;
}
void preparePipelines ( )
{
VkPipelineInputAssemblyStateCreateInfo inputAssemblyState =
vkTools : : initializers : : pipelineInputAssemblyStateCreateInfo (
VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST ,
0 ,
VK_FALSE ) ;
VkPipelineRasterizationStateCreateInfo rasterizationState =
vkTools : : initializers : : pipelineRasterizationStateCreateInfo (
VK_POLYGON_MODE_FILL ,
VK_CULL_MODE_BACK_BIT ,
VK_FRONT_FACE_CLOCKWISE ,
0 ) ;
VkPipelineColorBlendAttachmentState blendAttachmentState =
vkTools : : initializers : : pipelineColorBlendAttachmentState (
0xf ,
VK_FALSE ) ;
VkPipelineColorBlendStateCreateInfo colorBlendState =
vkTools : : initializers : : pipelineColorBlendStateCreateInfo (
1 ,
& blendAttachmentState ) ;
VkPipelineDepthStencilStateCreateInfo depthStencilState =
vkTools : : initializers : : pipelineDepthStencilStateCreateInfo (
VK_TRUE ,
VK_TRUE ,
VK_COMPARE_OP_LESS_OR_EQUAL ) ;
VkPipelineViewportStateCreateInfo viewportState =
vkTools : : initializers : : pipelineViewportStateCreateInfo ( 1 , 1 , 0 ) ;
VkPipelineMultisampleStateCreateInfo multisampleState =
vkTools : : initializers : : pipelineMultisampleStateCreateInfo (
VK_SAMPLE_COUNT_1_BIT ,
0 ) ;
std : : vector < VkDynamicState > dynamicStateEnables = {
VK_DYNAMIC_STATE_VIEWPORT ,
VK_DYNAMIC_STATE_SCISSOR
} ;
VkPipelineDynamicStateCreateInfo dynamicState =
vkTools : : initializers : : pipelineDynamicStateCreateInfo (
dynamicStateEnables . data ( ) ,
dynamicStateEnables . size ( ) ,
0 ) ;
// Solid rendering pipeline
// Load shaders
std : : array < VkPipelineShaderStageCreateInfo , 2 > shaderStages ;
shaderStages [ 0 ] = loadShader ( getAssetPath ( ) + " shaders/debugmarker/mesh.vert.spv " , VK_SHADER_STAGE_VERTEX_BIT ) ;
shaderStages [ 1 ] = loadShader ( getAssetPath ( ) + " shaders/debugmarker/mesh.frag.spv " , VK_SHADER_STAGE_FRAGMENT_BIT ) ;
2016-05-25 22:54:25 +02:00
// Name shader moduels for debugging
DebugReportExt : : setObjectName ( device , ( uint64_t ) shaderModules [ 0 ] , VK_DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT , " Mesh rendering vertex shader " ) ;
DebugReportExt : : setObjectName ( device , ( uint64_t ) shaderModules [ 1 ] , VK_DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT , " Mesh rendering fragment shader " ) ;
2016-05-24 23:44:15 +02:00
VkGraphicsPipelineCreateInfo pipelineCreateInfo =
vkTools : : initializers : : pipelineCreateInfo (
pipelineLayout ,
renderPass ,
0 ) ;
pipelineCreateInfo . pVertexInputState = & vertices . inputState ;
pipelineCreateInfo . pInputAssemblyState = & inputAssemblyState ;
pipelineCreateInfo . pRasterizationState = & rasterizationState ;
pipelineCreateInfo . pColorBlendState = & colorBlendState ;
pipelineCreateInfo . pMultisampleState = & multisampleState ;
pipelineCreateInfo . pViewportState = & viewportState ;
pipelineCreateInfo . pDepthStencilState = & depthStencilState ;
pipelineCreateInfo . pDynamicState = & dynamicState ;
pipelineCreateInfo . stageCount = shaderStages . size ( ) ;
pipelineCreateInfo . pStages = shaderStages . data ( ) ;
VK_CHECK_RESULT ( vkCreateGraphicsPipelines ( device , pipelineCache , 1 , & pipelineCreateInfo , nullptr , & pipelines . solid ) ) ;
// Wire frame rendering pipeline
rasterizationState . polygonMode = VK_POLYGON_MODE_LINE ;
rasterizationState . lineWidth = 1.0f ;
VK_CHECK_RESULT ( vkCreateGraphicsPipelines ( device , pipelineCache , 1 , & pipelineCreateInfo , nullptr , & pipelines . wireframe ) ) ;
2016-05-25 22:54:25 +02:00
// Name pipelines for debugging
DebugReportExt : : setObjectName ( device , ( uint64_t ) pipelines . solid , VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXT , " Solid rendering pipeline " ) ;
DebugReportExt : : setObjectName ( device , ( uint64_t ) pipelines . wireframe , VK_DEBUG_REPORT_OBJECT_TYPE_PIPELINE_EXT , " Wireframe rendering pipeline " ) ;
2016-05-24 23:44:15 +02:00
}
// Prepare and initialize uniform buffer containing shader uniforms
void prepareUniformBuffers ( )
{
// Vertex shader uniform buffer block
createBuffer (
VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT ,
VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT ,
sizeof ( uboVS ) ,
& uboVS ,
& uniformData . vsScene . buffer ,
& uniformData . vsScene . memory ,
& uniformData . vsScene . descriptor ) ;
2016-05-25 22:54:25 +02:00
// Name uniform buffer for debugging
DebugReportExt : : setObjectName ( device , ( uint64_t ) uniformData . vsScene . buffer , VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT , " Scene uniform buffer block " ) ;
2016-05-24 23:44:15 +02:00
updateUniformBuffers ( ) ;
}
void updateUniformBuffers ( )
{
uboVS . projection = glm : : perspective ( glm : : radians ( 60.0f ) , ( float ) width / ( float ) height , 0.1f , 256.0f ) ;
glm : : mat4 viewMatrix = glm : : translate ( glm : : mat4 ( ) , glm : : vec3 ( 0.0f , 0.0f , zoom ) ) ;
uboVS . model = viewMatrix * glm : : translate ( glm : : mat4 ( ) , cameraPos ) ;
uboVS . model = glm : : rotate ( uboVS . model , glm : : radians ( rotation . x ) , glm : : vec3 ( 1.0f , 0.0f , 0.0f ) ) ;
uboVS . model = glm : : rotate ( uboVS . model , glm : : radians ( rotation . y ) , glm : : vec3 ( 0.0f , 1.0f , 0.0f ) ) ;
uboVS . model = glm : : rotate ( uboVS . model , glm : : radians ( rotation . z ) , glm : : vec3 ( 0.0f , 0.0f , 1.0f ) ) ;
uint8_t * pData ;
VK_CHECK_RESULT ( vkMapMemory ( device , uniformData . vsScene . memory , 0 , sizeof ( uboVS ) , 0 , ( void * * ) & pData ) ) ;
memcpy ( pData , & uboVS , sizeof ( uboVS ) ) ;
vkUnmapMemory ( device , uniformData . vsScene . memory ) ;
}
void draw ( )
{
VulkanExampleBase : : prepareFrame ( ) ;
submitInfo . commandBufferCount = 1 ;
submitInfo . pCommandBuffers = & drawCmdBuffers [ currentBuffer ] ;
VK_CHECK_RESULT ( vkQueueSubmit ( queue , 1 , & submitInfo , VK_NULL_HANDLE ) ) ;
VulkanExampleBase : : submitFrame ( ) ;
}
void prepare ( )
{
VulkanExampleBase : : prepare ( ) ;
2016-05-25 22:54:25 +02:00
DebugReportExt : : setupDebugMarkers ( device ) ;
2016-05-24 23:44:15 +02:00
loadTextures ( ) ;
2016-05-26 11:31:52 +02:00
loadScene ( ) ;
2016-05-24 23:44:15 +02:00
setupVertexDescriptions ( ) ;
prepareUniformBuffers ( ) ;
setupDescriptorSetLayout ( ) ;
preparePipelines ( ) ;
setupDescriptorPool ( ) ;
setupDescriptorSet ( ) ;
buildCommandBuffers ( ) ;
updateTextOverlay ( ) ;
prepared = true ;
}
virtual void render ( )
{
if ( ! prepared )
return ;
draw ( ) ;
}
virtual void viewChanged ( )
{
updateUniformBuffers ( ) ;
}
virtual void keyPressed ( uint32_t keyCode )
{
switch ( keyCode )
{
case 0x57 :
case GAMEPAD_BUTTON_A :
wireframe = ! wireframe ;
reBuildCommandBuffers ( ) ;
break ;
}
}
virtual void getOverlayText ( VulkanTextOverlay * textOverlay )
{
if ( DebugReportExt : : active )
{
textOverlay - > addText ( " VK_EXT_debug_marker active " , 5.0f , 85.0f , VulkanTextOverlay : : alignLeft ) ;
}
else
{
textOverlay - > addText ( " VK_EXT_debug_marker not present " , 5.0f , 85.0f , VulkanTextOverlay : : alignLeft ) ;
}
}
} ;
VulkanExample * vulkanExample ;
# if defined(_WIN32)
LRESULT CALLBACK WndProc ( HWND hWnd , UINT uMsg , WPARAM wParam , LPARAM lParam )
{
if ( vulkanExample ! = NULL )
{
vulkanExample - > handleMessages ( hWnd , uMsg , wParam , lParam ) ;
}
return ( DefWindowProc ( hWnd , uMsg , wParam , lParam ) ) ;
}
# elif defined(__linux__) && !defined(__ANDROID__)
static void handleEvent ( const xcb_generic_event_t * event )
{
if ( vulkanExample ! = NULL )
{
vulkanExample - > handleEvent ( event ) ;
}
}
# endif
// Main entry point
# if defined(_WIN32)
// Windows entry point
int APIENTRY WinMain ( HINSTANCE hInstance , HINSTANCE hPrevInstance , LPSTR pCmdLine , int nCmdShow )
# elif defined(__ANDROID__)
// Android entry point
void android_main ( android_app * state )
# elif defined(__linux__)
// Linux entry point
int main ( const int argc , const char * argv [ ] )
# endif
{
# if defined(__ANDROID__)
// Removing this may cause the compiler to omit the main entry point
// which would make the application crash at start
app_dummy ( ) ;
# endif
vulkanExample = new VulkanExample ( ) ;
# if defined(_WIN32)
vulkanExample - > setupWindow ( hInstance , WndProc ) ;
# elif defined(__ANDROID__)
// Attach vulkan example to global android application state
state - > userData = vulkanExample ;
state - > onAppCmd = VulkanExample : : handleAppCommand ;
state - > onInputEvent = VulkanExample : : handleAppInput ;
vulkanExample - > androidApp = state ;
# elif defined(__linux__)
vulkanExample - > setupWindow ( ) ;
# endif
# if !defined(__ANDROID__)
vulkanExample - > initSwapchain ( ) ;
vulkanExample - > prepare ( ) ;
# endif
vulkanExample - > renderLoop ( ) ;
delete ( vulkanExample ) ;
# if !defined(__ANDROID__)
return 0 ;
# endif
}