Realm

vk · Structs · I1

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

StRustExperimental

Stvk::IDirectFB

Contract

Native type IDirectFB.

Khronos registry source: IDirectFB

Stvk::IDirectFBSurface

Contract

Native type IDirectFBSurface.

Khronos registry source: IDirectFBSurface

Stvk::Image

Contract

Raw Vulkan handle VkImage.

Khronos reference: VkImage 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: &Image) -> bool
Tests for self and other values to be equal, and is used by ==.

Stvk::ImageAlignmentControlCreateInfoMESA

pub struct ImageAlignmentControlCreateInfoMESA<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub maximum_requested_alignment: u32, /* private fields */ }
Native structure VkImageAlignmentControlCreateInfoMESA.

Contract

Native structure VkImageAlignmentControlCreateInfoMESA.

Khronos reference: VkImageAlignmentControlCreateInfoMESA

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

maximum_requested_alignment

Field
maximum_requested_alignment: u32

Native field maximumRequestedAlignment.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_maximum_requested_alignment

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

Set native field maximumRequestedAlignment 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::ImageAspectFlagBits

Contract

Open integer representation of VkImageAspectFlagBits.

Khronos reference: VkImageAspectFlagBits

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

Output-1

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

Output-2

Method
type Output = ImageAspectFlagBits
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() -> ImageAspectFlagBits
Returns the “default value” for a type. Read more

Output-3

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

eq

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

Stvk::ImageBlit

#[repr(C)]pub struct ImageBlit { pub src_subresource: ImageSubresourceLayers, pub src_offsets: [Offset3D; 2], pub dst_subresource: ImageSubresourceLayers, pub dst_offsets: [Offset3D; 2], }
Native structure VkImageBlit.

Contract

Native structure VkImageBlit.

Khronos reference: VkImageBlit

Fields

src_subresource

Field
src_subresource: ImageSubresourceLayers

Native field srcSubresource.

src_offsets

Field
src_offsets: [Offset3D; 2]

Native field srcOffsets.

dst_subresource

Field
dst_subresource: ImageSubresourceLayers

Native field dstSubresource.

dst_offsets

Field
dst_offsets: [Offset3D; 2]

Native field dstOffsets.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_src_subresource

Method
pub fn set_src_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field srcSubresource without native effects.

set_src_offsets

Method
pub fn set_src_offsets(self, value: [Offset3D; 2]) -> Self

Set native field srcOffsets without native effects.

set_dst_subresource

Method
pub fn set_dst_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field dstSubresource without native effects.

set_dst_offsets

Method
pub fn set_dst_offsets(self, value: [Offset3D; 2]) -> Self

Set native field dstOffsets without native effects.

Stvk::ImageBlit2

pub struct ImageBlit2<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub src_subresource: ImageSubresourceLayers, pub src_offsets: [Offset3D; 2], pub dst_subresource: ImageSubresourceLayers, pub dst_offsets: [Offset3D; 2], /* private fields */ }
Native structure VkImageBlit2.

Contract

Native structure VkImageBlit2.

Khronos reference: VkImageBlit2

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

src_subresource

Field
src_subresource: ImageSubresourceLayers

Native field srcSubresource.

src_offsets

Field
src_offsets: [Offset3D; 2]

Native field srcOffsets.

dst_subresource

Field
dst_subresource: ImageSubresourceLayers

Native field dstSubresource.

dst_offsets

Field
dst_offsets: [Offset3D; 2]

Native field dstOffsets.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_src_subresource

Method
pub fn set_src_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field srcSubresource without native effects.

set_src_offsets

Method
pub fn set_src_offsets(self, value: [Offset3D; 2]) -> Self

Set native field srcOffsets without native effects.

set_dst_subresource

Method
pub fn set_dst_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field dstSubresource without native effects.

set_dst_offsets

Method
pub fn set_dst_offsets(self, value: [Offset3D; 2]) -> Self

Set native field dstOffsets 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::ImageCaptureDescriptorDataInfoEXT

pub struct ImageCaptureDescriptorDataInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub image: Image, /* private fields */ }
Native structure VkImageCaptureDescriptorDataInfoEXT.

Contract

Native structure VkImageCaptureDescriptorDataInfoEXT.

Khronos reference: VkImageCaptureDescriptorDataInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

image

Field
image: Image

Native field image.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_image

Method
pub fn set_image(self, value: Image) -> Self

Set native field image 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::ImageCompressionControlEXT

pub struct ImageCompressionControlEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: ImageCompressionFlagsEXT, pub compression_control_plane_count: u32, pub p_fixed_rate_flags: *mut ImageCompressionFixedRateFlagsEXT, /* private fields */ }
Native structure VkImageCompressionControlEXT.

Contract

Native structure VkImageCompressionControlEXT.

Khronos reference: VkImageCompressionControlEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: ImageCompressionFlagsEXT

Native field flags.

compression_control_plane_count

Field
compression_control_plane_count: u32

Native field compressionControlPlaneCount.

p_fixed_rate_flags

Field
p_fixed_rate_flags: *mut ImageCompressionFixedRateFlagsEXT

Native field pFixedRateFlags.

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

Set native field flags without native effects.

set_compression_control_plane_count

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

Set native count compressionControlPlaneCount 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_fixed_rate_flags

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

Borrow pFixedRateFlags and set checked native count compressionControlPlaneCount. 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::ImageCompressionFixedRateFlagBitsEXT

Contract

Open integer representation of VkImageCompressionFixedRateFlagBitsEXT.

Khronos reference: VkImageCompressionFixedRateFlagBitsEXT

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ImageCompressionFlagBitsEXT

Contract

Open integer representation of VkImageCompressionFlagBitsEXT.

Khronos reference: VkImageCompressionFlagBitsEXT

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ImageCompressionPropertiesEXT

pub struct ImageCompressionPropertiesEXT<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub image_compression_flags: ImageCompressionFlagsEXT, pub image_compression_fixed_rate_flags: ImageCompressionFixedRateFlagsEXT, /* private fields */ }
Native structure VkImageCompressionPropertiesEXT.

Contract

Native structure VkImageCompressionPropertiesEXT.

Khronos reference: VkImageCompressionPropertiesEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

image_compression_flags

Field
image_compression_flags: ImageCompressionFlagsEXT

Native field imageCompressionFlags.

image_compression_fixed_rate_flags

Field
image_compression_fixed_rate_flags: ImageCompressionFixedRateFlagsEXT

Native field imageCompressionFixedRateFlags.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_image_compression_flags

Method
pub fn set_image_compression_flags( self, value: ImageCompressionFlagsEXT, ) -> Self

Set native field imageCompressionFlags without native effects.

set_image_compression_fixed_rate_flags

Method
pub fn set_image_compression_fixed_rate_flags( self, value: ImageCompressionFixedRateFlagsEXT, ) -> Self

Set native field imageCompressionFixedRateFlags 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::ImageConstraintsInfoFlagBitsFUCHSIA

Contract

Open integer representation of VkImageConstraintsInfoFlagBitsFUCHSIA.

Khronos reference: VkImageConstraintsInfoFlagBitsFUCHSIA

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ImageConstraintsInfoFUCHSIA

pub struct ImageConstraintsInfoFUCHSIA<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub format_constraints_count: u32, pub p_format_constraints: *const ImageFormatConstraintsInfoFUCHSIA<'a>, pub buffer_collection_constraints: BufferCollectionConstraintsInfoFUCHSIA<'a>, pub flags: ImageConstraintsInfoFlagsFUCHSIA, /* private fields */ }
Native structure VkImageConstraintsInfoFUCHSIA.

Contract

Native structure VkImageConstraintsInfoFUCHSIA.

Khronos reference: VkImageConstraintsInfoFUCHSIA

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

format_constraints_count

Field
format_constraints_count: u32

Native field formatConstraintsCount.

p_format_constraints

Field
p_format_constraints: *const ImageFormatConstraintsInfoFUCHSIA<'a>

Native field pFormatConstraints.

buffer_collection_constraints

Field
buffer_collection_constraints: BufferCollectionConstraintsInfoFUCHSIA<'a>

Native field bufferCollectionConstraints.

flags

Field
flags: ImageConstraintsInfoFlagsFUCHSIA

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_format_constraints_count

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

Set native count formatConstraintsCount 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_format_constraints

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

Borrow pFormatConstraints and set checked native count formatConstraintsCount. 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_buffer_collection_constraints

Method
pub fn set_buffer_collection_constraints( self, value: BufferCollectionConstraintsInfoFUCHSIA<'a>, ) -> Self

Set native field bufferCollectionConstraints without native effects.

set_flags

Method
pub fn set_flags(self, value: ImageConstraintsInfoFlagsFUCHSIA) -> 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::ImageCopy

#[repr(C)]pub struct ImageCopy { pub src_subresource: ImageSubresourceLayers, pub src_offset: Offset3D, pub dst_subresource: ImageSubresourceLayers, pub dst_offset: Offset3D, pub extent: Extent3D, }
Native structure VkImageCopy.

Contract

Native structure VkImageCopy.

Khronos reference: VkImageCopy

Fields

src_subresource

Field
src_subresource: ImageSubresourceLayers

Native field srcSubresource.

src_offset

Field
src_offset: Offset3D

Native field srcOffset.

dst_subresource

Field
dst_subresource: ImageSubresourceLayers

Native field dstSubresource.

dst_offset

Field
dst_offset: Offset3D

Native field dstOffset.

extent

Field
extent: Extent3D

Native field extent.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_src_subresource

Method
pub fn set_src_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field srcSubresource without native effects.

set_src_offset

Method
pub fn set_src_offset(self, value: Offset3D) -> Self

Set native field srcOffset without native effects.

set_dst_subresource

Method
pub fn set_dst_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field dstSubresource without native effects.

set_dst_offset

Method
pub fn set_dst_offset(self, value: Offset3D) -> Self

Set native field dstOffset without native effects.

set_extent

Method
pub fn set_extent(self, value: Extent3D) -> Self

Set native field extent without native effects.

Stvk::ImageCopy2

pub struct ImageCopy2<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub src_subresource: ImageSubresourceLayers, pub src_offset: Offset3D, pub dst_subresource: ImageSubresourceLayers, pub dst_offset: Offset3D, pub extent: Extent3D, /* private fields */ }
Native structure VkImageCopy2.

Contract

Native structure VkImageCopy2.

Khronos reference: VkImageCopy2

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

src_subresource

Field
src_subresource: ImageSubresourceLayers

Native field srcSubresource.

src_offset

Field
src_offset: Offset3D

Native field srcOffset.

dst_subresource

Field
dst_subresource: ImageSubresourceLayers

Native field dstSubresource.

dst_offset

Field
dst_offset: Offset3D

Native field dstOffset.

extent

Field
extent: Extent3D

Native field extent.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_src_subresource

Method
pub fn set_src_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field srcSubresource without native effects.

set_src_offset

Method
pub fn set_src_offset(self, value: Offset3D) -> Self

Set native field srcOffset without native effects.

set_dst_subresource

Method
pub fn set_dst_subresource(self, value: ImageSubresourceLayers) -> Self

Set native field dstSubresource without native effects.

set_dst_offset

Method
pub fn set_dst_offset(self, value: Offset3D) -> Self

Set native field dstOffset without native effects.

set_extent

Method
pub fn set_extent(self, value: Extent3D) -> Self

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