Realm

vk · Structs · Q1

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

StRustExperimental

Stvk::QueryControlFlagBits

Contract

Open integer representation of VkQueryControlFlagBits.

Khronos reference: VkQueryControlFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::QueryLowLatencySupportNV

pub struct QueryLowLatencySupportNV<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub p_queried_low_latency_data: *mut c_void, /* private fields */ }
Native structure VkQueryLowLatencySupportNV.

Contract

Native structure VkQueryLowLatencySupportNV.

Khronos reference: VkQueryLowLatencySupportNV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

p_queried_low_latency_data

Field
p_queried_low_latency_data: *mut c_void

Native field pQueriedLowLatencyData.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_queried_low_latency_data

Method
pub unsafe fn set_queried_low_latency_data(self, value: *mut c_void) -> Self

Set native pointer pQueriedLowLatencyData 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::QueryPipelineStatisticFlagBits

Contract

Open integer representation of VkQueryPipelineStatisticFlagBits.

Khronos reference: VkQueryPipelineStatisticFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::QueryPool

Contract

Raw Vulkan handle VkQueryPool.

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

Stvk::QueryPoolCreateFlagBits

Contract

Open integer representation of VkQueryPoolCreateFlagBits.

Khronos reference: VkQueryPoolCreateFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::QueryPoolCreateInfo

pub struct QueryPoolCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: QueryPoolCreateFlags, pub query_type: QueryType, pub query_count: u32, pub pipeline_statistics: QueryPipelineStatisticFlags, /* private fields */ }
Native structure VkQueryPoolCreateInfo.

Contract

Native structure VkQueryPoolCreateInfo.

Khronos reference: VkQueryPoolCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: QueryPoolCreateFlags

Native field flags.

query_type

Field
query_type: QueryType

Native field queryType.

query_count

Field
query_count: u32

Native field queryCount.

pipeline_statistics

Field
pipeline_statistics: QueryPipelineStatisticFlags

Native field pipelineStatistics.

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

Set native field flags without native effects.

set_query_type

Method
pub fn set_query_type(self, value: QueryType) -> Self

Set native field queryType without native effects.

set_query_count

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

Set native field queryCount without native effects.

set_pipeline_statistics

Method
pub fn set_pipeline_statistics(self, value: QueryPipelineStatisticFlags) -> Self

Set native field pipelineStatistics 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::QueryPoolPerformanceCreateInfoKHR

pub struct QueryPoolPerformanceCreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub queue_family_index: u32, pub counter_index_count: u32, pub p_counter_indices: *const u32, /* private fields */ }
Native structure VkQueryPoolPerformanceCreateInfoKHR.

Contract

Native structure VkQueryPoolPerformanceCreateInfoKHR.

Khronos reference: VkQueryPoolPerformanceCreateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

queue_family_index

Field
queue_family_index: u32

Native field queueFamilyIndex.

counter_index_count

Field
counter_index_count: u32

Native field counterIndexCount.

p_counter_indices

Field
p_counter_indices: *const u32

Native field pCounterIndices.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_queue_family_index

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

Set native field queueFamilyIndex without native effects.

set_counter_index_count

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

Set native count counterIndexCount 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_counter_indices

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

Borrow pCounterIndices and set checked native count counterIndexCount. 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::QueryPoolPerformanceQueryCreateInfoINTEL

pub struct QueryPoolPerformanceQueryCreateInfoINTEL<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub performance_counters_sampling: QueryPoolSamplingModeINTEL, /* private fields */ }
Native structure VkQueryPoolPerformanceQueryCreateInfoINTEL.

Contract

Native structure VkQueryPoolPerformanceQueryCreateInfoINTEL.

Khronos reference: VkQueryPoolPerformanceQueryCreateInfoINTEL

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

performance_counters_sampling

Field
performance_counters_sampling: QueryPoolSamplingModeINTEL

Native field performanceCountersSampling.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_performance_counters_sampling

Method
pub fn set_performance_counters_sampling( self, value: QueryPoolSamplingModeINTEL, ) -> Self

Set native field performanceCountersSampling 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::QueryPoolSamplingModeINTEL

Contract

Open integer representation of VkQueryPoolSamplingModeINTEL.

Khronos reference: VkQueryPoolSamplingModeINTEL

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

eq

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

Stvk::QueryPoolVideoEncodeFeedbackCreateInfoKHR

pub struct QueryPoolVideoEncodeFeedbackCreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub encode_feedback_flags: VideoEncodeFeedbackFlagsKHR, /* private fields */ }
Native structure VkQueryPoolVideoEncodeFeedbackCreateInfoKHR.

Contract

Native structure VkQueryPoolVideoEncodeFeedbackCreateInfoKHR.

Khronos reference: VkQueryPoolVideoEncodeFeedbackCreateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

encode_feedback_flags

Field
encode_feedback_flags: VideoEncodeFeedbackFlagsKHR

Native field encodeFeedbackFlags.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_encode_feedback_flags

Method
pub fn set_encode_feedback_flags( self, value: VideoEncodeFeedbackFlagsKHR, ) -> Self

Set native field encodeFeedbackFlags 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::QueryPoolVideoEncodePerPartitionFeedbackCreateInfoKHR

pub struct QueryPoolVideoEncodePerPartitionFeedbackCreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub max_per_partition_feedback_entries: u32, pub per_partition_encode_feedback_flags: VideoEncodePerPartitionFeedbackFlagsKHR, /* private fields */ }
Native structure VkQueryPoolVideoEncodePerPartitionFeedbackCreateInfoKHR.

Contract

Native structure VkQueryPoolVideoEncodePerPartitionFeedbackCreateInfoKHR.

Khronos reference: VkQueryPoolVideoEncodePerPartitionFeedbackCreateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

max_per_partition_feedback_entries

Field
max_per_partition_feedback_entries: u32

Native field maxPerPartitionFeedbackEntries.

per_partition_encode_feedback_flags

Field
per_partition_encode_feedback_flags: VideoEncodePerPartitionFeedbackFlagsKHR

Native field perPartitionEncodeFeedbackFlags.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_max_per_partition_feedback_entries

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

Set native field maxPerPartitionFeedbackEntries without native effects.

set_per_partition_encode_feedback_flags

Method
pub fn set_per_partition_encode_feedback_flags( self, value: VideoEncodePerPartitionFeedbackFlagsKHR, ) -> Self

Set native field perPartitionEncodeFeedbackFlags 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::QueryResultFlagBits

Contract

Open integer representation of VkQueryResultFlagBits.

Khronos reference: VkQueryResultFlagBits

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

Output-1

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

Output-2

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

Output-3

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

eq

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

Stvk::QueryResultStatusKHR

Contract

Open integer representation of VkQueryResultStatusKHR.

Khronos reference: VkQueryResultStatusKHR

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

eq

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

Stvk::QueryType

Contract

Open integer representation of VkQueryType.

Khronos reference: VkQueryType

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

Stvk::Queue

Contract

Raw Vulkan handle VkQueue.

Khronos reference: VkQueue Calls using this identity must satisfy Vulkan lifetime and synchronization rules.

Fields

0

Field
0: *mut c_void
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: &Queue) -> bool
Tests for self and other values to be equal, and is used by ==.

Stvk::QueueFamilyCheckpointProperties2NV

pub struct QueueFamilyCheckpointProperties2NV<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub checkpoint_execution_stage_mask: PipelineStageFlags2, /* private fields */ }
Native structure VkQueueFamilyCheckpointProperties2NV.

Contract

Native structure VkQueueFamilyCheckpointProperties2NV.

Khronos reference: VkQueueFamilyCheckpointProperties2NV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

checkpoint_execution_stage_mask

Field
checkpoint_execution_stage_mask: PipelineStageFlags2

Native field checkpointExecutionStageMask.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_checkpoint_execution_stage_mask

Method
pub fn set_checkpoint_execution_stage_mask( self, value: PipelineStageFlags2, ) -> Self

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