Renamed vk::pipeline_settings to vk::pipeline_params

SpinnerX · SpinnerX · commit 1a728f32d30c · 2026-01-24T03:31:38.000-08:00
diff --git a/vulkan-cpp/pipeline.cppm b/vulkan-cpp/pipeline.cppm
@@ -169,7 +169,7 @@ export namespace vk {
          * @param descriptor_layouts are the VkDescriptorSetLayout that you pass up
          * front to the graphics pipeline if there are any provided
          */
-        struct pipeline_settings {
+        struct pipeline_params {
             VkRenderPass renderpass = nullptr;
             std::span<const shader_handle> shader_modules{};
             std::span<const VkVertexInputAttributeDescription> vertex_attributes;
@@ -198,7 +198,7 @@ export namespace vk {
              * @param p_device is logical device to create the graphics pipeline handles
              * @param p_info are the parameters for creating the pipelines with
             */
-            pipeline(const VkDevice& p_device, const pipeline_settings& p_info) : m_device(p_device) {
+            pipeline(const VkDevice& p_device, const pipeline_params& p_info) : m_device(p_device) {
                 create(p_info);
             }
 
@@ -210,7 +210,7 @@ export namespace vk {
              * 
              * ```C++
              * 
-             * vk::pipeline_settings pipeline_params = {
+             * vk::pipeline_params pipeline_params = {
              *      .renderpass = main_renderpass // pass in VkRenderPass handle
              *      .shader_modules = shader_resource.handles() // sets the std::span<const shader_module>
              *      .vertex_attributes = shader_resource.vertex_attributes(),
@@ -230,7 +230,7 @@ export namespace vk {
              * More info on vulkan's official 
              * [docs](https://docs.vulkan.org/refpages/latest/refpages/source/vkCreateGraphicsPipelines.html)
              */
-            void create(const pipeline_settings& p_info) {
+            void create(const pipeline_params& p_info) {
                 std::vector<VkPipelineShaderStageCreateInfo> pipeline_shader_stages(p_info.shader_modules.size());
 
                 uint32_t shader_src_index = 0;
@@ -497,7 +497,7 @@ export namespace vk {
              *
              * ```C++
              *
-             * vk::pipeline graphics_pipeline(logical_device, *assume pipeline_settings is specified*);
+             * vk::pipeline graphics_pipeline(logical_device, *assume pipeline_params is specified*);
              *
              * // bound to current command buffer
              * // in this example we set binding point to VK_PIPELINE_BIND_POINT_GRAPHICS
@@ -539,7 +539,7 @@ export namespace vk {
              *
              * ```C++
              * 
-             * vk::pipeline graphics_pipeline(logical_device, *assume pipeline_settings is specified*);
+             * vk::pipeline graphics_pipeline(logical_device, *assume pipeline_params is specified*);
              * 
              * m_pipeline.push_constants(current, shader_stage::vertex, 0, 1,
              * &global_data);

Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ export namespace vk {`
`169`	`169`	`* @param descriptor_layouts are the VkDescriptorSetLayout that you pass up`
`170`	`170`	`* front to the graphics pipeline if there are any provided`
`171`	`171`	`*/`
`172`		`- struct pipeline_settings {`
	`172`	`+ struct pipeline_params {`
`173`	`173`	`VkRenderPass renderpass = nullptr;`
`174`	`174`	`std::span<const shader_handle> shader_modules{};`
`175`	`175`	`std::span<const VkVertexInputAttributeDescription> vertex_attributes;`
`@@ -198,7 +198,7 @@ export namespace vk {`
`198`	`198`	`* @param p_device is logical device to create the graphics pipeline handles`
`199`	`199`	`* @param p_info are the parameters for creating the pipelines with`
`200`	`200`	`*/`
`201`		`- pipeline(const VkDevice& p_device, const pipeline_settings& p_info) : m_device(p_device) {`
	`201`	`+ pipeline(const VkDevice& p_device, const pipeline_params& p_info) : m_device(p_device) {`
`202`	`202`	`create(p_info);`
`203`	`203`	`}`
`204`	`204`
`@@ -210,7 +210,7 @@ export namespace vk {`
`210`	`210`	`*`
`211`	`211`	* ```C++
`212`	`212`	`*`
`213`		`- * vk::pipeline_settings pipeline_params = {`
	`213`	`+ * vk::pipeline_params pipeline_params = {`
`214`	`214`	`* .renderpass = main_renderpass // pass in VkRenderPass handle`
`215`	`215`	`* .shader_modules = shader_resource.handles() // sets the std::span<const shader_module>`
`216`	`216`	`* .vertex_attributes = shader_resource.vertex_attributes(),`
`@@ -230,7 +230,7 @@ export namespace vk {`
`230`	`230`	`* More info on vulkan's official`
`231`	`231`	`* [docs](https://docs.vulkan.org/refpages/latest/refpages/source/vkCreateGraphicsPipelines.html)`
`232`	`232`	`*/`
`233`		`- void create(const pipeline_settings& p_info) {`
	`233`	`+ void create(const pipeline_params& p_info) {`
`234`	`234`	`std::vector<VkPipelineShaderStageCreateInfo> pipeline_shader_stages(p_info.shader_modules.size());`
`235`	`235`
`236`	`236`	`uint32_t shader_src_index = 0;`
`@@ -497,7 +497,7 @@ export namespace vk {`
`497`	`497`	`*`
`498`	`498`	* ```C++
`499`	`499`	`*`
`500`		`- * vk::pipeline graphics_pipeline(logical_device, assume pipeline_settings is specified);`
	`500`	`+ * vk::pipeline graphics_pipeline(logical_device, assume pipeline_params is specified);`
`501`	`501`	`*`
`502`	`502`	`* // bound to current command buffer`
`503`	`503`	`* // in this example we set binding point to VK_PIPELINE_BIND_POINT_GRAPHICS`
`@@ -539,7 +539,7 @@ export namespace vk {`
`539`	`539`	`*`
`540`	`540`	* ```C++
`541`	`541`	`*`
`542`		`- * vk::pipeline graphics_pipeline(logical_device, assume pipeline_settings is specified);`
	`542`	`+ * vk::pipeline graphics_pipeline(logical_device, assume pipeline_params is specified);`
`543`	`543`	`*`
`544`	`544`	`* m_pipeline.push_constants(current, shader_stage::vertex, 0, 1,`
`545`	`545`	`* &global_data);`