Realm

vk · Structs · I4

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

StRustExperimental

Stvk::ImageTilingControlEXT

Contract

Open integer representation of VkImageTilingControlEXT.

Khronos reference: VkImageTilingControlEXT

Fields

0

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

Methods and associated items

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

eq

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

Stvk::ImageToMemoryCopy

pub struct ImageToMemoryCopy<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub p_host_pointer: *mut c_void, pub memory_row_length: u32, pub memory_image_height: u32, pub image_subresource: ImageSubresourceLayers, pub image_offset: Offset3D, pub image_extent: Extent3D, /* private fields */ }
Native structure VkImageToMemoryCopy.

Contract

Native structure VkImageToMemoryCopy.

Khronos reference: VkImageToMemoryCopy

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

p_host_pointer

Field
p_host_pointer: *mut c_void

Native field pHostPointer.

memory_row_length

Field
memory_row_length: u32

Native field memoryRowLength.

memory_image_height

Field
memory_image_height: u32

Native field memoryImageHeight.

image_subresource

Field
image_subresource: ImageSubresourceLayers

Native field imageSubresource.

image_offset

Field
image_offset: Offset3D

Native field imageOffset.

image_extent

Field
image_extent: Extent3D

Native field imageExtent.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_host_pointer

Method
pub unsafe fn set_host_pointer(self, value: *mut c_void) -> Self

Set native pointer pHostPointer explicitly. No borrow or extent is inferred.

Safety

The caller must establish pointee validity, extent, alignment, aliasing and the full native retention lifetime before using this record in a native call. Callback, external-object and nested-pointer contracts remain caller obligations.

set_memory_row_length

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

Set native field memoryRowLength without native effects.

set_memory_image_height

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

Set native field memoryImageHeight without native effects.

set_image_subresource

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

Set native field imageSubresource without native effects.

set_image_offset

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

Set native field imageOffset without native effects.

set_image_extent

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

Set native field imageExtent 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::ImageType

Contract

Open integer representation of VkImageType.

Khronos reference: VkImageType

Fields

0

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

Methods and associated items

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.

fmt

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

eq

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

Stvk::ImageUsageFlagBits

Contract

Open integer representation of VkImageUsageFlagBits.

Khronos reference: VkImageUsageFlagBits

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

Output-1

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

Output-2

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

Output-3

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

eq

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

Stvk::ImageUsageFlagBits2KHR

Contract

Open integer representation of VkImageUsageFlagBits2KHR.

Khronos reference: VkImageUsageFlagBits2KHR

Fields

0

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

Methods and associated items

from_raw

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

as_raw

Method
pub const fn as_raw(self) -> u64
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 = ImageUsageFlagBits2KHR
The resulting type after applying the & operator.

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ImageUsageFlags2CreateInfoKHR

pub struct ImageUsageFlags2CreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub usage: ImageUsageFlags2KHR, /* private fields */ }
Native structure VkImageUsageFlags2CreateInfoKHR.

Contract

Native structure VkImageUsageFlags2CreateInfoKHR.

Khronos reference: VkImageUsageFlags2CreateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

usage

Field
usage: ImageUsageFlags2KHR

Native field usage.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_usage

Method
pub fn set_usage(self, value: ImageUsageFlags2KHR) -> Self

Set native field usage 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::ImageView

Contract

Raw Vulkan handle VkImageView.

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

Stvk::ImageViewAddressPropertiesNVX

pub struct ImageViewAddressPropertiesNVX<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub device_address: DeviceAddress, pub size: DeviceSize, /* private fields */ }
Native structure VkImageViewAddressPropertiesNVX.

Contract

Native structure VkImageViewAddressPropertiesNVX.

Khronos reference: VkImageViewAddressPropertiesNVX

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

device_address

Field
device_address: DeviceAddress

Native field deviceAddress.

size

Field
size: DeviceSize

Native field size.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_device_address

Method
pub fn set_device_address(self, value: DeviceAddress) -> Self

Set native field deviceAddress without native effects.

set_size

Method
pub fn set_size(self, value: DeviceSize) -> Self

Set native field size 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::ImageViewASTCDecodeModeEXT

pub struct ImageViewASTCDecodeModeEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub decode_mode: Format, /* private fields */ }
Native structure VkImageViewASTCDecodeModeEXT.

Contract

Native structure VkImageViewASTCDecodeModeEXT.

Khronos reference: VkImageViewASTCDecodeModeEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

decode_mode

Field
decode_mode: Format

Native field decodeMode.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_decode_mode

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

Set native field decodeMode 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::ImageViewCaptureDescriptorDataInfoEXT

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

Contract

Native structure VkImageViewCaptureDescriptorDataInfoEXT.

Khronos reference: VkImageViewCaptureDescriptorDataInfoEXT

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.

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.

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::ImageViewCreateFlagBits

Contract

Open integer representation of VkImageViewCreateFlagBits.

Khronos reference: VkImageViewCreateFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ImageViewCreateInfo

pub struct ImageViewCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: ImageViewCreateFlags, pub image: Image, pub view_type: ImageViewType, pub format: Format, pub components: ComponentMapping, pub subresource_range: ImageSubresourceRange, /* private fields */ }
Native structure VkImageViewCreateInfo.

Contract

Native structure VkImageViewCreateInfo.

Khronos reference: VkImageViewCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: ImageViewCreateFlags

Native field flags.

image

Field
image: Image

Native field image.

view_type

Field
view_type: ImageViewType

Native field viewType.

format

Field
format: Format

Native field format.

components

Field
components: ComponentMapping

Native field components.

subresource_range

Field
subresource_range: ImageSubresourceRange

Native field subresourceRange.

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

Set native field flags without native effects.

set_image

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

Set native field image without native effects.

set_view_type

Method
pub fn set_view_type(self, value: ImageViewType) -> Self

Set native field viewType without native effects.

set_format

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

Set native field format without native effects.

set_components

Method
pub fn set_components(self, value: ComponentMapping) -> Self

Set native field components without native effects.

set_subresource_range

Method
pub fn set_subresource_range(self, value: ImageSubresourceRange) -> Self

Set native field subresourceRange 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::ImageViewHandleInfoNVX

pub struct ImageViewHandleInfoNVX<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub image_view: ImageView, pub descriptor_type: DescriptorType, pub sampler: Sampler, /* private fields */ }
Native structure VkImageViewHandleInfoNVX.

Contract

Native structure VkImageViewHandleInfoNVX.

Khronos reference: VkImageViewHandleInfoNVX

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.

descriptor_type

Field
descriptor_type: DescriptorType

Native field descriptorType.

sampler

Field
sampler: Sampler

Native field sampler.

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_descriptor_type

Method
pub fn set_descriptor_type(self, value: DescriptorType) -> Self

Set native field descriptorType without native effects.

set_sampler

Method
pub fn set_sampler(self, value: Sampler) -> Self

Set native field sampler 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::ImageViewMinLodCreateInfoEXT

pub struct ImageViewMinLodCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub min_lod: f32, /* private fields */ }
Native structure VkImageViewMinLodCreateInfoEXT.

Contract

Native structure VkImageViewMinLodCreateInfoEXT.

Khronos reference: VkImageViewMinLodCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

min_lod

Field
min_lod: f32

Native field minLod.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_min_lod

Method
pub fn set_min_lod(self, value: f32) -> Self

Set native field minLod 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::ImageViewSampleWeightCreateInfoQCOM

pub struct ImageViewSampleWeightCreateInfoQCOM<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub filter_center: Offset2D, pub filter_size: Extent2D, pub num_phases: u32, /* private fields */ }
Native structure VkImageViewSampleWeightCreateInfoQCOM.

Contract

Native structure VkImageViewSampleWeightCreateInfoQCOM.

Khronos reference: VkImageViewSampleWeightCreateInfoQCOM

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

filter_center

Field
filter_center: Offset2D

Native field filterCenter.

filter_size

Field
filter_size: Extent2D

Native field filterSize.

num_phases

Field
num_phases: u32

Native field numPhases.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_filter_center

Method
pub fn set_filter_center(self, value: Offset2D) -> Self

Set native field filterCenter without native effects.

set_filter_size

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

Set native field filterSize without native effects.

set_num_phases

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

Set native field numPhases 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::ImageViewSlicedCreateInfoEXT

pub struct ImageViewSlicedCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub slice_offset: u32, pub slice_count: u32, /* private fields */ }
Native structure VkImageViewSlicedCreateInfoEXT.

Contract

Native structure VkImageViewSlicedCreateInfoEXT.

Khronos reference: VkImageViewSlicedCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

slice_offset

Field
slice_offset: u32

Native field sliceOffset.

slice_count

Field
slice_count: u32

Native field sliceCount.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_slice_offset

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

Set native field sliceOffset without native effects.

set_slice_count

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

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