Struct vulkano::render_pass::AttachmentDescription
source · [−]pub struct AttachmentDescription {
pub format: Option<Format>,
pub samples: SampleCount,
pub load_op: LoadOp,
pub store_op: StoreOp,
pub stencil_load_op: LoadOp,
pub stencil_store_op: StoreOp,
pub initial_layout: ImageLayout,
pub final_layout: ImageLayout,
pub _ne: NonExhaustive,
}
Expand description
Describes an attachment that will be used in a render pass.
Fields
format: Option<Format>
The format of the image that is going to be bound.
The default value is None
, which must be overridden.
samples: SampleCount
The number of samples of the image that is going to be bound.
The default value is SampleCount::Sample1
.
load_op: LoadOp
What the implementation should do with the attachment at the start of the subpass that first uses it.
The default value is LoadOp::DontCare
.
store_op: StoreOp
What the implementation should do with the attachment at the end of the subpass that last uses it.
The default value is StoreOp::DontCare
.
stencil_load_op: LoadOp
The equivalent of load_op
for the stencil component of the attachment, if any. Irrelevant
if there is no stencil component.
The default value is LoadOp::DontCare
.
stencil_store_op: StoreOp
The equivalent of store_op
for the stencil component of the attachment, if any. Irrelevant
if there is no stencil component.
The default value is StoreOp::DontCare
.
initial_layout: ImageLayout
The layout that the image must in at the start of the render pass.
The vulkano library will automatically switch to the correct layout if necessary, but it is more efficient to set this to the correct value.
The default value is ImageLayout::Undefined
, which must be overridden.
final_layout: ImageLayout
The layout that the image will be transitioned to at the end of the render pass.
The default value is ImageLayout::Undefined
, which must be overridden.
_ne: NonExhaustive
Implementations
sourceimpl AttachmentDescription
impl AttachmentDescription
sourcepub fn is_compatible_with(&self, other: &AttachmentDescription) -> bool
pub fn is_compatible_with(&self, other: &AttachmentDescription) -> bool
Returns true if this attachment is compatible with another attachment, as defined in the
Render Pass Compatibility
section of the Vulkan specs.
Trait Implementations
sourceimpl Clone for AttachmentDescription
impl Clone for AttachmentDescription
sourcefn clone(&self) -> AttachmentDescription
fn clone(&self) -> AttachmentDescription
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for AttachmentDescription
impl Debug for AttachmentDescription
sourceimpl Default for AttachmentDescription
impl Default for AttachmentDescription
impl Copy for AttachmentDescription
Auto Trait Implementations
impl RefUnwindSafe for AttachmentDescription
impl Send for AttachmentDescription
impl Sync for AttachmentDescription
impl Unpin for AttachmentDescription
impl UnwindSafe for AttachmentDescription
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more