sierra 0.6.0

Vulkan-lite graphics API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

mod compute;
mod graphics;
mod ray_tracing;

pub use {
    self::{compute::*, graphics::*, ray_tracing::*},
    crate::{
        backend::PipelineLayout,
        descriptor::{UpdatedDescriptors, UpdatedPipelineDescriptors},
        encode::{Encoder, EncoderCommon},
    },
};

use bytemuck::Pod;

use crate::{descriptor::DescriptorSetLayout, shader::ShaderStageFlags, Device, OutOfMemory};

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct PushConstant {
    pub stages: ShaderStageFlags,
    pub offset: u32,
    pub size: u32,
}

/// Defines layout of pipeline inputs: all descriptor sets and push constants.
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct PipelineLayoutInfo {
    /// Array of descriptor set layouts.
    pub sets: Vec<DescriptorSetLayout>,
    pub push_constants: Vec<PushConstant>,
}

/// [`PipelineLayout`] for specific [`PipelineInput`].
pub trait PipelineInputLayout {
    fn new(device: &Device) -> Result<Self, OutOfMemory>
    where
        Self: Sized;

    fn raw(&self) -> &PipelineLayout;

    fn bind_graphics<D, const N: u32>(
        &self,
        updated_descriptors: &D,
        encoder: &mut EncoderCommon<'_>,
    ) where
        D: UpdatedPipelineDescriptors<Self, N>;

    fn bind_compute<D, const N: u32>(
        &self,
        updated_descriptors: &D,
        encoder: &mut EncoderCommon<'_>,
    ) where
        D: UpdatedPipelineDescriptors<Self, N>;

    fn bind_ray_tracing<D, const N: u32>(
        &self,
        updated_descriptors: &D,
        encoder: &mut EncoderCommon<'_>,
    ) where
        D: UpdatedPipelineDescriptors<Self, N>;

    fn push_constants<P>(&self, push_constants: &P, encoder: &mut EncoderCommon<'_>)
    where
        P: PipelinePushConstants<Self>;
}

pub trait PipelineInput {
    type Layout: PipelineInputLayout;

    fn layout(device: &Device) -> Result<Self::Layout, OutOfMemory>;
}

/// Extension trait for push constants, specifying stages, offset and size in the typed pipeline.
///
/// This trait is intended to be implemented by proc macro `#[derive(Pipeline)]`
/// for types marked as `#[push]`.
pub trait PipelinePushConstants<P: ?Sized> {
    /// Stage flags for which push constants are enabled.
    const STAGES: ShaderStageFlags;

    /// Offset of the instance of push constants.
    const OFFSET: u32;

    /// Shader repr type matching push constants layout.
    type Repr: Pod;

    /// Function to convert push constants into correct repr.
    fn to_repr(&self) -> Self::Repr;
}