Realm

vk · Structs · D12

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

StRustExperimental

Stvk::DispatchIndirect2InfoKHR

pub struct DispatchIndirect2InfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub address_range: DeviceAddressRangeKHR, pub address_flags: AddressCommandFlagsKHR, /* private fields */ }
Native structure VkDispatchIndirect2InfoKHR.

Contract

Native structure VkDispatchIndirect2InfoKHR.

Khronos reference: VkDispatchIndirect2InfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

address_range

Field
address_range: DeviceAddressRangeKHR

Native field addressRange.

address_flags

Field
address_flags: AddressCommandFlagsKHR

Native field addressFlags.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_address_range

Method
pub fn set_address_range(self, value: DeviceAddressRangeKHR) -> Self

Set native field addressRange without native effects.

set_address_flags

Method
pub fn set_address_flags(self, value: AddressCommandFlagsKHR) -> Self

Set native field addressFlags 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::DispatchIndirectCommand

Contract

Native structure VkDispatchIndirectCommand.

Khronos reference: VkDispatchIndirectCommand

Fields

x

Field
x: u32

Native field x.

y

Field
y: u32

Native field y.

z

Field
z: u32

Native field z.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_x

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

Set native field x without native effects.

set_y

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

Set native field y without native effects.

set_z

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

Set native field z without native effects.

clone

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

Stvk::DispatchParametersARM

pub struct DispatchParametersARM<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub work_group_batch_size: u32, pub max_queued_work_group_batches: u32, pub max_warps_per_shader_core: u32, /* private fields */ }
Native structure VkDispatchParametersARM.

Contract

Native structure VkDispatchParametersARM.

Khronos reference: VkDispatchParametersARM

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

work_group_batch_size

Field
work_group_batch_size: u32

Native field workGroupBatchSize.

max_queued_work_group_batches

Field
max_queued_work_group_batches: u32

Native field maxQueuedWorkGroupBatches.

max_warps_per_shader_core

Field
max_warps_per_shader_core: u32

Native field maxWarpsPerShaderCore.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_work_group_batch_size

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

Set native field workGroupBatchSize without native effects.

set_max_queued_work_group_batches

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

Set native field maxQueuedWorkGroupBatches without native effects.

set_max_warps_per_shader_core

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

Set native field maxWarpsPerShaderCore 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::DispatchTileInfoQCOM

Contract

Native structure VkDispatchTileInfoQCOM.

Khronos reference: VkDispatchTileInfoQCOM

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

Methods and associated items

new

Method
pub fn new() -> Self

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

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

Contract

Open integer representation of VkDisplacementMicromapFormatNV.

Khronos reference: VkDisplacementMicromapFormatNV

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

eq

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

Stvk::Display

Contract

Native type Display.

Khronos registry source: Display

Stvk::DisplayEventInfoEXT

pub struct DisplayEventInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub display_event: DisplayEventTypeEXT, /* private fields */ }
Native structure VkDisplayEventInfoEXT.

Contract

Native structure VkDisplayEventInfoEXT.

Khronos reference: VkDisplayEventInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

display_event

Field
display_event: DisplayEventTypeEXT

Native field displayEvent.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_display_event

Method
pub fn set_display_event(self, value: DisplayEventTypeEXT) -> Self

Set native field displayEvent 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::DisplayEventTypeEXT

Contract

Open integer representation of VkDisplayEventTypeEXT.

Khronos reference: VkDisplayEventTypeEXT

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

eq

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

Stvk::DisplayKHR

Contract

Raw Vulkan handle VkDisplayKHR.

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

Stvk::DisplayModeCreateFlagsKHR

Contract

Open integer representation of VkDisplayModeCreateFlagsKHR.

Khronos reference: VkDisplayModeCreateFlagsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::DisplayModeCreateInfoKHR

pub struct DisplayModeCreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: DisplayModeCreateFlagsKHR, pub parameters: DisplayModeParametersKHR, /* private fields */ }
Native structure VkDisplayModeCreateInfoKHR.

Contract

Native structure VkDisplayModeCreateInfoKHR.

Khronos reference: VkDisplayModeCreateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: DisplayModeCreateFlagsKHR

Native field flags.

parameters

Field
parameters: DisplayModeParametersKHR

Native field parameters.

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

Set native field flags without native effects.

set_parameters

Method
pub fn set_parameters(self, value: DisplayModeParametersKHR) -> Self

Set native field parameters 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::DisplayModeKHR

Contract

Raw Vulkan handle VkDisplayModeKHR.

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

Stvk::DisplayModeParametersKHR

Contract

Native structure VkDisplayModeParametersKHR.

Khronos reference: VkDisplayModeParametersKHR

Fields

visible_region

Field
visible_region: Extent2D

Native field visibleRegion.

refresh_rate

Field
refresh_rate: u32

Native field refreshRate.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_visible_region

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

Set native field visibleRegion without native effects.

set_refresh_rate

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

Set native field refreshRate without native effects.

clone

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

Stvk::DisplayModeProperties2KHR

pub struct DisplayModeProperties2KHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub display_mode_properties: DisplayModePropertiesKHR, /* private fields */ }
Native structure VkDisplayModeProperties2KHR.

Contract

Native structure VkDisplayModeProperties2KHR.

Khronos reference: VkDisplayModeProperties2KHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

display_mode_properties

Field
display_mode_properties: DisplayModePropertiesKHR

Native field displayModeProperties.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_display_mode_properties

Method
pub fn set_display_mode_properties( self, value: DisplayModePropertiesKHR, ) -> Self

Set native field displayModeProperties 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::DisplayModePropertiesKHR

Contract

Native structure VkDisplayModePropertiesKHR.

Khronos reference: VkDisplayModePropertiesKHR

Fields

display_mode

Field
display_mode: DisplayModeKHR

Native field displayMode.

parameters

Field
parameters: DisplayModeParametersKHR

Native field parameters.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_display_mode

Method
pub fn set_display_mode(self, value: DisplayModeKHR) -> Self

Set native field displayMode without native effects.

set_parameters

Method
pub fn set_parameters(self, value: DisplayModeParametersKHR) -> Self

Set native field parameters without native effects.

clone

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

Stvk::DisplayModeStereoPropertiesNV

pub struct DisplayModeStereoPropertiesNV<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub hdmi3_d_supported: Bool32, /* private fields */ }
Native structure VkDisplayModeStereoPropertiesNV.

Contract

Native structure VkDisplayModeStereoPropertiesNV.

Khronos reference: VkDisplayModeStereoPropertiesNV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

hdmi3_d_supported

Field
hdmi3_d_supported: Bool32

Native field hdmi3DSupported.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_hdmi3_d_supported

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

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