Realm

vk · Structs · F1

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

StRustExperimental

Stvk::Fence

Contract

Raw Vulkan handle VkFence.

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

Stvk::FenceCreateFlagBits

Contract

Open integer representation of VkFenceCreateFlagBits.

Khronos reference: VkFenceCreateFlagBits

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

Output-1

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

Output-2

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

Output-3

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

eq

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

Stvk::FenceCreateInfo

Contract

Native structure VkFenceCreateInfo.

Khronos reference: VkFenceCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: FenceCreateFlags

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: FenceCreateFlags) -> 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::FenceGetFdInfoKHR

pub struct FenceGetFdInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub fence: Fence, pub handle_type: ExternalFenceHandleTypeFlagBits, /* private fields */ }
Native structure VkFenceGetFdInfoKHR.

Contract

Native structure VkFenceGetFdInfoKHR.

Khronos reference: VkFenceGetFdInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

fence

Field
fence: Fence

Native field fence.

handle_type

Field
handle_type: ExternalFenceHandleTypeFlagBits

Native field handleType.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_fence

Method
pub fn set_fence(self, value: Fence) -> Self

Set native field fence without native effects.

set_handle_type

Method
pub fn set_handle_type(self, value: ExternalFenceHandleTypeFlagBits) -> Self

Set native field handleType 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::FenceGetWin32HandleInfoKHR

pub struct FenceGetWin32HandleInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub fence: Fence, pub handle_type: ExternalFenceHandleTypeFlagBits, /* private fields */ }
Native structure VkFenceGetWin32HandleInfoKHR.

Contract

Native structure VkFenceGetWin32HandleInfoKHR.

Khronos reference: VkFenceGetWin32HandleInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

fence

Field
fence: Fence

Native field fence.

handle_type

Field
handle_type: ExternalFenceHandleTypeFlagBits

Native field handleType.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_fence

Method
pub fn set_fence(self, value: Fence) -> Self

Set native field fence without native effects.

set_handle_type

Method
pub fn set_handle_type(self, value: ExternalFenceHandleTypeFlagBits) -> Self

Set native field handleType 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::FenceImportFlagBits

Contract

Open integer representation of VkFenceImportFlagBits.

Khronos reference: VkFenceImportFlagBits

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

Output-1

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

Output-2

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

Output-3

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

eq

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

Stvk::Filter

Contract

Open integer representation of VkFilter.

Khronos reference: VkFilter

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

Stvk::FilterCubicImageViewImageFormatPropertiesEXT

pub struct FilterCubicImageViewImageFormatPropertiesEXT<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub filter_cubic: Bool32, pub filter_cubic_minmax: Bool32, /* private fields */ }
Native structure VkFilterCubicImageViewImageFormatPropertiesEXT.

Contract

Native structure VkFilterCubicImageViewImageFormatPropertiesEXT.

Khronos reference: VkFilterCubicImageViewImageFormatPropertiesEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

filter_cubic

Field
filter_cubic: Bool32

Native field filterCubic.

filter_cubic_minmax

Field
filter_cubic_minmax: Bool32

Native field filterCubicMinmax.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_filter_cubic

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

Set native field filterCubic without native effects.

set_filter_cubic_minmax

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

Set native field filterCubicMinmax 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::FnEntry

pub struct FnEntry { pub create_instance: PFN_vkCreateInstance, pub get_instance_proc_addr: PFN_vkGetInstanceProcAddr, pub enumerate_instance_version: PFN_vkEnumerateInstanceVersion, pub enumerate_instance_layer_properties: PFN_vkEnumerateInstanceLayerProperties, pub enumerate_instance_extension_properties: PFN_vkEnumerateInstanceExtensionProperties, }
Cached nullable PFNs for Global dispatch.

Contract

Cached nullable PFNs for Global dispatch.

A resolved pointer does not establish enabled API, extension or feature state. Keep the native objects and supplying library alive while using these pointers.

Fields

Methods and associated items

new_from_resolver

Method
pub unsafe fn new_from_resolver( load: unsafe extern "system" fn(InstanceHandle, *const c_char) -> PFN_vkVoidFunction, ) -> Self

Load all commands for this dispatch level.

Safety

load must implement the Vulkan proc-addr contract and remain callable for the lifetime of this table and all derived raw function pointers.

Stvk::FormatFeatureFlagBits

Contract

Open integer representation of VkFormatFeatureFlagBits.

Khronos reference: VkFormatFeatureFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::FormatFeatureFlagBits4KHR

Contract

Open integer representation of VkFormatFeatureFlagBits4KHR.

Khronos reference: VkFormatFeatureFlagBits4KHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::FormatProperties

#[repr(C)]pub struct FormatProperties { pub linear_tiling_features: FormatFeatureFlags, pub optimal_tiling_features: FormatFeatureFlags, pub buffer_features: FormatFeatureFlags, }
Native structure VkFormatProperties.

Contract

Native structure VkFormatProperties.

Khronos reference: VkFormatProperties

Fields

linear_tiling_features

Field
linear_tiling_features: FormatFeatureFlags

Native field linearTilingFeatures.

optimal_tiling_features

Field
optimal_tiling_features: FormatFeatureFlags

Native field optimalTilingFeatures.

buffer_features

Field
buffer_features: FormatFeatureFlags

Native field bufferFeatures.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_linear_tiling_features

Method
pub fn set_linear_tiling_features(self, value: FormatFeatureFlags) -> Self

Set native field linearTilingFeatures without native effects.

set_optimal_tiling_features

Method
pub fn set_optimal_tiling_features(self, value: FormatFeatureFlags) -> Self

Set native field optimalTilingFeatures without native effects.

set_buffer_features

Method
pub fn set_buffer_features(self, value: FormatFeatureFlags) -> Self

Set native field bufferFeatures without native effects.

Stvk::FormatProperties2

pub struct FormatProperties2<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub format_properties: FormatProperties, /* private fields */ }
Native structure VkFormatProperties2.

Contract

Native structure VkFormatProperties2.

Khronos reference: VkFormatProperties2

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

format_properties

Field
format_properties: FormatProperties

Native field formatProperties.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_format_properties

Method
pub fn set_format_properties(self, value: FormatProperties) -> Self

Set native field formatProperties 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::FormatProperties3

pub struct FormatProperties3<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub linear_tiling_features: FormatFeatureFlags2, pub optimal_tiling_features: FormatFeatureFlags2, pub buffer_features: FormatFeatureFlags2, /* private fields */ }
Native structure VkFormatProperties3.

Contract

Native structure VkFormatProperties3.

Khronos reference: VkFormatProperties3

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

linear_tiling_features

Field
linear_tiling_features: FormatFeatureFlags2

Native field linearTilingFeatures.

optimal_tiling_features

Field
optimal_tiling_features: FormatFeatureFlags2

Native field optimalTilingFeatures.

buffer_features

Field
buffer_features: FormatFeatureFlags2

Native field bufferFeatures.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_linear_tiling_features

Method
pub fn set_linear_tiling_features(self, value: FormatFeatureFlags2) -> Self

Set native field linearTilingFeatures without native effects.

set_optimal_tiling_features

Method
pub fn set_optimal_tiling_features(self, value: FormatFeatureFlags2) -> Self

Set native field optimalTilingFeatures without native effects.

set_buffer_features

Method
pub fn set_buffer_features(self, value: FormatFeatureFlags2) -> Self

Set native field bufferFeatures 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::FormatProperties4KHR

pub struct FormatProperties4KHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub linear_tiling_features: FormatFeatureFlags4KHR, pub optimal_tiling_features: FormatFeatureFlags4KHR, pub buffer_features: FormatFeatureFlags4KHR, /* private fields */ }
Native structure VkFormatProperties4KHR.

Contract

Native structure VkFormatProperties4KHR.

Khronos reference: VkFormatProperties4KHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

linear_tiling_features

Field
linear_tiling_features: FormatFeatureFlags4KHR

Native field linearTilingFeatures.

optimal_tiling_features

Field
optimal_tiling_features: FormatFeatureFlags4KHR

Native field optimalTilingFeatures.

buffer_features

Field
buffer_features: FormatFeatureFlags4KHR

Native field bufferFeatures.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_linear_tiling_features

Method
pub fn set_linear_tiling_features(self, value: FormatFeatureFlags4KHR) -> Self

Set native field linearTilingFeatures without native effects.

set_optimal_tiling_features

Method
pub fn set_optimal_tiling_features(self, value: FormatFeatureFlags4KHR) -> Self

Set native field optimalTilingFeatures without native effects.

set_buffer_features

Method
pub fn set_buffer_features(self, value: FormatFeatureFlags4KHR) -> Self

Set native field bufferFeatures 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::FragmentShadingRateAttachmentInfoKHR

pub struct FragmentShadingRateAttachmentInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub p_fragment_shading_rate_attachment: *const AttachmentReference2<'a>, pub shading_rate_attachment_texel_size: Extent2D, /* private fields */ }
Native structure VkFragmentShadingRateAttachmentInfoKHR.

Contract

Native structure VkFragmentShadingRateAttachmentInfoKHR.

Khronos reference: VkFragmentShadingRateAttachmentInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

p_fragment_shading_rate_attachment

Field
p_fragment_shading_rate_attachment: *const AttachmentReference2<'a>

Native field pFragmentShadingRateAttachment.

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_fragment_shading_rate_attachment

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

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