Struct vulkano::descriptor::pipeline_layout::PipelineLayout

pub struct PipelineLayout<L> { /* private fields */ }

Wrapper around the PipelineLayout Vulkan object. Describes to the Vulkan implementation the descriptor sets and push constants available to your shaders

Implementations

impl<L> PipelineLayout<L>where
    L: PipelineLayoutDesc,

pub fn new(
    device: Arc<Device>,
    desc: L
) -> Result<PipelineLayout<L>, PipelineLayoutCreationError>

Creates a new PipelineLayout.

Panic

• Panics if one of the layout returned by provided_set_layout() belongs to a different device than the one passed as parameter.

impl<L> PipelineLayout<L>where
    L: PipelineLayoutDesc,

pub fn desc(&self) -> &L

Returns the description of the pipeline layout.

Trait Implementations

impl<D> Debug for PipelineLayout<D>where
    D: Debug,

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

Formats the value using the given formatter.

impl<D> DeviceOwned for PipelineLayout<D>

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl<L> Drop for PipelineLayout<L>

fn drop(&mut self)

Executes the destructor for this type.

impl<D> PipelineLayoutAbstract for PipelineLayout<D>where
    D: PipelineLayoutDesc,

fn sys(&self) -> PipelineLayoutSys<'_>

Returns an opaque object that allows internal access to the pipeline layout.

fn descriptor_set_layout(
    &self,
    index: usize
) -> Option<&Arc<UnsafeDescriptorSetLayout>>

Returns the UnsafeDescriptorSetLayout object of the specified set index.

impl<D> PipelineLayoutDesc for PipelineLayout<D>where
    D: PipelineLayoutDesc,

fn num_sets(&self) -> usize

Returns the number of sets in the layout. Includes possibly empty sets.

fn num_bindings_in_set(&self, set: usize) -> Option<usize>

Returns the number of descriptors in the set. Includes possibly empty descriptors.

fn descriptor(&self, set: usize, binding: usize) -> Option<DescriptorDesc>

Returns the descriptor for the given binding of the given set.

fn num_push_constants_ranges(&self) -> usize

Returns the number of push constant ranges of the layout.

fn push_constants_range(&self, num: usize) -> Option<PipelineLayoutDescPcRange>

Returns a description of the given push constants range.

fn provided_set_layout(
    &self,
    _set: usize
) -> Option<Arc<UnsafeDescriptorSetLayout>>

If the PipelineLayoutDesc implementation is able to provide an existing UnsafeDescriptorSetLayout for a given set, it can do so by returning it here.

fn union<T>(self, other: T) -> PipelineLayoutDescUnion<Self, T>where
    Self: Sized,

Builds the union of this layout and another.

fn check_against_limits(
    &self,
    device: &Device
) -> Result<(), PipelineLayoutLimitsError>

Checks whether this description fulfills the device limits requirements.

fn build(
    self,
    device: Arc<Device>
) -> Result<PipelineLayout<Self>, PipelineLayoutCreationError>where
    Self: Sized,

Turns the layout description into a PipelineLayout object that can be used by Vulkan.