Realm

vk · Structs · P37

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

StRustExperimental

Stvk::PolygonMode

Contract

Open integer representation of VkPolygonMode.

Khronos reference: VkPolygonMode

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

default

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

eq

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

Stvk::PresentFrameTokenGGP

pub struct PresentFrameTokenGGP<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub frame_token: GgpFrameToken, /* private fields */ }
Native structure VkPresentFrameTokenGGP.

Contract

Native structure VkPresentFrameTokenGGP.

Khronos reference: VkPresentFrameTokenGGP

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

frame_token

Field
frame_token: GgpFrameToken

Native field frameToken.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_frame_token

Method
pub fn set_frame_token(self, value: GgpFrameToken) -> Self

Set native field frameToken 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::PresentGravityFlagBitsKHR

Contract

Open integer representation of VkPresentGravityFlagBitsKHR.

Khronos reference: VkPresentGravityFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::PresentId2KHR

pub struct PresentId2KHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub swapchain_count: u32, pub p_present_ids: *const u64, /* private fields */ }
Native structure VkPresentId2KHR.

Contract

Native structure VkPresentId2KHR.

Khronos reference: VkPresentId2KHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

swapchain_count

Field
swapchain_count: u32

Native field swapchainCount.

p_present_ids

Field
p_present_ids: *const u64

Native field pPresentIds.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_swapchain_count

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

Set native count swapchainCount 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_ids

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

Borrow pPresentIds and set checked native count swapchainCount. 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::PresentIdKHR

pub struct PresentIdKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub swapchain_count: u32, pub p_present_ids: *const u64, /* private fields */ }
Native structure VkPresentIdKHR.

Contract

Native structure VkPresentIdKHR.

Khronos reference: VkPresentIdKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

swapchain_count

Field
swapchain_count: u32

Native field swapchainCount.

p_present_ids

Field
p_present_ids: *const u64

Native field pPresentIds.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_swapchain_count

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

Set native count swapchainCount 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_ids

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

Borrow pPresentIds and set checked native count swapchainCount. 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::PresentInfoKHR

pub struct PresentInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub wait_semaphore_count: u32, pub p_wait_semaphores: *const Semaphore, pub swapchain_count: u32, pub p_swapchains: *const SwapchainKHR, pub p_image_indices: *const u32, pub p_results: *mut Result, /* private fields */ }
Native structure VkPresentInfoKHR.

Contract

Native structure VkPresentInfoKHR.

Khronos reference: VkPresentInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

wait_semaphore_count

Field
wait_semaphore_count: u32

Native field waitSemaphoreCount.

p_wait_semaphores

Field
p_wait_semaphores: *const Semaphore

Native field pWaitSemaphores.

swapchain_count

Field
swapchain_count: u32

Native field swapchainCount.

p_swapchains

Field
p_swapchains: *const SwapchainKHR

Native field pSwapchains.

p_image_indices

Field
p_image_indices: *const u32

Native field pImageIndices.

p_results

Field
p_results: *mut Result

Native field pResults.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_wait_semaphore_count

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

Set native count waitSemaphoreCount 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_wait_semaphores

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

Borrow pWaitSemaphores and set checked native count waitSemaphoreCount. 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_swapchain_count

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

Set native count swapchainCount 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_swapchains

Method
pub fn set_swapchains( self, swapchains: &'a [SwapchainKHR], image_indices: &'a [u32], results: Option<&'a mut [Result]>, ) -> Result<Self, ConstructionError>

Borrow parallel arrays sharing native swapchainCount. Optional arrays may be null. Mutable arrays retain exclusive borrows of initialized output storage. This checks lengths only; native valid usage and later raw edits remain caller obligations.

Errors

Returns a construction error for unequal lengths or native count overflow.

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

Contract

Open integer representation of VkPresentModeKHR.

Khronos reference: VkPresentModeKHR

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

default

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

eq

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

Stvk::PresentRegionKHR

Contract

Native structure VkPresentRegionKHR.

Khronos reference: VkPresentRegionKHR

Fields

rectangle_count

Field
rectangle_count: u32

Native field rectangleCount.

p_rectangles

Field
p_rectangles: *const RectLayerKHR

Native field pRectangles.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_rectangle_count

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

Set native count rectangleCount 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_rectangles

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

Borrow pRectangles and set checked native count rectangleCount. 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.

clone

Method
fn clone(&self) -> PresentRegionKHR<'a>
Returns a duplicate of the value. Read more

Stvk::PresentRegionsKHR

pub struct PresentRegionsKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub swapchain_count: u32, pub p_regions: *const PresentRegionKHR<'a>, /* private fields */ }
Native structure VkPresentRegionsKHR.

Contract

Native structure VkPresentRegionsKHR.

Khronos reference: VkPresentRegionsKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

swapchain_count

Field
swapchain_count: u32

Native field swapchainCount.

p_regions

Field
p_regions: *const PresentRegionKHR<'a>

Native field pRegions.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_swapchain_count

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

Set native count swapchainCount 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_regions

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

Borrow pRegions and set checked native count swapchainCount. 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::PresentScalingFlagBitsKHR

Contract

Open integer representation of VkPresentScalingFlagBitsKHR.

Khronos reference: VkPresentScalingFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::PresentStageFlagBitsEXT

Contract

Open integer representation of VkPresentStageFlagBitsEXT.

Khronos reference: VkPresentStageFlagBitsEXT

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::PresentStageTimeEXT

Contract

Native structure VkPresentStageTimeEXT.

Khronos reference: VkPresentStageTimeEXT

Fields

stage

Field
stage: PresentStageFlagsEXT

Native field stage.

time

Field
time: u64

Native field time.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_stage

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

Set native field stage without native effects.

set_time

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

Set native field time without native effects.

Stvk::PresentTimeGOOGLE

Contract

Native structure VkPresentTimeGOOGLE.

Khronos reference: VkPresentTimeGOOGLE

Fields

present_id

Field
present_id: u32

Native field presentID.

desired_present_time

Field
desired_present_time: u64

Native field desiredPresentTime.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_present_id

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

Set native field presentID without native effects.

set_desired_present_time

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

Set native field desiredPresentTime without native effects.

Stvk::PresentTimesInfoGOOGLE

pub struct PresentTimesInfoGOOGLE<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub swapchain_count: u32, pub p_times: *const PresentTimeGOOGLE, /* private fields */ }
Native structure VkPresentTimesInfoGOOGLE.

Contract

Native structure VkPresentTimesInfoGOOGLE.

Khronos reference: VkPresentTimesInfoGOOGLE

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

swapchain_count

Field
swapchain_count: u32

Native field swapchainCount.

p_times

Field
p_times: *const PresentTimeGOOGLE

Native field pTimes.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_swapchain_count

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

Set native count swapchainCount 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_times

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

Borrow pTimes and set checked native count swapchainCount. 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::PresentTimingInfoEXT

pub struct PresentTimingInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: PresentTimingInfoFlagsEXT, pub target_time: u64, pub time_domain_id: u64, pub present_stage_queries: PresentStageFlagsEXT, pub target_time_domain_present_stage: PresentStageFlagsEXT, /* private fields */ }
Native structure VkPresentTimingInfoEXT.

Contract

Native structure VkPresentTimingInfoEXT.

Khronos reference: VkPresentTimingInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: PresentTimingInfoFlagsEXT

Native field flags.

target_time

Field
target_time: u64

Native field targetTime.

time_domain_id

Field
time_domain_id: u64

Native field timeDomainId.

present_stage_queries

Field
present_stage_queries: PresentStageFlagsEXT

Native field presentStageQueries.

target_time_domain_present_stage

Field
target_time_domain_present_stage: PresentStageFlagsEXT

Native field targetTimeDomainPresentStage.

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

Set native field flags without native effects.

set_target_time

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

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

set_present_stage_queries

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

Set native field presentStageQueries without native effects.

set_target_time_domain_present_stage

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

Set native field targetTimeDomainPresentStage 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::PresentTimingInfoFlagBitsEXT

Contract

Open integer representation of VkPresentTimingInfoFlagBitsEXT.

Khronos reference: VkPresentTimingInfoFlagBitsEXT

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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