Realm

vk · Structs · R2

16 public declarations with native signatures and source-owned contracts.

StRustExperimental

Stvk::RenderingAreaInfo

pub struct RenderingAreaInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub view_mask: u32, pub color_attachment_count: u32, pub p_color_attachment_formats: *const Format, pub depth_attachment_format: Format, pub stencil_attachment_format: Format, /* private fields */ }
Native structure VkRenderingAreaInfo.

Contract

Native structure VkRenderingAreaInfo.

Khronos reference: VkRenderingAreaInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

view_mask

Field
view_mask: u32

Native field viewMask.

color_attachment_count

Field
color_attachment_count: u32

Native field colorAttachmentCount.

p_color_attachment_formats

Field
p_color_attachment_formats: *const Format

Native field pColorAttachmentFormats.

depth_attachment_format

Field
depth_attachment_format: Format

Native field depthAttachmentFormat.

stencil_attachment_format

Field
stencil_attachment_format: Format

Native field stencilAttachmentFormat.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_view_mask

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

Set native field viewMask without native effects.

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_formats

Method
pub fn set_color_attachment_formats( self, value: &'a [Format], ) -> Result<Self, ConstructionError>

Borrow pColorAttachmentFormats 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_attachment_format

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

Set native field depthAttachmentFormat without native effects.

set_stencil_attachment_format

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

Set native field stencilAttachmentFormat 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.

Stvk::RenderingAttachmentFlagBitsKHR

Contract

Open integer representation of VkRenderingAttachmentFlagBitsKHR.

Khronos reference: VkRenderingAttachmentFlagBitsKHR

Fields

0

Field
0: u32
No public source comment is attached to this declaration.

Methods and associated items

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 = RenderingAttachmentFlagBitsKHR
The resulting type after applying the & operator.

Output-1

Method
type Output = RenderingAttachmentFlagBitsKHR
The resulting type after applying the | operator.

Output-2

Method
type Output = RenderingAttachmentFlagBitsKHR
The resulting type after applying the ^ operator.

clone

Method
fn clone(&self) -> RenderingAttachmentFlagBitsKHR
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() -> RenderingAttachmentFlagBitsKHR
Returns the “default value” for a type. Read more

Output-3

Method
type Output = RenderingAttachmentFlagBitsKHR
The resulting type after applying the ! operator.

eq

Method
fn eq(&self, other: &RenderingAttachmentFlagBitsKHR) -> bool
Tests for self and other values to be equal, and is used by ==.

Stvk::RenderingAttachmentFlagsInfoKHR

pub struct RenderingAttachmentFlagsInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: RenderingAttachmentFlagsKHR, /* private fields */ }
Native structure VkRenderingAttachmentFlagsInfoKHR.

Contract

Native structure VkRenderingAttachmentFlagsInfoKHR.

Khronos reference: VkRenderingAttachmentFlagsInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: RenderingAttachmentFlagsKHR

Native field flags.

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: RenderingAttachmentFlagsKHR) -> Self

Set native field flags 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.

Stvk::RenderingAttachmentInfo

pub struct RenderingAttachmentInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub image_view: ImageView, pub image_layout: ImageLayout, pub resolve_mode: ResolveModeFlagBits, pub resolve_image_view: ImageView, pub resolve_image_layout: ImageLayout, pub load_op: AttachmentLoadOp, pub store_op: AttachmentStoreOp, pub clear_value: ClearValue, /* private fields */ }
Native structure VkRenderingAttachmentInfo.

Contract

Native structure VkRenderingAttachmentInfo.

Khronos reference: VkRenderingAttachmentInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

image_view

Field
image_view: ImageView

Native field imageView.

image_layout

Field
image_layout: ImageLayout

Native field imageLayout.

resolve_mode

Field
resolve_mode: ResolveModeFlagBits

Native field resolveMode.

resolve_image_view

Field
resolve_image_view: ImageView

Native field resolveImageView.

resolve_image_layout

Field
resolve_image_layout: ImageLayout

Native field resolveImageLayout.

load_op

Field
load_op: AttachmentLoadOp

Native field loadOp.

store_op

Field
store_op: AttachmentStoreOp

Native field storeOp.

clear_value

Field
clear_value: ClearValue

Native field clearValue.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_image_view

Method
pub fn set_image_view(self, value: ImageView) -> Self

Set native field imageView without native effects.

set_image_layout

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

Set native field imageLayout without native effects.

set_resolve_mode

Method
pub fn set_resolve_mode(self, value: ResolveModeFlagBits) -> Self

Set native field resolveMode without native effects.

set_resolve_image_view

Method
pub fn set_resolve_image_view(self, value: ImageView) -> Self

Set native field resolveImageView without native effects.

set_resolve_image_layout

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

Set native field resolveImageLayout 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_clear_value

Method
pub fn set_clear_value(self, value: ClearValue) -> Self

Set native field clearValue 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.

Stvk::RenderingAttachmentLocationInfo

pub struct RenderingAttachmentLocationInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub color_attachment_count: u32, pub p_color_attachment_locations: *const u32, /* private fields */ }
Native structure VkRenderingAttachmentLocationInfo.

Contract

Native structure VkRenderingAttachmentLocationInfo.

Khronos reference: VkRenderingAttachmentLocationInfo

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_locations

Field
p_color_attachment_locations: *const u32

Native field pColorAttachmentLocations.

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_locations

Method
pub fn set_color_attachment_locations( self, value: &'a [u32], ) -> Result<Self, ConstructionError>

Borrow pColorAttachmentLocations 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.

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.

Stvk::RenderingEndInfoKHR

Contract

Native structure VkRenderingEndInfoKHR.

Khronos reference: VkRenderingEndInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

Methods and associated items

new

Method
pub fn new() -> Self

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

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.

Stvk::RenderingFlagBits

Contract

Open integer representation of VkRenderingFlagBits.

Khronos reference: VkRenderingFlagBits

Fields

0

Field
0: u32
No public source comment is attached to this declaration.

Methods and associated items

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 = RenderingFlagBits
The resulting type after applying the & operator.

Output-1

Method
type Output = RenderingFlagBits
The resulting type after applying the | operator.

Output-2

Method
type Output = RenderingFlagBits
The resulting type after applying the ^ operator.

fmt

Method
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more

default

Method
fn default() -> RenderingFlagBits
Returns the “default value” for a type. Read more

Output-3

Method
type Output = RenderingFlagBits
The resulting type after applying the ! operator.

eq

Method
fn eq(&self, other: &RenderingFlagBits) -> bool
Tests for self and other values to be equal, and is used by ==.

Stvk::RenderingFragmentDensityMapAttachmentInfoEXT

pub struct RenderingFragmentDensityMapAttachmentInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub image_view: ImageView, pub image_layout: ImageLayout, /* private fields */ }
Native structure VkRenderingFragmentDensityMapAttachmentInfoEXT.

Contract

Native structure VkRenderingFragmentDensityMapAttachmentInfoEXT.

Khronos reference: VkRenderingFragmentDensityMapAttachmentInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

image_view

Field
image_view: ImageView

Native field imageView.

image_layout

Field
image_layout: ImageLayout

Native field imageLayout.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_image_view

Method
pub fn set_image_view(self, value: ImageView) -> Self

Set native field imageView without native effects.

set_image_layout

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

Set native field imageLayout 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.

Stvk::RenderingFragmentShadingRateAttachmentInfoKHR

pub struct RenderingFragmentShadingRateAttachmentInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub image_view: ImageView, pub image_layout: ImageLayout, pub shading_rate_attachment_texel_size: Extent2D, /* private fields */ }
Native structure VkRenderingFragmentShadingRateAttachmentInfoKHR.

Contract

Native structure VkRenderingFragmentShadingRateAttachmentInfoKHR.

Khronos reference: VkRenderingFragmentShadingRateAttachmentInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

image_view

Field
image_view: ImageView

Native field imageView.

image_layout

Field
image_layout: ImageLayout

Native field imageLayout.

shading_rate_attachment_texel_size

Field
shading_rate_attachment_texel_size: Extent2D

Native field shadingRateAttachmentTexelSize.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_image_view

Method
pub fn set_image_view(self, value: ImageView) -> Self

Set native field imageView without native effects.

set_image_layout

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

Set native field imageLayout without native effects.

set_shading_rate_attachment_texel_size

Method
pub fn set_shading_rate_attachment_texel_size(self, value: Extent2D) -> Self

Set native field shadingRateAttachmentTexelSize 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.

Stvk::RenderingInfo

pub struct RenderingInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: RenderingFlags, pub render_area: Rect2D, pub layer_count: u32, pub view_mask: u32, pub color_attachment_count: u32, pub p_color_attachments: *const RenderingAttachmentInfo<'a>, pub p_depth_attachment: *const RenderingAttachmentInfo<'a>, pub p_stencil_attachment: *const RenderingAttachmentInfo<'a>, /* private fields */ }
Native structure VkRenderingInfo.

Contract

Native structure VkRenderingInfo.

Khronos reference: VkRenderingInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: RenderingFlags

Native field flags.

render_area

Field
render_area: Rect2D

Native field renderArea.

layer_count

Field
layer_count: u32

Native field layerCount.

view_mask

Field
view_mask: u32

Native field viewMask.

color_attachment_count

Field
color_attachment_count: u32

Native field colorAttachmentCount.

p_color_attachments

Field
p_color_attachments: *const RenderingAttachmentInfo<'a>

Native field pColorAttachments.

p_depth_attachment

Field
p_depth_attachment: *const RenderingAttachmentInfo<'a>

Native field pDepthAttachment.

p_stencil_attachment

Field
p_stencil_attachment: *const RenderingAttachmentInfo<'a>

Native field pStencilAttachment.

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: RenderingFlags) -> Self

Set native field flags without native effects.

set_render_area

Method
pub fn set_render_area(self, value: Rect2D) -> Self

Set native field renderArea without native effects.

set_layer_count

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

Set native field layerCount without native effects.

set_view_mask

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

Set native field viewMask without native effects.

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_attachments

Method
pub fn set_color_attachments( self, value: &'a [RenderingAttachmentInfo<'a>], ) -> Result<Self, ConstructionError>

Borrow pColorAttachments 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_attachment

Method
pub fn set_depth_attachment( self, value: &'a RenderingAttachmentInfo<'a>, ) -> Self

Set native field pDepthAttachment without native effects.

set_stencil_attachment

Method
pub fn set_stencil_attachment( self, value: &'a RenderingAttachmentInfo<'a>, ) -> Self

Set native field pStencilAttachment 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.

Stvk::RenderingInputAttachmentIndexInfo

pub struct RenderingInputAttachmentIndexInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub color_attachment_count: u32, pub p_color_attachment_input_indices: *const u32, pub p_depth_input_attachment_index: *const u32, pub p_stencil_input_attachment_index: *const u32, /* private fields */ }
Native structure VkRenderingInputAttachmentIndexInfo.

Contract

Native structure VkRenderingInputAttachmentIndexInfo.

Khronos reference: VkRenderingInputAttachmentIndexInfo

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_input_indices

Field
p_color_attachment_input_indices: *const u32

Native field pColorAttachmentInputIndices.

p_depth_input_attachment_index

Field
p_depth_input_attachment_index: *const u32

Native field pDepthInputAttachmentIndex.

p_stencil_input_attachment_index

Field
p_stencil_input_attachment_index: *const u32

Native field pStencilInputAttachmentIndex.

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_input_indices

Method
pub fn set_color_attachment_input_indices( self, value: &'a [u32], ) -> Result<Self, ConstructionError>

Borrow pColorAttachmentInputIndices 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_input_attachment_index

Method
pub fn set_depth_input_attachment_index(self, value: &'a u32) -> Self

Set native field pDepthInputAttachmentIndex without native effects.

set_stencil_input_attachment_index

Method
pub fn set_stencil_input_attachment_index(self, value: &'a u32) -> Self

Set native field pStencilInputAttachmentIndex 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.

Stvk::RenderPass

Contract

Raw Vulkan handle VkRenderPass.

Khronos reference: VkRenderPass Calls using this identity must satisfy Vulkan lifetime and synchronization rules.

Fields

0

Field
0: u64
No public source comment is attached to this declaration.

Methods and associated items

NULL

Method
pub const NULL: Self
No public source comment is attached to this declaration.

is_null

Method
pub fn is_null(self) -> bool
No public source comment is attached to this declaration.

from_raw

Method
pub fn from_raw(value: u64) -> Self
No public source comment is attached to this declaration.

as_raw

Method
pub fn as_raw(self) -> u64
No public source comment is attached to this declaration.

fmt

Method
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more

eq

Method
fn eq(&self, other: &RenderPass) -> bool
Tests for self and other values to be equal, and is used by ==.

Stvk::RenderPassAttachmentBeginInfo

pub struct RenderPassAttachmentBeginInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub attachment_count: u32, pub p_attachments: *const ImageView, /* private fields */ }
Native structure VkRenderPassAttachmentBeginInfo.

Contract

Native structure VkRenderPassAttachmentBeginInfo.

Khronos reference: VkRenderPassAttachmentBeginInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

attachment_count

Field
attachment_count: u32

Native field attachmentCount.

p_attachments

Field
p_attachments: *const ImageView

Native field pAttachments.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_attachment_count

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

Set native count attachmentCount 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_attachments

Method
pub fn set_attachments( self, value: &'a [ImageView], ) -> Result<Self, ConstructionError>

Borrow pAttachments and set checked native count attachmentCount. 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.

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.

Stvk::RenderPassBeginInfo

pub struct RenderPassBeginInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub render_pass: RenderPass, pub framebuffer: Framebuffer, pub render_area: Rect2D, pub clear_value_count: u32, pub p_clear_values: *const ClearValue, /* private fields */ }
Native structure VkRenderPassBeginInfo.

Contract

Native structure VkRenderPassBeginInfo.

Khronos reference: VkRenderPassBeginInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

render_pass

Field
render_pass: RenderPass

Native field renderPass.

framebuffer

Field
framebuffer: Framebuffer

Native field framebuffer.

render_area

Field
render_area: Rect2D

Native field renderArea.

clear_value_count

Field
clear_value_count: u32

Native field clearValueCount.

p_clear_values

Field
p_clear_values: *const ClearValue

Native field pClearValues.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_render_pass

Method
pub fn set_render_pass(self, value: RenderPass) -> Self

Set native field renderPass without native effects.

set_framebuffer

Method
pub fn set_framebuffer(self, value: Framebuffer) -> Self

Set native field framebuffer without native effects.

set_render_area

Method
pub fn set_render_area(self, value: Rect2D) -> Self

Set native field renderArea without native effects.

set_clear_value_count

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

Set native count clearValueCount 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_clear_values

Method
pub fn set_clear_values( self, value: &'a [ClearValue], ) -> Result<Self, ConstructionError>

Borrow pClearValues and set checked native count clearValueCount. 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.

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.

Stvk::RenderPassCreateFlagBits

Contract

Open integer representation of VkRenderPassCreateFlagBits.

Khronos reference: VkRenderPassCreateFlagBits

Fields

0

Field
0: u32
No public source comment is attached to this declaration.

Methods and associated items

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 = RenderPassCreateFlagBits
The resulting type after applying the & operator.

Output-1

Method
type Output = RenderPassCreateFlagBits
The resulting type after applying the | operator.

Output-2

Method
type Output = RenderPassCreateFlagBits
The resulting type after applying the ^ operator.

clone

Method
fn clone(&self) -> RenderPassCreateFlagBits
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() -> RenderPassCreateFlagBits
Returns the “default value” for a type. Read more

Output-3

Method
type Output = RenderPassCreateFlagBits
The resulting type after applying the ! operator.

eq

Method
fn eq(&self, other: &RenderPassCreateFlagBits) -> bool
Tests for self and other values to be equal, and is used by ==.

Stvk::RenderPassCreateInfo

pub struct RenderPassCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: RenderPassCreateFlags, pub attachment_count: u32, pub p_attachments: *const AttachmentDescription, pub subpass_count: u32, pub p_subpasses: *const SubpassDescription<'a>, pub dependency_count: u32, pub p_dependencies: *const SubpassDependency, /* private fields */ }
Native structure VkRenderPassCreateInfo.

Contract

Native structure VkRenderPassCreateInfo.

Khronos reference: VkRenderPassCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: RenderPassCreateFlags

Native field flags.

attachment_count

Field
attachment_count: u32

Native field attachmentCount.

p_attachments

Field
p_attachments: *const AttachmentDescription

Native field pAttachments.

subpass_count

Field
subpass_count: u32

Native field subpassCount.

p_subpasses

Field
p_subpasses: *const SubpassDescription<'a>

Native field pSubpasses.

dependency_count

Field
dependency_count: u32

Native field dependencyCount.

p_dependencies

Field
p_dependencies: *const SubpassDependency

Native field pDependencies.

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: RenderPassCreateFlags) -> Self

Set native field flags without native effects.

set_attachment_count

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

Set native count attachmentCount 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_attachments

Method
pub fn set_attachments( self, value: &'a [AttachmentDescription], ) -> Result<Self, ConstructionError>

Borrow pAttachments and set checked native count attachmentCount. 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_subpass_count

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

Set native count subpassCount 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_subpasses

Method
pub fn set_subpasses( self, value: &'a [SubpassDescription<'a>], ) -> Result<Self, ConstructionError>

Borrow pSubpasses and set checked native count subpassCount. 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_dependency_count

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

Set native count dependencyCount 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_dependencies

Method
pub fn set_dependencies( self, value: &'a [SubpassDependency], ) -> Result<Self, ConstructionError>

Borrow pDependencies and set checked native count dependencyCount. 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.

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.