Realm

vk · Structs · C4

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

StRustExperimental

Stvk::CommandPool

Contract

Raw Vulkan handle VkCommandPool.

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

Stvk::CommandPoolCreateFlagBits

Contract

Open integer representation of VkCommandPoolCreateFlagBits.

Khronos reference: VkCommandPoolCreateFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::CommandPoolCreateInfo

pub struct CommandPoolCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: CommandPoolCreateFlags, pub queue_family_index: u32, /* private fields */ }
Native structure VkCommandPoolCreateInfo.

Contract

Native structure VkCommandPoolCreateInfo.

Khronos reference: VkCommandPoolCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: CommandPoolCreateFlags

Native field flags.

queue_family_index

Field
queue_family_index: u32

Native field queueFamilyIndex.

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

Set native field flags without native effects.

set_queue_family_index

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

Set native field queueFamilyIndex 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::CommandPoolResetFlagBits

Contract

Open integer representation of VkCommandPoolResetFlagBits.

Khronos reference: VkCommandPoolResetFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::CommandPoolTrimFlags

Contract

Open integer representation of VkCommandPoolTrimFlags.

Khronos reference: VkCommandPoolTrimFlags

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::CompareOp

Contract

Open integer representation of VkCompareOp.

Khronos reference: VkCompareOp

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

Stvk::ComponentMapping

Contract

Native structure VkComponentMapping.

Khronos reference: VkComponentMapping

Fields

r

Field
r: ComponentSwizzle

Native field r.

g

Field
g: ComponentSwizzle

Native field g.

b

Field
b: ComponentSwizzle

Native field b.

a

Field
a: ComponentSwizzle

Native field a.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_r

Method
pub fn set_r(self, value: ComponentSwizzle) -> Self

Set native field r without native effects.

set_g

Method
pub fn set_g(self, value: ComponentSwizzle) -> Self

Set native field g without native effects.

set_b

Method
pub fn set_b(self, value: ComponentSwizzle) -> Self

Set native field b without native effects.

set_a

Method
pub fn set_a(self, value: ComponentSwizzle) -> Self

Set native field a without native effects.

Stvk::ComponentSwizzle

Contract

Open integer representation of VkComponentSwizzle.

Khronos reference: VkComponentSwizzle

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

eq

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

Stvk::ComponentTypeKHR

Contract

Open integer representation of VkComponentTypeKHR.

Khronos reference: VkComponentTypeKHR

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

eq

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

Stvk::CompositeAlphaFlagBitsKHR

Contract

Open integer representation of VkCompositeAlphaFlagBitsKHR.

Khronos reference: VkCompositeAlphaFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::CompressedTriangleFormatAMDX

Contract

Open integer representation of VkCompressedTriangleFormatAMDX.

Khronos reference: VkCompressedTriangleFormatAMDX

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

eq

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

Stvk::ComputeOccupancyPriorityParametersNV

pub struct ComputeOccupancyPriorityParametersNV<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub occupancy_priority: f32, pub occupancy_throttling: f32, /* private fields */ }
Native structure VkComputeOccupancyPriorityParametersNV.

Contract

Native structure VkComputeOccupancyPriorityParametersNV.

Khronos reference: VkComputeOccupancyPriorityParametersNV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

occupancy_priority

Field
occupancy_priority: f32

Native field occupancyPriority.

occupancy_throttling

Field
occupancy_throttling: f32

Native field occupancyThrottling.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_occupancy_priority

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

Set native field occupancyPriority without native effects.

set_occupancy_throttling

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

Set native field occupancyThrottling 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::ComputePipelineCreateInfo

pub struct ComputePipelineCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: PipelineCreateFlags, pub stage: PipelineShaderStageCreateInfo<'a>, pub layout: PipelineLayout, pub base_pipeline_handle: Pipeline, pub base_pipeline_index: i32, /* private fields */ }
Native structure VkComputePipelineCreateInfo.

Contract

Native structure VkComputePipelineCreateInfo.

Khronos reference: VkComputePipelineCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: PipelineCreateFlags

Native field flags.

stage

Field
stage: PipelineShaderStageCreateInfo<'a>

Native field stage.

layout

Field
layout: PipelineLayout

Native field layout.

base_pipeline_handle

Field
base_pipeline_handle: Pipeline

Native field basePipelineHandle.

base_pipeline_index

Field
base_pipeline_index: i32

Native field basePipelineIndex.

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

Set native field flags without native effects.

set_stage

Method
pub fn set_stage(self, value: PipelineShaderStageCreateInfo<'a>) -> Self

Set native field stage without native effects.

set_layout

Method
pub fn set_layout(self, value: PipelineLayout) -> Self

Set native field layout without native effects.

set_base_pipeline_handle

Method
pub fn set_base_pipeline_handle(self, value: Pipeline) -> Self

Set native field basePipelineHandle without native effects.

set_base_pipeline_index

Method
pub fn set_base_pipeline_index(self, value: i32) -> Self

Set native field basePipelineIndex 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::ComputePipelineIndirectBufferInfoNV

pub struct ComputePipelineIndirectBufferInfoNV<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub device_address: DeviceAddress, pub size: DeviceSize, pub pipeline_device_address_capture_replay: DeviceAddress, /* private fields */ }
Native structure VkComputePipelineIndirectBufferInfoNV.

Contract

Native structure VkComputePipelineIndirectBufferInfoNV.

Khronos reference: VkComputePipelineIndirectBufferInfoNV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

device_address

Field
device_address: DeviceAddress

Native field deviceAddress.

size

Field
size: DeviceSize

Native field size.

pipeline_device_address_capture_replay

Field
pipeline_device_address_capture_replay: DeviceAddress

Native field pipelineDeviceAddressCaptureReplay.

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.

set_pipeline_device_address_capture_replay

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

Set native field pipelineDeviceAddressCaptureReplay 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::ConditionalRenderingBeginInfo2EXT

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

Contract

Native structure VkConditionalRenderingBeginInfo2EXT.

Khronos reference: VkConditionalRenderingBeginInfo2EXT

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.

flags

Field
flags: ConditionalRenderingFlagsEXT

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_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.

set_flags

Method
pub fn set_flags(self, value: ConditionalRenderingFlagsEXT) -> 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::ConditionalRenderingBeginInfoEXT

pub struct ConditionalRenderingBeginInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub buffer: Buffer, pub offset: DeviceSize, pub flags: ConditionalRenderingFlagsEXT, /* private fields */ }
Native structure VkConditionalRenderingBeginInfoEXT.

Contract

Native structure VkConditionalRenderingBeginInfoEXT.

Khronos reference: VkConditionalRenderingBeginInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

buffer

Field
buffer: Buffer

Native field buffer.

offset

Field
offset: DeviceSize

Native field offset.

flags

Field
flags: ConditionalRenderingFlagsEXT

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_buffer

Method
pub fn set_buffer(self, value: Buffer) -> Self

Set native field buffer without native effects.

set_offset

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

Set native field offset without native effects.

set_flags

Method
pub fn set_flags(self, value: ConditionalRenderingFlagsEXT) -> 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.