vk · Structs · A5 · VK

Stvk::AttachmentDescription2

pub struct AttachmentDescription2<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub flags: AttachmentDescriptionFlags,
    pub format: Format,
    pub samples: SampleCountFlagBits,
    pub load_op: AttachmentLoadOp,
    pub store_op: AttachmentStoreOp,
    pub stencil_load_op: AttachmentLoadOp,
    pub stencil_store_op: AttachmentStoreOp,
    pub initial_layout: ImageLayout,
    pub final_layout: ImageLayout,
    /* private fields */
}

Native structure VkAttachmentDescription2.

Contract

Native structure VkAttachmentDescription2.

Khronos reference: VkAttachmentDescription2

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

flags

Field

flags: AttachmentDescriptionFlags

Native field flags.

format

Field

format: Format

Native field format.

samples

Field

samples: SampleCountFlagBits

Native field samples.

load_op

Field

load_op: AttachmentLoadOp

Native field loadOp.

store_op

Field

store_op: AttachmentStoreOp

Native field storeOp.

stencil_load_op

Field

stencil_load_op: AttachmentLoadOp

Native field stencilLoadOp.

stencil_store_op

Field

stencil_store_op: AttachmentStoreOp

Native field stencilStoreOp.

initial_layout

Field

initial_layout: ImageLayout

Native field initialLayout.

final_layout

Field

final_layout: ImageLayout

Native field finalLayout.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

set_flags

Method

pub fn set_flags(self, value: AttachmentDescriptionFlags) -> Self

Set native field flags without native effects.

set_format

Method

pub fn set_format(self, value: Format) -> Self

Set native field format without native effects.

set_samples

Method

pub fn set_samples(self, value: SampleCountFlagBits) -> Self

Set native field samples without native effects.

set_load_op

Method

pub fn set_load_op(self, value: AttachmentLoadOp) -> Self

Set native field loadOp without native effects.

set_store_op

Method

pub fn set_store_op(self, value: AttachmentStoreOp) -> Self

Set native field storeOp without native effects.

set_stencil_load_op

Method

pub fn set_stencil_load_op(self, value: AttachmentLoadOp) -> Self

Set native field stencilLoadOp without native effects.

set_stencil_store_op

Method

pub fn set_stencil_store_op(self, value: AttachmentStoreOp) -> Self

Set native field stencilStoreOp without native effects.

set_initial_layout

Method

pub fn set_initial_layout(self, value: ImageLayout) -> Self

Set native field initialLayout without native effects.

set_final_layout

Method

pub fn set_final_layout(self, value: ImageLayout) -> Self

Set native field finalLayout without native effects.

push_next

Method

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentDescriptionFlagBits

#[repr(transparent)]pub struct AttachmentDescriptionFlagBits(pub u32);

Open integer representation of VkAttachmentDescriptionFlagBits.

Contract

Open integer representation of VkAttachmentDescriptionFlagBits.

Khronos reference: VkAttachmentDescriptionFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

MAY_ALIAS_BIT

Method

pub const MAY_ALIAS_BIT: Self

Native value VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT.

Khronos reference: VK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT

RESOLVE_SKIP_TRANSFER_FUNCTION_BIT_KHR

Method

pub const RESOLVE_SKIP_TRANSFER_FUNCTION_BIT_KHR: Self

Native value VK_ATTACHMENT_DESCRIPTION_RESOLVE_SKIP_TRANSFER_FUNCTION_BIT_KHR.

Khronos reference: VK_ATTACHMENT_DESCRIPTION_RESOLVE_SKIP_TRANSFER_FUNCTION_BIT_KHR

RESOLVE_ENABLE_TRANSFER_FUNCTION_BIT_KHR

Method

pub const RESOLVE_ENABLE_TRANSFER_FUNCTION_BIT_KHR: Self

Native value VK_ATTACHMENT_DESCRIPTION_RESOLVE_ENABLE_TRANSFER_FUNCTION_BIT_KHR.

Khronos reference: VK_ATTACHMENT_DESCRIPTION_RESOLVE_ENABLE_TRANSFER_FUNCTION_BIT_KHR

from_raw

Method

pub const fn from_raw(value: u32) -> Self

No public source comment is attached to this declaration.

as_raw

Method

pub const fn as_raw(self) -> u32

No public source comment is attached to this declaration.

empty

Method

pub const fn empty() -> Self

No public source comment is attached to this declaration.

Output

Method

type Output = AttachmentDescriptionFlagBits

The resulting type after applying the & operator.

bitand

Method

fn bitand(self, rhs: Self) -> Self

Performs the & operation. Read more

Output-1

Method

type Output = AttachmentDescriptionFlagBits

The resulting type after applying the | operator.

bitor

Method

fn bitor(self, rhs: Self) -> Self

Performs the | operation. Read more

Output-2

Method

type Output = AttachmentDescriptionFlagBits

The resulting type after applying the ^ operator.

bitxor

Method

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation. Read more

clone

Method

fn clone(&self) -> AttachmentDescriptionFlagBits

Returns a duplicate of the value. Read more

fmt

Method

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

Formats the value using the given formatter. Read more

default

Method

fn default() -> AttachmentDescriptionFlagBits

Returns the “default value” for a type. Read more

hash

Method

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

Feeds this value into the given Hasher. Read more

Output-3

Method

type Output = AttachmentDescriptionFlagBits

The resulting type after applying the ! operator.

not

Method

fn not(self) -> Self

Performs the unary ! operation. Read more

eq

Method

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

Tests for self and other values to be equal, and is used by ==.

Stvk::AttachmentDescriptionStencilLayout

pub struct AttachmentDescriptionStencilLayout<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub stencil_initial_layout: ImageLayout,
    pub stencil_final_layout: ImageLayout,
    /* private fields */
}

Native structure VkAttachmentDescriptionStencilLayout.

Contract

Native structure VkAttachmentDescriptionStencilLayout.

Khronos reference: VkAttachmentDescriptionStencilLayout

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

stencil_initial_layout

Field

stencil_initial_layout: ImageLayout

Native field stencilInitialLayout.

stencil_final_layout

Field

stencil_final_layout: ImageLayout

Native field stencilFinalLayout.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

set_stencil_initial_layout

Method

pub fn set_stencil_initial_layout(self, value: ImageLayout) -> Self

Set native field stencilInitialLayout without native effects.

set_stencil_final_layout

Method

pub fn set_stencil_final_layout(self, value: ImageLayout) -> Self

Set native field stencilFinalLayout without native effects.

push_next

Method

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentFeedbackLoopInfoEXT

pub struct AttachmentFeedbackLoopInfoEXT<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub feedback_loop_enable: Bool32,
    /* private fields */
}

Native structure VkAttachmentFeedbackLoopInfoEXT.

Contract

Native structure VkAttachmentFeedbackLoopInfoEXT.

Khronos reference: VkAttachmentFeedbackLoopInfoEXT

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

feedback_loop_enable

Field

feedback_loop_enable: Bool32

Native field feedbackLoopEnable.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

set_feedback_loop_enable

Method

pub fn set_feedback_loop_enable(self, value: Bool32) -> Self

Set native field feedbackLoopEnable without native effects.

push_next

Method

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentLoadOp

#[repr(transparent)]pub struct AttachmentLoadOp(pub i32);

Open integer representation of VkAttachmentLoadOp.

Contract

Open integer representation of VkAttachmentLoadOp.

Khronos reference: VkAttachmentLoadOp

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

LOAD

Method

pub const LOAD: Self

Native value VK_ATTACHMENT_LOAD_OP_LOAD.

Khronos reference: VK_ATTACHMENT_LOAD_OP_LOAD

CLEAR

Method

pub const CLEAR: Self

Native value VK_ATTACHMENT_LOAD_OP_CLEAR.

Khronos reference: VK_ATTACHMENT_LOAD_OP_CLEAR

DONT_CARE

Method

pub const DONT_CARE: Self

Native value VK_ATTACHMENT_LOAD_OP_DONT_CARE.

Khronos reference: VK_ATTACHMENT_LOAD_OP_DONT_CARE

NONE

Method

pub const NONE: Self

Native value VK_ATTACHMENT_LOAD_OP_NONE.

Khronos reference: VK_ATTACHMENT_LOAD_OP_NONE

NONE_EXT

Method

pub const NONE_EXT: Self

Native value VK_ATTACHMENT_LOAD_OP_NONE_EXT.

Khronos reference: VK_ATTACHMENT_LOAD_OP_NONE_EXT

NONE_KHR

Method

pub const NONE_KHR: Self

Native value VK_ATTACHMENT_LOAD_OP_NONE_KHR.

Khronos reference: VK_ATTACHMENT_LOAD_OP_NONE_KHR

from_raw

Method

pub const fn from_raw(value: i32) -> Self

No public source comment is attached to this declaration.

as_raw

Method

pub const fn as_raw(self) -> i32

No public source comment is attached to this declaration.

empty

Method

pub const fn empty() -> Self

No public source comment is attached to this declaration.

clone

Method

fn clone(&self) -> AttachmentLoadOp

Returns a duplicate of the value. Read more

fmt

Method

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

Formats the value using the given formatter. Read more

default

Method

fn default() -> AttachmentLoadOp

Returns the “default value” for a type. Read more

hash

Method

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

Feeds this value into the given Hasher. Read more

eq

Method

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

Tests for self and other values to be equal, and is used by ==.

Stvk::AttachmentReference

#[repr(C)]pub struct AttachmentReference {
    pub attachment: u32,
    pub layout: ImageLayout,
}

Native structure VkAttachmentReference.

Contract

Native structure VkAttachmentReference.

Khronos reference: VkAttachmentReference

Fields

attachment

Field

attachment: u32

Native field attachment.

layout

Field

layout: ImageLayout

Native field layout.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_attachment

Method

pub fn set_attachment(self, value: u32) -> Self

Set native field attachment without native effects.

set_layout

Method

pub fn set_layout(self, value: ImageLayout) -> Self

Set native field layout without native effects.

clone

Method

fn clone(&self) -> AttachmentReference

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentReference2

pub struct AttachmentReference2<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub attachment: u32,
    pub layout: ImageLayout,
    pub aspect_mask: ImageAspectFlags,
    /* private fields */
}

Native structure VkAttachmentReference2.

Contract

Native structure VkAttachmentReference2.

Khronos reference: VkAttachmentReference2

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

attachment

Field

attachment: u32

Native field attachment.

layout

Field

layout: ImageLayout

Native field layout.

aspect_mask

Field

aspect_mask: ImageAspectFlags

Native field aspectMask.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

set_attachment

Method

pub fn set_attachment(self, value: u32) -> Self

Set native field attachment without native effects.

set_layout

Method

pub fn set_layout(self, value: ImageLayout) -> Self

Set native field layout without native effects.

set_aspect_mask

Method

pub fn set_aspect_mask(self, value: ImageAspectFlags) -> Self

Set native field aspectMask without native effects.

push_next

Method

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentReferenceStencilLayout

pub struct AttachmentReferenceStencilLayout<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub stencil_layout: ImageLayout,
    /* private fields */
}

Native structure VkAttachmentReferenceStencilLayout.

Contract

Native structure VkAttachmentReferenceStencilLayout.

Khronos reference: VkAttachmentReferenceStencilLayout

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

stencil_layout

Field

stencil_layout: ImageLayout

Native field stencilLayout.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

set_stencil_layout

Method

pub fn set_stencil_layout(self, value: ImageLayout) -> Self

Set native field stencilLayout without native effects.

push_next

Method

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentSampleCountInfoAMD

pub struct AttachmentSampleCountInfoAMD<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub color_attachment_count: u32,
    pub p_color_attachment_samples: *const SampleCountFlagBits,
    pub depth_stencil_attachment_samples: SampleCountFlagBits,
    /* private fields */
}

Native structure VkAttachmentSampleCountInfoAMD.

Contract

Native structure VkAttachmentSampleCountInfoAMD.

Khronos reference: VkAttachmentSampleCountInfoAMD

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

color_attachment_count

Field

color_attachment_count: u32

Native field colorAttachmentCount.

p_color_attachment_samples

Field

p_color_attachment_samples: *const SampleCountFlagBits

Native field pColorAttachmentSamples.

depth_stencil_attachment_samples

Field

depth_stencil_attachment_samples: SampleCountFlagBits

Native field depthStencilAttachmentSamples.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its canonical sType tag and default native state.

set_color_attachment_count

Method

pub fn set_color_attachment_count(self, value: u32) -> Self

Set native count colorAttachmentCount directly without checking associated pointer extents. Use the borrowed array helpers to derive matching storage and counts together. Direct count edits support null-query/dynamic-state paths and remain a native-call validity obligation, including after earlier borrowed setters.

set_color_attachment_samples

Method

pub fn set_color_attachment_samples( self, value: &'a [SampleCountFlagBits], ) -> Result<Self, ConstructionError>

Borrow pColorAttachmentSamples and set checked native count colorAttachmentCount. The borrow covers this storage only; nested raw pointers, format, alignment and asynchronous retention remain native-call obligations. Output storage must be initialized; returned sizes do not enlarge its capacity.

Errors

Returns a construction error if the length exceeds the native count width.

set_depth_stencil_attachment_samples

Method

pub fn set_depth_stencil_attachment_samples( self, value: SampleCountFlagBits, ) -> Self

Set native field depthStencilAttachmentSamples without native effects.

push_next

Method

pub fn push_next<T: Extends<Self>>( self, next: &'a mut T, ) -> Result<Self, ConstructionError>

Prepend one registry-compatible node, retaining its exclusive borrow.

The node must have a null p_next and both headers must have canonical tags. Existing links are never traversed and remain written after the borrow ends. Type compatibility does not establish enabled extensions or Vulkan valid usage.

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentSampleLocationsEXT

pub struct AttachmentSampleLocationsEXT<'a> {
    pub attachment_index: u32,
    pub sample_locations_info: SampleLocationsInfoEXT<'a>,
    /* private fields */
}

Native structure VkAttachmentSampleLocationsEXT.

Contract

Native structure VkAttachmentSampleLocationsEXT.

Khronos reference: VkAttachmentSampleLocationsEXT

Fields

attachment_index

Field

attachment_index: u32

Native field attachmentIndex.

sample_locations_info

Field

sample_locations_info: SampleLocationsInfoEXT<'a>

Native field sampleLocationsInfo.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_attachment_index

Method

pub fn set_attachment_index(self, value: u32) -> Self

Set native field attachmentIndex without native effects.

set_sample_locations_info

Method

pub fn set_sample_locations_info( self, value: SampleLocationsInfoEXT<'a>, ) -> Self

Set native field sampleLocationsInfo without native effects.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::AttachmentStoreOp

#[repr(transparent)]pub struct AttachmentStoreOp(pub i32);

Open integer representation of VkAttachmentStoreOp.

Contract

Open integer representation of VkAttachmentStoreOp.

Khronos reference: VkAttachmentStoreOp

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

STORE

Method

pub const STORE: Self

Native value VK_ATTACHMENT_STORE_OP_STORE.

Khronos reference: VK_ATTACHMENT_STORE_OP_STORE

DONT_CARE

Method

pub const DONT_CARE: Self

Native value VK_ATTACHMENT_STORE_OP_DONT_CARE.

Khronos reference: VK_ATTACHMENT_STORE_OP_DONT_CARE

NONE

Method

pub const NONE: Self

Native value VK_ATTACHMENT_STORE_OP_NONE.

Khronos reference: VK_ATTACHMENT_STORE_OP_NONE

NONE_KHR

Method

pub const NONE_KHR: Self

Native value VK_ATTACHMENT_STORE_OP_NONE_KHR.

Khronos reference: VK_ATTACHMENT_STORE_OP_NONE_KHR

NONE_QCOM

Method

pub const NONE_QCOM: Self

Native value VK_ATTACHMENT_STORE_OP_NONE_QCOM.

Khronos reference: VK_ATTACHMENT_STORE_OP_NONE_QCOM

NONE_EXT

Method

pub const NONE_EXT: Self

Native value VK_ATTACHMENT_STORE_OP_NONE_EXT.

Khronos reference: VK_ATTACHMENT_STORE_OP_NONE_EXT

from_raw

Method

pub const fn from_raw(value: i32) -> Self

No public source comment is attached to this declaration.

as_raw

Method

pub const fn as_raw(self) -> i32

No public source comment is attached to this declaration.

empty

Method

pub const fn empty() -> Self

No public source comment is attached to this declaration.

clone

Method

fn clone(&self) -> AttachmentStoreOp

Returns a duplicate of the value. Read more

fmt

Method

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

Formats the value using the given formatter. Read more

default

Method

fn default() -> AttachmentStoreOp

Returns the “default value” for a type. Read more

hash

Method

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

Feeds this value into the given Hasher. Read more

eq

Method

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

Tests for self and other values to be equal, and is used by ==.