Struct vulkano::pipeline::layout::PipelineLayout

pub struct PipelineLayout { /* private fields */ }

Describes the layout of descriptor sets and push constants that are made available to shaders.

Implementations

impl PipelineLayout

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

Creates a new PipelineLayout.

Panics

• Panics if an element of create_info.push_constant_ranges has an empty stages value.
• Panics if an element of create_info.push_constant_ranges has an offset or size that’s not divisible by 4.
• Panics if an element of create_info.push_constant_ranges has an size of zero.

pub unsafe fn from_handle(
    device: Arc<Device>,
    handle: PipelineLayout,
    create_info: PipelineLayoutCreateInfo
) -> Arc<PipelineLayout>

Creates a new PipelineLayout from a raw object handle.

Safety

• handle must be a valid Vulkan object handle created from device.
• create_info must match the info used to create the object.

pub fn set_layouts(&self) -> &[Arc<DescriptorSetLayout>]

Returns the descriptor set layouts this pipeline layout was created from.

pub fn push_constant_ranges(&self) -> &[PushConstantRange]

Returns a slice containing the push constant ranges this pipeline layout was created from.

The ranges are guaranteed to be sorted deterministically by offset, size, then stages. This means that two slices containing the same elements will always have the same order.

pub fn is_compatible_with(&self, other: &PipelineLayout, num_sets: u32) -> bool

Returns whether self is compatible with other for the given number of sets.

pub fn ensure_compatible_with_shader<'a>(
    &self,
    descriptor_requirements: impl IntoIterator<Item = ((u32, u32), &'a DescriptorRequirements)>,
    push_constant_range: Option<&PushConstantRange>
) -> Result<(), PipelineLayoutSupersetError>

Makes sure that self is a superset of the provided descriptor set layouts and push constant ranges. Returns an Err if this is not the case.

Trait Implementations

impl Debug for PipelineLayout

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

Formats the value using the given formatter.

impl DeviceOwned for PipelineLayout

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

Returns the device that owns Self.

impl Drop for PipelineLayout

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for PipelineLayout

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<PipelineLayout> for PipelineLayout

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for PipelineLayout

type Object = PipelineLayout

The type of the object.

fn internal_object(&self) -> Self::Object

Returns a reference to the object.

impl Eq for PipelineLayout