Realm

vk · Structs · S17

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

StRustExperimental

Stvk::SurfaceCounterFlagBitsEXT

Contract

Open integer representation of VkSurfaceCounterFlagBitsEXT.

Khronos reference: VkSurfaceCounterFlagBitsEXT

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::SurfaceCreateFlagsOHOS

Contract

Open integer representation of VkSurfaceCreateFlagsOHOS.

Khronos reference: VkSurfaceCreateFlagsOHOS

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::SurfaceCreateInfoOHOS

pub struct SurfaceCreateInfoOHOS<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: SurfaceCreateFlagsOHOS, pub window: *mut OHNativeWindow, /* private fields */ }
Native structure VkSurfaceCreateInfoOHOS.

Contract

Native structure VkSurfaceCreateInfoOHOS.

Khronos reference: VkSurfaceCreateInfoOHOS

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: SurfaceCreateFlagsOHOS

Native field flags.

window

Field
window: *mut OHNativeWindow

Native field window.

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

Set native field flags without native effects.

set_window

Method
pub unsafe fn set_window(self, value: *mut OHNativeWindow) -> Self

Set native pointer window 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.

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

pub struct SurfaceFormat2KHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub surface_format: SurfaceFormatKHR, /* private fields */ }
Native structure VkSurfaceFormat2KHR.

Contract

Native structure VkSurfaceFormat2KHR.

Khronos reference: VkSurfaceFormat2KHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

surface_format

Field
surface_format: SurfaceFormatKHR

Native field surfaceFormat.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_surface_format

Method
pub fn set_surface_format(self, value: SurfaceFormatKHR) -> Self

Set native field surfaceFormat 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::SurfaceFormatKHR

Contract

Native structure VkSurfaceFormatKHR.

Khronos reference: VkSurfaceFormatKHR

Fields

format

Field
format: Format

Native field format.

color_space

Field
color_space: ColorSpaceKHR

Native field colorSpace.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_format

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

Set native field format without native effects.

set_color_space

Method
pub fn set_color_space(self, value: ColorSpaceKHR) -> Self

Set native field colorSpace without native effects.

Stvk::SurfaceFullScreenExclusiveInfoEXT

pub struct SurfaceFullScreenExclusiveInfoEXT<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub full_screen_exclusive: FullScreenExclusiveEXT, /* private fields */ }
Native structure VkSurfaceFullScreenExclusiveInfoEXT.

Contract

Native structure VkSurfaceFullScreenExclusiveInfoEXT.

Khronos reference: VkSurfaceFullScreenExclusiveInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

full_screen_exclusive

Field
full_screen_exclusive: FullScreenExclusiveEXT

Native field fullScreenExclusive.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_full_screen_exclusive

Method
pub fn set_full_screen_exclusive(self, value: FullScreenExclusiveEXT) -> Self

Set native field fullScreenExclusive 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::SurfaceFullScreenExclusiveWin32InfoEXT

pub struct SurfaceFullScreenExclusiveWin32InfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub hmonitor: HMONITOR, /* private fields */ }
Native structure VkSurfaceFullScreenExclusiveWin32InfoEXT.

Contract

Native structure VkSurfaceFullScreenExclusiveWin32InfoEXT.

Khronos reference: VkSurfaceFullScreenExclusiveWin32InfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

hmonitor

Field
hmonitor: HMONITOR

Native field hmonitor.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_hmonitor

Method
pub fn set_hmonitor(self, value: HMONITOR) -> Self

Set native field hmonitor 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::SurfaceKHR

Contract

Raw Vulkan handle VkSurfaceKHR.

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

Stvk::SurfacePresentModeCompatibilityKHR

pub struct SurfacePresentModeCompatibilityKHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub present_mode_count: u32, pub p_present_modes: *mut PresentModeKHR, /* private fields */ }
Native structure VkSurfacePresentModeCompatibilityKHR.

Contract

Native structure VkSurfacePresentModeCompatibilityKHR.

Khronos reference: VkSurfacePresentModeCompatibilityKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

present_mode_count

Field
present_mode_count: u32

Native field presentModeCount.

p_present_modes

Field
p_present_modes: *mut PresentModeKHR

Native field pPresentModes.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_present_mode_count

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

Set native count presentModeCount 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_present_modes

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

Borrow pPresentModes and set checked native count presentModeCount. 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::SurfacePresentModeKHR

pub struct SurfacePresentModeKHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub present_mode: PresentModeKHR, /* private fields */ }
Native structure VkSurfacePresentModeKHR.

Contract

Native structure VkSurfacePresentModeKHR.

Khronos reference: VkSurfacePresentModeKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

present_mode

Field
present_mode: PresentModeKHR

Native field presentMode.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_present_mode

Method
pub fn set_present_mode(self, value: PresentModeKHR) -> Self

Set native field presentMode 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::SurfacePresentScalingCapabilitiesKHR

pub struct SurfacePresentScalingCapabilitiesKHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub supported_present_scaling: PresentScalingFlagsKHR, pub supported_present_gravity_x: PresentGravityFlagsKHR, pub supported_present_gravity_y: PresentGravityFlagsKHR, pub min_scaled_image_extent: Extent2D, pub max_scaled_image_extent: Extent2D, /* private fields */ }
Native structure VkSurfacePresentScalingCapabilitiesKHR.

Contract

Native structure VkSurfacePresentScalingCapabilitiesKHR.

Khronos reference: VkSurfacePresentScalingCapabilitiesKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

supported_present_scaling

Field
supported_present_scaling: PresentScalingFlagsKHR

Native field supportedPresentScaling.

supported_present_gravity_x

Field
supported_present_gravity_x: PresentGravityFlagsKHR

Native field supportedPresentGravityX.

supported_present_gravity_y

Field
supported_present_gravity_y: PresentGravityFlagsKHR

Native field supportedPresentGravityY.

min_scaled_image_extent

Field
min_scaled_image_extent: Extent2D

Native field minScaledImageExtent.

max_scaled_image_extent

Field
max_scaled_image_extent: Extent2D

Native field maxScaledImageExtent.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_supported_present_scaling

Method
pub fn set_supported_present_scaling( self, value: PresentScalingFlagsKHR, ) -> Self

Set native field supportedPresentScaling without native effects.

set_supported_present_gravity_x

Method
pub fn set_supported_present_gravity_x( self, value: PresentGravityFlagsKHR, ) -> Self

Set native field supportedPresentGravityX without native effects.

set_supported_present_gravity_y

Method
pub fn set_supported_present_gravity_y( self, value: PresentGravityFlagsKHR, ) -> Self

Set native field supportedPresentGravityY without native effects.

set_min_scaled_image_extent

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

Set native field minScaledImageExtent without native effects.

set_max_scaled_image_extent

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

Set native field maxScaledImageExtent 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::SurfaceProtectedCapabilitiesKHR

pub struct SurfaceProtectedCapabilitiesKHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub supports_protected: Bool32, /* private fields */ }
Native structure VkSurfaceProtectedCapabilitiesKHR.

Contract

Native structure VkSurfaceProtectedCapabilitiesKHR.

Khronos reference: VkSurfaceProtectedCapabilitiesKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

supports_protected

Field
supports_protected: Bool32

Native field supportsProtected.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_supports_protected

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

Set native field supportsProtected 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::SurfaceTransformFlagBitsKHR

Contract

Open integer representation of VkSurfaceTransformFlagBitsKHR.

Khronos reference: VkSurfaceTransformFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::SwapchainCalibratedTimestampInfoEXT

pub struct SwapchainCalibratedTimestampInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub swapchain: SwapchainKHR, pub present_stage: PresentStageFlagsEXT, pub time_domain_id: u64, /* private fields */ }
Native structure VkSwapchainCalibratedTimestampInfoEXT.

Contract

Native structure VkSwapchainCalibratedTimestampInfoEXT.

Khronos reference: VkSwapchainCalibratedTimestampInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

swapchain

Field
swapchain: SwapchainKHR

Native field swapchain.

present_stage

Field
present_stage: PresentStageFlagsEXT

Native field presentStage.

time_domain_id

Field
time_domain_id: u64

Native field timeDomainId.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_swapchain

Method
pub fn set_swapchain(self, value: SwapchainKHR) -> Self

Set native field swapchain without native effects.

set_present_stage

Method
pub fn set_present_stage(self, value: PresentStageFlagsEXT) -> Self

Set native field presentStage without native effects.

set_time_domain_id

Method
pub fn set_time_domain_id(self, value: u64) -> Self

Set native field timeDomainId 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::SwapchainCounterCreateInfoEXT

pub struct SwapchainCounterCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub surface_counters: SurfaceCounterFlagsEXT, /* private fields */ }
Native structure VkSwapchainCounterCreateInfoEXT.

Contract

Native structure VkSwapchainCounterCreateInfoEXT.

Khronos reference: VkSwapchainCounterCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

surface_counters

Field
surface_counters: SurfaceCounterFlagsEXT

Native field surfaceCounters.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_surface_counters

Method
pub fn set_surface_counters(self, value: SurfaceCounterFlagsEXT) -> Self

Set native field surfaceCounters 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::SwapchainCreateFlagBitsKHR

Contract

Open integer representation of VkSwapchainCreateFlagBitsKHR.

Khronos reference: VkSwapchainCreateFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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