Struct PipelineBuilder 

pub struct PipelineBuilder {
    pub device: Arc<VulkanDevice>,
    pub mesh: Arc<GenericMeshWithMaterial>,
    pub shaders: Arc<DrawShaders>,
    pub descriptor_sets: Arc<DescriptorSets>,
    pub renderpass: Arc<VulkanRenderPass>,
    pub pipeline_cache: Arc<VulkanPipelineCache>,
    pub rasterization_state_ci: VkPipelineRasterizationStateCreateInfo,
    pub msaa_state_ci: VkPipelineMultisampleStateCreateInfo,
    pub depth_stenctil_ci: VkPipelineDepthStencilStateCreateInfo,
    pub color_blend_state_ci: VkPipelineColorBlendStateCreateInfo,
    pub color_blend_attachment_states: Vec<VkPipelineColorBlendAttachmentState>,
    pub dynamic_states: HashSet<VkDynamicState>,
    /* private fields */
}

Build a pipeline step by step

Fields

device: Arc<VulkanDevice>

The associated device

mesh: Arc<GenericMeshWithMaterial>

The meshes to draw

shaders: Arc<DrawShaders>

The shaders to use

descriptor_sets: Arc<DescriptorSets>

The descriptor sets

renderpass: Arc<VulkanRenderPass>

The render target props

pipeline_cache: Arc<VulkanPipelineCache>

The pipeline cache

rasterization_state_ci: VkPipelineRasterizationStateCreateInfo

The rasterization state create info

msaa_state_ci: VkPipelineMultisampleStateCreateInfo

The MSAA state create info

depth_stenctil_ci: VkPipelineDepthStencilStateCreateInfo

The depth stencil state create info

color_blend_state_ci: VkPipelineColorBlendStateCreateInfo

The color blend state create info

color_blend_attachment_states: Vec<VkPipelineColorBlendAttachmentState>

The color blend attachment states

dynamic_states: HashSet<VkDynamicState>

The dynamic states

Implementations

impl PipelineBuilder

pub fn new( device: Arc<VulkanDevice>, mesh: Arc<GenericMeshWithMaterial>, shaders: Arc<DrawShaders>, desc_pool: Arc<DescriptorPool>, desc_props: Arc<DescriptorProps>, renderpass: Arc<VulkanRenderPass>, pipeline_cache: Arc<VulkanPipelineCache>, ) -> Result<Self, VulkanError>

Create the PipelineBuilder

pub fn set_depth_clamp_mode(self, enabled: bool) -> Self

Set depth clamp enabled/disabled

pub fn set_disable_fragment_stage(self, disabled: bool) -> Self

Set depth clamp enabled/disabled

pub fn set_polygon_mode(self, mode: VkPolygonMode) -> Self

Set polygon mode

pub fn set_cull_mode(self, mode: VkCullModeFlags) -> Self

Set cull mode

pub fn set_front_face(self, front_face: VkFrontFace) -> Self

Set front face

pub fn enable_depth_bias( self, constant: f32, slope_scale: f32, clamp: f32, ) -> Self

Set enable depth bias mode

pub fn disable_depth_bias(self) -> Self

Set disable depth bias mode

pub fn set_line_width(self, line_width: f32) -> Self

Set line width

pub fn set_msaa_samples(self, msaa_samples: VkSampleCountFlagBits) -> Self

Set MSAA sample cound

pub fn set_msaa_alpha_to_coverage(self, enabled: bool) -> Self

Set use dithering to handle MSAA alpha

pub fn set_msaa_super_sampling(self, quality: Option<f32>) -> Self

Set MSAA supersampling state

pub fn set_depth_test(self, enabled: bool) -> Self

Set depth test state

pub fn set_depth_write(self, enabled: bool) -> Self

Set depth write state

pub fn set_depth_compare_mode(self, mode: VkCompareOp) -> Self

Set depth compare mode

pub fn set_depth_bound_test_mode(self, bounds: Option<(f32, f32)>) -> Self

Set depth bound test mode

pub fn set_stencil_test(self, enabled: bool) -> Self

Set stencil test mode

pub fn set_stencil_mode( self, front_face: VkStencilOpState, back_face: VkStencilOpState, ) -> Self

Set stencil mode

pub fn normal_blend_mode() -> VkPipelineColorBlendAttachmentState

Return a color blend mode for normal alpha blend

pub fn additive_blend_mode() -> VkPipelineColorBlendAttachmentState

Return a color blend mode for additive blend

pub fn disabled_blend_mode() -> VkPipelineColorBlendAttachmentState

Return a color blend mode for no blending

pub fn set_color_blend_mode( self, attachment_index: usize, color_blend_mode: VkPipelineColorBlendAttachmentState, ) -> Self

Set alpha blend mode

pub fn add_dynamic_state(self, dynamic_state: VkDynamicState) -> Self

Add a dynamic state

pub fn remove_dynamic_state(self, dynamic_state: VkDynamicState) -> Self

Remove a dynamic state

pub fn build(self) -> Result<Pipeline, VulkanError>

Generate the pipeline

Trait Implementations

impl Clone for PipelineBuilder

fn clone(&self) -> PipelineBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipelineBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for PipelineBuilder

fn drop(&mut self)

Executes the destructor for this type.