Struct vulkano::descriptor_set::layout::DescriptorSetLayout

pub struct DescriptorSetLayout { /* private fields */ }

Describes to the Vulkan implementation the layout of all descriptors within a descriptor set.

Implementations

impl DescriptorSetLayout

pub fn new(
    device: Arc<Device>,
    create_info: DescriptorSetLayoutCreateInfo
) -> Result<Arc<DescriptorSetLayout>, DescriptorSetLayoutCreationError>

Creates a new DescriptorSetLayout.

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

Creates a new DescriptorSetLayout 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 bindings(&self) -> &BTreeMap<u32, DescriptorSetLayoutBinding>

Returns the bindings of the descriptor set layout.

pub fn push_descriptor(&self) -> bool

Returns whether the descriptor set layout is for push descriptors or regular descriptor sets.

pub fn descriptor_counts(&self) -> &HashMap<DescriptorType, u32>

Returns the number of descriptors of each type.

The map is guaranteed to not contain any elements with a count of 0.

pub fn variable_descriptor_count(&self) -> u32

If the highest-numbered binding has a variable count, returns its descriptor_count. Otherwise returns 0.

pub fn is_compatible_with(&self, other: &DescriptorSetLayout) -> bool

Returns whether self is compatible with other.

“Compatible” in this sense is defined by the Vulkan specification under the section “Pipeline layout compatibility”: either the two are the same descriptor set layout object, or they must be identically defined to the Vulkan API.

Trait Implementations

impl Debug for DescriptorSetLayout

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

Formats the value using the given formatter.

impl DeviceOwned for DescriptorSetLayout

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

Returns the device that owns Self.

impl Drop for DescriptorSetLayout

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for DescriptorSetLayout

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<DescriptorSetLayout> for DescriptorSetLayout

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 DescriptorSetLayout

type Handle = DescriptorSetLayout

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for DescriptorSetLayout