vulkan_pipeline.h File Reference

This file contains a Vulkan pipeline, which is responsible for combining items such as the shader modules, attributes, uniforms/descriptors, viewport/scissor, etc. More...

#include "vulkan_types.h"

Go to the source code of this file.

Functions
b8	vulkan_graphics_pipeline_create (vulkan_context *context, const vulkan_pipeline_config *config, vulkan_pipeline *out_pipeline)
	Creates a new Vulkan pipeline. More...
void	vulkan_pipeline_destroy (vulkan_context *context, vulkan_pipeline *pipeline)
	Destroys the given pipeline. More...
void	vulkan_pipeline_bind (vulkan_command_buffer *command_buffer, VkPipelineBindPoint bind_point, vulkan_pipeline *pipeline)
	Binds the given pipeline for use. This must be done within a renderpass. More...

Detailed Description

This file contains a Vulkan pipeline, which is responsible for combining items such as the shader modules, attributes, uniforms/descriptors, viewport/scissor, etc.

Author

Travis Vroman (travi.nosp@m.s@ko.nosp@m.hieng.nosp@m.ine..nosp@m.com)

Version

1.0

Date

2022-01-11

Copyright

Kohi Game Engine is Copyright (c) Travis Vroman 2021-2022

Function Documentation

vulkan_graphics_pipeline_create()

b8 vulkan_graphics_pipeline_create	(	vulkan_context *	context,
		const vulkan_pipeline_config *	config,
		vulkan_pipeline *	out_pipeline
	)

Creates a new Vulkan pipeline.

Parameters

context	A pointer to the Vulkan context.
config	A constant pointer to configuration to be used in creating the pipeline.
out_pipeline	A pointer to hold the newly-created pipeline.

Returns

True on success; otherwise false.

vulkan_pipeline_bind()

void vulkan_pipeline_bind	(	vulkan_command_buffer *	command_buffer,
		VkPipelineBindPoint	bind_point,
		vulkan_pipeline *	pipeline
	)

Binds the given pipeline for use. This must be done within a renderpass.

Parameters

command_buffer	The command buffer to assign the bind command to.
bind_point	The pipeline bind point (typically bind_point_graphics)
pipeline	A pointer to the pipeline to be bound.

vulkan_pipeline_destroy()

void vulkan_pipeline_destroy	(	vulkan_context *	context,
		vulkan_pipeline *	pipeline
	)

Destroys the given pipeline.

Parameters

context	A pointer to the Vulkan context.
pipeline	A pointer to the pipeline to be destroyed.