09 Specifying pipeline depth and stencil state.cpp

// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and / or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The below copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Vulkan Cookbook
// ISBN: 9781786468154
// © Packt Publishing Limited
//
// Author:   Pawel Lapinski
// LinkedIn: https://www.linkedin.com/in/pawel-lapinski-84522329
//
// Chapter: 08 Graphics and Compute Pipelines
// Recipe:  09 Specifying pipeline depth and stencil state

#include "08 Graphics and Compute Pipelines/09 Specifying pipeline depth and stencil state.h"

namespace VulkanCookbook {

  void SpecifyPipelineDepthAndStencilState( bool                                    depth_test_enable,
                                            bool                                    depth_write_enable,
                                            VkCompareOp                             depth_compare_op,
                                            bool                                    depth_bounds_test_enable,
                                            float                                   min_depth_bounds,
                                            float                                   max_depth_bounds,
                                            bool                                    stencil_test_enable,
                                            VkStencilOpState                        front_stencil_test_parameters,
                                            VkStencilOpState                        back_stencil_test_parameters,
                                            VkPipelineDepthStencilStateCreateInfo & depth_and_stencil_state_create_info ) {
    depth_and_stencil_state_create_info = {
      VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO,   // VkStructureType                            sType
      nullptr,                                                      // const void                               * pNext
      0,                                                            // VkPipelineDepthStencilStateCreateFlags     flags
      depth_test_enable,                                            // VkBool32                                   depthTestEnable
      depth_write_enable,                                           // VkBool32                                   depthWriteEnable
      depth_compare_op,                                             // VkCompareOp                                depthCompareOp
      depth_bounds_test_enable,                                     // VkBool32                                   depthBoundsTestEnable
      stencil_test_enable,                                          // VkBool32                                   stencilTestEnable
      front_stencil_test_parameters,                                // VkStencilOpState                           front
      back_stencil_test_parameters,                                 // VkStencilOpState                           back
      min_depth_bounds,                                             // float                                      minDepthBounds
      max_depth_bounds                                              // float                                      maxDepthBounds
    };
  }

} // namespace VulkanCookbook