# [−][src]Struct shade_runner::layouts::Layout

    pub struct Layout {
        pub layout_data: LayoutData,
    }

## Fields

`layout_data: LayoutData`

## Trait Implementations

### `impl Default for Layout`[src]

#### `fn default() -> Layout`[src]

Returns the "default value" for a type. Read more

### `impl Clone for Layout`[src]

#### `fn clone(&self) -> Layout`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl Debug for Layout`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

### `impl PipelineLayoutDesc for Layout`[src]

#### `fn num_sets(&self) -> usize`[src]

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

#### `fn num_bindings_in_set(&self, set: usize) -> Option<usize>`[src]

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

#### `fn descriptor(&self, set: usize, binding: usize) -> Option<DescriptorDesc>`[src]

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

#### `fn num_push_constants_ranges(&self) -> usize`[src]

Returns the number of push constant ranges of the layout.

#### `fn push_constants_range(&self, num: usize) -> Option<PipelineLayoutDescPcRange>`[src]

Returns a description of the given push constants range. Read more

#### `fn provided_set_layout(
&self,
_set: usize
) -> Option<Arc<UnsafeDescriptorSetLayout>>`[src]

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

#### `fn union<T>(self, other: T) -> PipelineLayoutDescUnion<Self, T>`[src]

Builds the union of this layout and another.

#### `fn check_against_limits(
&self,
device: &Device
) -> Result<(), PipelineLayoutLimitsError>`[src]

Checks whether this description fulfills the device limits requirements.

#### `fn build(
self,
device: Arc<Device>
) -> Result<PipelineLayout<Self>, PipelineLayoutCreationError>`[src]

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

## Auto Trait Implementations

### `impl Send for Layout`

### `impl Unpin for Layout`

### `impl Sync for Layout`

### `impl UnwindSafe for Layout`

### `impl RefUnwindSafe for Layout`

## Blanket Implementations

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

Creates owned data from borrowed data, usually by cloning. Read more

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

### `impl<T> Content for T`[src]

#### `fn ref_from_ptr(ptr: *mut c_void, size: usize) -> Option<*mut T>`[src]

Builds a pointer to this type from a raw pointer.

#### `fn is_size_suitable(size: usize) -> bool`[src]

Returns true if the size is suitable to store a type like this.

#### `fn indiv_size() -> usize`[src]

Returns the size of an individual element.

### `impl<T> PipelineLayoutDesc for T where
T: SafeDeref,
<T as Deref>::Target: PipelineLayoutDesc,` [src]

#### `fn num_sets(&self) -> usize`[src]

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

#### `fn num_bindings_in_set(&self, set: usize) -> Option<usize>`[src]

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

#### `fn descriptor(&self, set: usize, binding: usize) -> Option<DescriptorDesc>`[src]

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

#### `fn num_push_constants_ranges(&self) -> usize`[src]

Returns the number of push constant ranges of the layout.

#### `fn push_constants_range(&self, num: usize) -> Option<PipelineLayoutDescPcRange>`[src]

Returns a description of the given push constants range. Read more

#### `fn provided_set_layout(
&self,
_set: usize
) -> Option<Arc<UnsafeDescriptorSetLayout>>`[src]

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

#### `fn union<T>(self, other: T) -> PipelineLayoutDescUnion<Self, T>`[src]

Builds the union of this layout and another.

#### `fn check_against_limits(
&self,
device: &Device
) -> Result<(), PipelineLayoutLimitsError>`[src]

Checks whether this description fulfills the device limits requirements.

#### `fn build(
self,
device: Arc<Device>
) -> Result<PipelineLayout<Self>, PipelineLayoutCreationError>`[src]

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

### `impl<T, U> PipelineLayoutPushConstantsCompatible<U> for T where
T: PipelineLayoutDesc + ?Sized,
U: ?Sized,` [src]

#### `fn is_compatible(&self, &U) -> bool`[src]

Returns true if `Pc` can be used with a pipeline that uses `self` as layout.

### `impl<T, U> PipelineLayoutSuperset<U> for T where
T: PipelineLayoutDesc + ?Sized,
U: PipelineLayoutDesc + ?Sized,` [src]

#### `fn ensure_superset_of(
&self,
other: &U
) -> Result<(), PipelineLayoutNotSupersetError>`[src]

Makes sure that `self` is a superset of `Other`. Returns an `Err` if this is not the case.

### `impl<T, U> PipelineLayoutSetsCompatible<U> for T where
T: PipelineLayoutDesc + ?Sized,
U: DescriptorSetsCollection + ?Sized,` [src]

#### `fn is_compatible(&self, sets: &U) -> bool`[src]

Returns true if `Other` can be used with a pipeline that uses `self` as layout.

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)