Update object creation code with VDeleter in chapters

Overv · Overv · commit 5032f89c90d7 · 2016-09-19T00:14:59.000+02:00
diff --git a/03_Drawing_a_triangle/00_Setup/01_Instance.md b/03_Drawing_a_triangle/00_Setup/01_Instance.md
@@ -90,7 +90,7 @@ We've now specified everything Vulkan needs to create an instance and we can
 finally issue the `vkCreateInstance` call:
 
 ```c++
-VkResult result = vkCreateInstance(&createInfo, nullptr, &instance);
+VkResult result = vkCreateInstance(&createInfo, nullptr, instance.replace());
 ```
 
 As you'll see, the general pattern that object creation function parameters in
@@ -106,7 +106,7 @@ type `VkResult` that is either `VK_SUCCESS` or an error code. To check if the
 instance was created successfully, simply add a check for the success value:
 
 ```c++
-if (vkCreateInstance(&createInfo, nullptr, &instance) != VK_SUCCESS) {
+if (vkCreateInstance(&createInfo, nullptr, instance.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create instance!");
 }
 ```
diff --git a/03_Drawing_a_triangle/00_Setup/02_Validation_layers.md b/03_Drawing_a_triangle/00_Setup/02_Validation_layers.md
@@ -315,7 +315,7 @@ couldn't be loaded. We can now call this function to create the extension
 object if it's available:
 
 ```c++
-if (CreateDebugReportCallbackEXT(instance, &createInfo, nullptr, &callback) != VK_SUCCESS) {
+if (CreateDebugReportCallbackEXT(instance, &createInfo, nullptr, callback.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to set up debug callback!");
 }
 ```
diff --git a/03_Drawing_a_triangle/00_Setup/04_Logical_device_and_queues.md b/03_Drawing_a_triangle/00_Setup/04_Logical_device_and_queues.md
@@ -122,7 +122,7 @@ That's it, we're now ready to instantiate the logical device with a call to the
 appropriately named `vkCreateDevice` function.
 
 ```c++
-if (vkCreateDevice(physicalDevice, &createInfo, nullptr, &device) != VK_SUCCESS) {
+if (vkCreateDevice(physicalDevice, &createInfo, nullptr, device.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create logical device!");
 }
 ```
diff --git a/03_Drawing_a_triangle/01_Presentation/00_Window_surface.md b/03_Drawing_a_triangle/01_Presentation/00_Window_surface.md
@@ -68,7 +68,7 @@ allocators and the variable for the surface handle to be stored in.
 auto CreateWin32SurfaceKHR = (PFN_vkCreateWin32SurfaceKHR) vkGetInstanceProcAddr(instance, "vkCreateWin32SurfaceKHR");
 
 if (!CreateWin32SurfaceKHR || CreateWin32SurfaceKHR(instance, &createInfo,
-   nullptr, &surface) != VK_SUCCESS) {
+   nullptr, surface.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create window surface!");
 }
 ```
@@ -101,7 +101,7 @@ implementation of the function very straightforward:
 
 ```c++
 void createSurface() {
-    if (glfwCreateWindowSurface(instance, window, nullptr, &surface) != VK_SUCCESS) {
+    if (glfwCreateWindowSurface(instance, window, nullptr, surface.replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create window surface!");
     }
 }
diff --git a/03_Drawing_a_triangle/01_Presentation/01_Swap_chain.md b/03_Drawing_a_triangle/01_Presentation/01_Swap_chain.md
@@ -519,7 +519,7 @@ VDeleter<VkSwapchainKHR> swapChain{device, vkDestroySwapchainKHR};
 Now creating the swap chain is as simple as calling `vkCreateSwapchainKHR`:
 
 ```c++
-if (vkCreateSwapchainKHR(device, &createInfo, nullptr, &swapChain) != VK_SUCCESS) {
+if (vkCreateSwapchainKHR(device, &createInfo, nullptr, swapChain.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create swap chain!");
 }
 ```
diff --git a/03_Drawing_a_triangle/01_Presentation/02_Image_views.md b/03_Drawing_a_triangle/01_Presentation/02_Image_views.md
@@ -105,7 +105,7 @@ different layers.
 Creating the image view is now a matter of calling `vkCreateImageView`:
 
 ```c++
-if (vkCreateImageView(device, &createInfo, nullptr, &swapChainImageViews[i]) != VK_SUCCESS) {
+if (vkCreateImageView(device, &createInfo, nullptr, swapChainImageViews[i].replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create image views!");
 }
 ```
diff --git a/03_Drawing_a_triangle/02_Graphics_pipeline_basics/01_Shader_modules.md b/03_Drawing_a_triangle/02_Graphics_pipeline_basics/01_Shader_modules.md
@@ -374,7 +374,7 @@ createInfo.pCode = (uint32_t*) code.data();
 The `VkShaderModule` can then be created with a call to `vkCreateShaderModule`:
 
 ```c++
-if (vkCreateShaderModule(device, &createInfo, nullptr, &shaderModule) != VK_SUCCESS) {
+if (vkCreateShaderModule(device, &createInfo, nullptr, shaderModule.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create shader module!");
 }
 ```
diff --git a/03_Drawing_a_triangle/02_Graphics_pipeline_basics/02_Fixed_functions.md b/03_Drawing_a_triangle/02_Graphics_pipeline_basics/02_Fixed_functions.md
@@ -379,7 +379,7 @@ pipelineLayoutInfo.pushConstantRangeCount = 0; // Optional
 pipelineLayoutInfo.pPushConstantRanges = 0; // Optional
 
 if (vkCreatePipelineLayout(device, &pipelineLayoutInfo, nullptr,
-    &pipelineLayout) != VK_SUCCESS) {
+    pipelineLayout.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create pipeline layout!");
 }
 ```
diff --git a/03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.md b/03_Drawing_a_triangle/02_Graphics_pipeline_basics/03_Render_passes.md
@@ -189,7 +189,7 @@ renderPassInfo.pAttachments = &colorAttachment;
 renderPassInfo.subpassCount = 1;
 renderPassInfo.pSubpasses = &subPass;
 
-if (vkCreateRenderPass(device, &renderPassInfo, nullptr, &renderPass) != VK_SUCCESS) {
+if (vkCreateRenderPass(device, &renderPassInfo, nullptr, renderPass.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create render pass!");
 }
 ```
diff --git a/03_Drawing_a_triangle/02_Graphics_pipeline_basics/04_Conclusion.md b/03_Drawing_a_triangle/02_Graphics_pipeline_basics/04_Conclusion.md
@@ -75,7 +75,7 @@ VDeleter<VkPipeline> graphicsPipeline{device, vkDestroyPipeline};
 And finally create the graphics pipeline:
 
 ```c++
-if (vkCreateGraphicsPipelines(device, VK_NULL_HANDLE, 1, &pipelineInfo, nullptr, &graphicsPipeline) != VK_SUCCESS) {
+if (vkCreateGraphicsPipelines(device, VK_NULL_HANDLE, 1, &pipelineInfo, nullptr, graphicsPipeline.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create graphics pipeline!");
 }
 ```
diff --git a/03_Drawing_a_triangle/03_Drawing/00_Framebuffers.md b/03_Drawing_a_triangle/03_Drawing/00_Framebuffers.md
@@ -66,7 +66,7 @@ for (size_t i = 0; i < swapChainImageViews.size(); i++) {
     framebufferInfo.height = swapChainExtent.height;
     framebufferInfo.layers = 1;
 
-    if (vkCreateFramebuffer(device, &framebufferInfo, nullptr, &swapChainFramebuffers[i]) != VK_SUCCESS) {
+    if (vkCreateFramebuffer(device, &framebufferInfo, nullptr, swapChainFramebuffers[i].replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create framebuffer!");
     }
 }
diff --git a/03_Drawing_a_triangle/03_Drawing/01_Command_buffers.md b/03_Drawing_a_triangle/03_Drawing/01_Command_buffers.md
@@ -69,7 +69,7 @@ execute them many times in the main loop, so we're not going to use either of
 these flags.
 
 ```c++
-if (vkCreateCommandPool(device, &poolInfo, nullptr, &commandPool) != VK_SUCCESS) {
+if (vkCreateCommandPool(device, &poolInfo, nullptr, commandPool.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create command pool!");
 }
 ```
diff --git a/03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.md b/03_Drawing_a_triangle/03_Drawing/02_Rendering_and_presentation.md
@@ -100,8 +100,8 @@ Future versions of the Vulkan API or extensions may add functionality for the
 the semaphores follows the familiar pattern with `vkCreateSemaphore`:
 
 ```c++
-if (vkCreateSemaphore(device, &semaphoreInfo, nullptr, &imageAvailableSemaphore) != VK_SUCCESS ||
-    vkCreateSemaphore(device, &semaphoreInfo, nullptr, &renderFinishedSemaphore) != VK_SUCCESS) {
+if (vkCreateSemaphore(device, &semaphoreInfo, nullptr, imageAvailableSemaphore.replace()) != VK_SUCCESS ||
+    vkCreateSemaphore(device, &semaphoreInfo, nullptr, renderFinishedSemaphore.replace()) != VK_SUCCESS) {
 
     throw std::runtime_error("failed to create semaphores!");
 }
diff --git a/03_Drawing_a_triangle/04_Swap_chain_recreation.md b/03_Drawing_a_triangle/04_Swap_chain_recreation.md
@@ -50,7 +50,7 @@ if (vkCreateSwapchainKHR(device, &createInfo, nullptr, &newSwapChain) != VK_SUCC
     throw std::runtime_error("failed to create swap chain!");
 }
 
-*&swapChain = newSwapChain;
+swapChain = newSwapChain;
 ```
 
 We need to pass the previous swap chain object in the `oldSwapchain` parameter
@@ -61,7 +61,7 @@ The `VDeleter` would clear the old object before `vkCreateSwapchainKHR` has a
 chance to execute. That's why we use the temporary `newSwapChain` variable.
 
 ```c++
-*&swapChain = newSwapChain;
+swapChain = newSwapChain;
 ```
 
 This line will actually destroy the old swap chain and replace the handle with
diff --git a/04_Vertex_buffers/01_Vertex_buffer_creation.md b/04_Vertex_buffers/01_Vertex_buffer_creation.md
@@ -85,7 +85,7 @@ void createVertexBuffer() {
     bufferInfo.usage = VK_BUFFER_USAGE_VERTEX_BUFFER_BIT;
     bufferInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 
-    if (vkCreateBuffer(device, &bufferInfo, nullptr, &vertexBuffer) != VK_SUCCESS) {
+    if (vkCreateBuffer(device, &bufferInfo, nullptr, vertexBuffer.replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create vertex buffer!");
     }
 }
diff --git a/04_Vertex_buffers/02_Staging_buffer.md b/04_Vertex_buffers/02_Staging_buffer.md
@@ -51,7 +51,7 @@ void createBuffer(VkDeviceSize size, VkBufferUsageFlags usage, VkMemoryPropertyF
     bufferInfo.usage = usage;
     bufferInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 
-    if (vkCreateBuffer(device, &bufferInfo, nullptr, &buffer) != VK_SUCCESS) {
+    if (vkCreateBuffer(device, &bufferInfo, nullptr, buffer.replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create buffer!");
     }
 
diff --git a/05_Uniform_buffers/00_Descriptor_layout_and_buffer.md b/05_Uniform_buffers/00_Descriptor_layout_and_buffer.md
@@ -186,7 +186,7 @@ layoutInfo.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO;
 layoutInfo.bindingCount = 1;
 layoutInfo.pBindings = &uboLayoutBinding;
 
-if (vkCreateDescriptorSetLayout(device, &layoutInfo, nullptr, &descriptorSetLayout) != VK_SUCCESS) {
+if (vkCreateDescriptorSetLayout(device, &layoutInfo, nullptr, descriptorSetLayout.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create descriptor set layout!");
 }
 ```
diff --git a/05_Uniform_buffers/01_Descriptor_pool_and_sets.md b/05_Uniform_buffers/01_Descriptor_pool_and_sets.md
@@ -64,7 +64,7 @@ VDeleter<VkDescriptorPool> descriptorPool{device, vkDestroyDescriptorPool};
 
 ...
 
-if (vkCreateDescriptorPool(device, &poolInfo, nullptr, &descriptorPool) != VK_SUCCESS) {
+if (vkCreateDescriptorPool(device, &poolInfo, nullptr, descriptorPool.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create descriptor pool!");
 }
 ```
diff --git a/06_Texture_mapping/00_Images.md b/06_Texture_mapping/00_Images.md
@@ -244,7 +244,7 @@ avoid allocating memory to store large volumes of "air" values. We won't be
 using it in this tutorial, so leave it to its default value of `0`.
 
 ```c++
-if (vkCreateImage(device, &imageInfo, nullptr, &stagingImage) != VK_SUCCESS) {
+if (vkCreateImage(device, &imageInfo, nullptr, stagingImage.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create image!");
 }
 ```
@@ -317,7 +317,7 @@ void createImage(uint32_t width, uint32_t height, VkFormat format, VkImageTiling
     imageInfo.samples = VK_SAMPLE_COUNT_1_BIT;
     imageInfo.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
 
-    if (vkCreateImage(device, &imageInfo, nullptr, &image) != VK_SUCCESS) {
+    if (vkCreateImage(device, &imageInfo, nullptr, image.replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create image!");
     }
 
diff --git a/06_Texture_mapping/01_Image_view_and_sampler.md b/06_Texture_mapping/01_Image_view_and_sampler.md
@@ -53,7 +53,7 @@ I've left out the explicit `viewInfo.components` initialization, because
 image view by calling `vkCreateImageView`:
 
 ```c++
-if (vkCreateImageView(device, &viewInfo, nullptr, &textureImageView) != VK_SUCCESS) {
+if (vkCreateImageView(device, &viewInfo, nullptr, textureImageView.replace()) != VK_SUCCESS) {
     throw std::runtime_error("failed to create texture image view!");
 }
 ```
@@ -74,7 +74,7 @@ void createImageView(VkImage image, VkFormat format, VDeleter<VkImageView>& imag
     viewInfo.subresourceRange.baseArrayLayer = 0;
     viewInfo.subresourceRange.layerCount = 1;
 
-    if (vkCreateImageView(device, &viewInfo, nullptr, &imageView) != VK_SUCCESS) {
+    if (vkCreateImageView(device, &viewInfo, nullptr, imageView.replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create texture image view!");
     }
 }
@@ -266,7 +266,7 @@ VDeleter<VkSampler> textureSampler{device, vkDestroySampler};
 void createTextureSampler() {
     ...
 
-    if (vkCreateSampler(device, &samplerInfo, nullptr, &textureSampler) != VK_SUCCESS) {
+    if (vkCreateSampler(device, &samplerInfo, nullptr, textureSampler.replace()) != VK_SUCCESS) {
         throw std::runtime_error("failed to create texture sampler!");
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -315,7 +315,7 @@ couldn't be loaded. We can now call this function to create the extension`
`315`	`315`	`object if it's available:`
`316`	`316`
`317`	`317`	```c++
`318`		`-if (CreateDebugReportCallbackEXT(instance, &createInfo, nullptr, &callback) != VK_SUCCESS) {`
	`318`	`+if (CreateDebugReportCallbackEXT(instance, &createInfo, nullptr, callback.replace()) != VK_SUCCESS) {`
`319`	`319`	`throw std::runtime_error("failed to set up debug callback!");`
`320`	`320`	`}`
`321`	`321`	```
Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ That's it, we're now ready to instantiate the logical device with a call to the`
`122`	`122`	appropriately named `vkCreateDevice` function.
`123`	`123`
`124`	`124`	```c++
`125`		`-if (vkCreateDevice(physicalDevice, &createInfo, nullptr, &device) != VK_SUCCESS) {`
	`125`	`+if (vkCreateDevice(physicalDevice, &createInfo, nullptr, device.replace()) != VK_SUCCESS) {`
`126`	`126`	`throw std::runtime_error("failed to create logical device!");`
`127`	`127`	`}`
`128`	`128`	```
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ allocators and the variable for the surface handle to be stored in.`
`68`	`68`	`auto CreateWin32SurfaceKHR = (PFN_vkCreateWin32SurfaceKHR) vkGetInstanceProcAddr(instance, "vkCreateWin32SurfaceKHR");`
`69`	`69`
`70`	`70`	`if (!CreateWin32SurfaceKHR \|\| CreateWin32SurfaceKHR(instance, &createInfo,`
`71`		`- nullptr, &surface) != VK_SUCCESS) {`
	`71`	`+ nullptr, surface.replace()) != VK_SUCCESS) {`
`72`	`72`	`throw std::runtime_error("failed to create window surface!");`
`73`	`73`	`}`
`74`	`74`	```
`@@ -101,7 +101,7 @@ implementation of the function very straightforward:`
`101`	`101`
`102`	`102`	```c++
`103`	`103`	`void createSurface() {`
`104`		`- if (glfwCreateWindowSurface(instance, window, nullptr, &surface) != VK_SUCCESS) {`
	`104`	`+ if (glfwCreateWindowSurface(instance, window, nullptr, surface.replace()) != VK_SUCCESS) {`
`105`	`105`	`throw std::runtime_error("failed to create window surface!");`
`106`	`106`	`}`
`107`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -519,7 +519,7 @@ VDeleter<VkSwapchainKHR> swapChain{device, vkDestroySwapchainKHR};`
`519`	`519`	Now creating the swap chain is as simple as calling `vkCreateSwapchainKHR`:
`520`	`520`
`521`	`521`	```c++
`522`		`-if (vkCreateSwapchainKHR(device, &createInfo, nullptr, &swapChain) != VK_SUCCESS) {`
	`522`	`+if (vkCreateSwapchainKHR(device, &createInfo, nullptr, swapChain.replace()) != VK_SUCCESS) {`
`523`	`523`	`throw std::runtime_error("failed to create swap chain!");`
`524`	`524`	`}`
`525`	`525`	```
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ different layers.`
`105`	`105`	Creating the image view is now a matter of calling `vkCreateImageView`:
`106`	`106`
`107`	`107`	```c++
`108`		`-if (vkCreateImageView(device, &createInfo, nullptr, &swapChainImageViews[i]) != VK_SUCCESS) {`
	`108`	`+if (vkCreateImageView(device, &createInfo, nullptr, swapChainImageViews[i].replace()) != VK_SUCCESS) {`
`109`	`109`	`throw std::runtime_error("failed to create image views!");`
`110`	`110`	`}`
`111`	`111`	```
Original file line number	Diff line number	Diff line change
`@@ -374,7 +374,7 @@ createInfo.pCode = (uint32_t*) code.data();`
`374`	`374`	The `VkShaderModule` can then be created with a call to `vkCreateShaderModule`:
`375`	`375`
`376`	`376`	```c++
`377`		`-if (vkCreateShaderModule(device, &createInfo, nullptr, &shaderModule) != VK_SUCCESS) {`
	`377`	`+if (vkCreateShaderModule(device, &createInfo, nullptr, shaderModule.replace()) != VK_SUCCESS) {`
`378`	`378`	`throw std::runtime_error("failed to create shader module!");`
`379`	`379`	`}`
`380`	`380`	```
Original file line number	Diff line number	Diff line change
`@@ -379,7 +379,7 @@ pipelineLayoutInfo.pushConstantRangeCount = 0; // Optional`
`379`	`379`	`pipelineLayoutInfo.pPushConstantRanges = 0; // Optional`
`380`	`380`
`381`	`381`	`if (vkCreatePipelineLayout(device, &pipelineLayoutInfo, nullptr,`
`382`		`- &pipelineLayout) != VK_SUCCESS) {`
	`382`	`+ pipelineLayout.replace()) != VK_SUCCESS) {`
`383`	`383`	`throw std::runtime_error("failed to create pipeline layout!");`
`384`	`384`	`}`
`385`	`385`	```
Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ renderPassInfo.pAttachments = &colorAttachment;`
`189`	`189`	`renderPassInfo.subpassCount = 1;`
`190`	`190`	`renderPassInfo.pSubpasses = &subPass;`
`191`	`191`
`192`		`-if (vkCreateRenderPass(device, &renderPassInfo, nullptr, &renderPass) != VK_SUCCESS) {`
	`192`	`+if (vkCreateRenderPass(device, &renderPassInfo, nullptr, renderPass.replace()) != VK_SUCCESS) {`
`193`	`193`	`throw std::runtime_error("failed to create render pass!");`
`194`	`194`	`}`
`195`	`195`	```
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ VDeleter<VkPipeline> graphicsPipeline{device, vkDestroyPipeline};`
`75`	`75`	`And finally create the graphics pipeline:`
`76`	`76`
`77`	`77`	```c++
`78`		`-if (vkCreateGraphicsPipelines(device, VK_NULL_HANDLE, 1, &pipelineInfo, nullptr, &graphicsPipeline) != VK_SUCCESS) {`
	`78`	`+if (vkCreateGraphicsPipelines(device, VK_NULL_HANDLE, 1, &pipelineInfo, nullptr, graphicsPipeline.replace()) != VK_SUCCESS) {`
`79`	`79`	`throw std::runtime_error("failed to create graphics pipeline!");`
`80`	`80`	`}`
`81`	`81`	```