Realm

vk · Structs · S2

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

StRustExperimental

Stvk::SamplerYcbcrConversion

Contract

Raw Vulkan handle VkSamplerYcbcrConversion.

Khronos reference: VkSamplerYcbcrConversion 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.

clone

Method
fn clone(&self) -> SamplerYcbcrConversion
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

eq

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

Stvk::SamplerYcbcrConversionCreateInfo

pub struct SamplerYcbcrConversionCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub format: Format, pub ycbcr_model: SamplerYcbcrModelConversion, pub ycbcr_range: SamplerYcbcrRange, pub components: ComponentMapping, pub x_chroma_offset: ChromaLocation, pub y_chroma_offset: ChromaLocation, pub chroma_filter: Filter, pub force_explicit_reconstruction: Bool32, /* private fields */ }
Native structure VkSamplerYcbcrConversionCreateInfo.

Contract

Native structure VkSamplerYcbcrConversionCreateInfo.

Khronos reference: VkSamplerYcbcrConversionCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

format

Field
format: Format

Native field format.

ycbcr_model

Field
ycbcr_model: SamplerYcbcrModelConversion

Native field ycbcrModel.

ycbcr_range

Field
ycbcr_range: SamplerYcbcrRange

Native field ycbcrRange.

components

Field
components: ComponentMapping

Native field components.

x_chroma_offset

Field
x_chroma_offset: ChromaLocation

Native field xChromaOffset.

y_chroma_offset

Field
y_chroma_offset: ChromaLocation

Native field yChromaOffset.

chroma_filter

Field
chroma_filter: Filter

Native field chromaFilter.

force_explicit_reconstruction

Field
force_explicit_reconstruction: Bool32

Native field forceExplicitReconstruction.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_format

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

Set native field format without native effects.

set_ycbcr_model

Method
pub fn set_ycbcr_model(self, value: SamplerYcbcrModelConversion) -> Self

Set native field ycbcrModel without native effects.

set_ycbcr_range

Method
pub fn set_ycbcr_range(self, value: SamplerYcbcrRange) -> Self

Set native field ycbcrRange without native effects.

set_components

Method
pub fn set_components(self, value: ComponentMapping) -> Self

Set native field components without native effects.

set_x_chroma_offset

Method
pub fn set_x_chroma_offset(self, value: ChromaLocation) -> Self

Set native field xChromaOffset without native effects.

set_y_chroma_offset

Method
pub fn set_y_chroma_offset(self, value: ChromaLocation) -> Self

Set native field yChromaOffset without native effects.

set_chroma_filter

Method
pub fn set_chroma_filter(self, value: Filter) -> Self

Set native field chromaFilter without native effects.

set_force_explicit_reconstruction

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

Set native field forceExplicitReconstruction 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::SamplerYcbcrConversionImageFormatProperties

pub struct SamplerYcbcrConversionImageFormatProperties<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub combined_image_sampler_descriptor_count: u32, /* private fields */ }
Native structure VkSamplerYcbcrConversionImageFormatProperties.

Contract

Native structure VkSamplerYcbcrConversionImageFormatProperties.

Khronos reference: VkSamplerYcbcrConversionImageFormatProperties

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

combined_image_sampler_descriptor_count

Field
combined_image_sampler_descriptor_count: u32

Native field combinedImageSamplerDescriptorCount.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_combined_image_sampler_descriptor_count

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

Set native field combinedImageSamplerDescriptorCount 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::SamplerYcbcrConversionInfo

pub struct SamplerYcbcrConversionInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub conversion: SamplerYcbcrConversion, /* private fields */ }
Native structure VkSamplerYcbcrConversionInfo.

Contract

Native structure VkSamplerYcbcrConversionInfo.

Khronos reference: VkSamplerYcbcrConversionInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

conversion

Field
conversion: SamplerYcbcrConversion

Native field conversion.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_conversion

Method
pub fn set_conversion(self, value: SamplerYcbcrConversion) -> Self

Set native field conversion 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::SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM

pub struct SamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub enable_y_degamma: Bool32, pub enable_cb_cr_degamma: Bool32, /* private fields */ }
Native structure VkSamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM.

Contract

Native structure VkSamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM.

Khronos reference: VkSamplerYcbcrConversionYcbcrDegammaCreateInfoQCOM

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

enable_y_degamma

Field
enable_y_degamma: Bool32

Native field enableYDegamma.

enable_cb_cr_degamma

Field
enable_cb_cr_degamma: Bool32

Native field enableCbCrDegamma.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_enable_y_degamma

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

Set native field enableYDegamma without native effects.

set_enable_cb_cr_degamma

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

Set native field enableCbCrDegamma 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::SamplerYcbcrModelConversion

Contract

Open integer representation of VkSamplerYcbcrModelConversion.

Khronos reference: VkSamplerYcbcrModelConversion

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

eq

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

Stvk::SamplerYcbcrRange

Contract

Open integer representation of VkSamplerYcbcrRange.

Khronos reference: VkSamplerYcbcrRange

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

eq

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

Stvk::ScopeKHR

Contract

Open integer representation of VkScopeKHR.

Khronos reference: VkScopeKHR

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

Stvk::ScreenBufferFormatPropertiesQNX

pub struct ScreenBufferFormatPropertiesQNX<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub format: Format, pub external_format: u64, pub screen_usage: u64, pub format_features: FormatFeatureFlags, pub sampler_ycbcr_conversion_components: ComponentMapping, pub suggested_ycbcr_model: SamplerYcbcrModelConversion, pub suggested_ycbcr_range: SamplerYcbcrRange, pub suggested_x_chroma_offset: ChromaLocation, pub suggested_y_chroma_offset: ChromaLocation, /* private fields */ }
Native structure VkScreenBufferFormatPropertiesQNX.

Contract

Native structure VkScreenBufferFormatPropertiesQNX.

Khronos reference: VkScreenBufferFormatPropertiesQNX

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

format

Field
format: Format

Native field format.

external_format

Field
external_format: u64

Native field externalFormat.

screen_usage

Field
screen_usage: u64

Native field screenUsage.

format_features

Field
format_features: FormatFeatureFlags

Native field formatFeatures.

sampler_ycbcr_conversion_components

Field
sampler_ycbcr_conversion_components: ComponentMapping

Native field samplerYcbcrConversionComponents.

suggested_ycbcr_model

Field
suggested_ycbcr_model: SamplerYcbcrModelConversion

Native field suggestedYcbcrModel.

suggested_ycbcr_range

Field
suggested_ycbcr_range: SamplerYcbcrRange

Native field suggestedYcbcrRange.

suggested_x_chroma_offset

Field
suggested_x_chroma_offset: ChromaLocation

Native field suggestedXChromaOffset.

suggested_y_chroma_offset

Field
suggested_y_chroma_offset: ChromaLocation

Native field suggestedYChromaOffset.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_format

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

Set native field format without native effects.

set_external_format

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

Set native field externalFormat without native effects.

set_screen_usage

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

Set native field screenUsage without native effects.

set_format_features

Method
pub fn set_format_features(self, value: FormatFeatureFlags) -> Self

Set native field formatFeatures without native effects.

set_sampler_ycbcr_conversion_components

Method
pub fn set_sampler_ycbcr_conversion_components( self, value: ComponentMapping, ) -> Self

Set native field samplerYcbcrConversionComponents without native effects.

set_suggested_ycbcr_model

Method
pub fn set_suggested_ycbcr_model( self, value: SamplerYcbcrModelConversion, ) -> Self

Set native field suggestedYcbcrModel without native effects.

set_suggested_ycbcr_range

Method
pub fn set_suggested_ycbcr_range(self, value: SamplerYcbcrRange) -> Self

Set native field suggestedYcbcrRange without native effects.

set_suggested_x_chroma_offset

Method
pub fn set_suggested_x_chroma_offset(self, value: ChromaLocation) -> Self

Set native field suggestedXChromaOffset without native effects.

set_suggested_y_chroma_offset

Method
pub fn set_suggested_y_chroma_offset(self, value: ChromaLocation) -> Self

Set native field suggestedYChromaOffset 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::ScreenBufferPropertiesQNX

pub struct ScreenBufferPropertiesQNX<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub allocation_size: DeviceSize, pub memory_type_bits: u32, /* private fields */ }
Native structure VkScreenBufferPropertiesQNX.

Contract

Native structure VkScreenBufferPropertiesQNX.

Khronos reference: VkScreenBufferPropertiesQNX

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

allocation_size

Field
allocation_size: DeviceSize

Native field allocationSize.

memory_type_bits

Field
memory_type_bits: u32

Native field memoryTypeBits.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_allocation_size

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

Set native field allocationSize without native effects.

set_memory_type_bits

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

Set native field memoryTypeBits 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::ScreenSurfaceCreateFlagsQNX

Contract

Open integer representation of VkScreenSurfaceCreateFlagsQNX.

Khronos reference: VkScreenSurfaceCreateFlagsQNX

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ScreenSurfaceCreateInfoQNX

pub struct ScreenSurfaceCreateInfoQNX<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: ScreenSurfaceCreateFlagsQNX, pub context: *mut _screen_context, pub window: *mut _screen_window, /* private fields */ }
Native structure VkScreenSurfaceCreateInfoQNX.

Contract

Native structure VkScreenSurfaceCreateInfoQNX.

Khronos reference: VkScreenSurfaceCreateInfoQNX

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: ScreenSurfaceCreateFlagsQNX

Native field flags.

context

Field
context: *mut _screen_context

Native field context.

window

Field
window: *mut _screen_window

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

Set native field flags without native effects.

set_context

Method
pub unsafe fn set_context(self, value: *mut _screen_context) -> Self

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

set_window

Method
pub unsafe fn set_window(self, value: *mut _screen_window) -> 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::SECURITY_ATTRIBUTES

Contract

Native type SECURITY_ATTRIBUTES.

Khronos registry source: SECURITY_ATTRIBUTES

Stvk::Semaphore

Contract

Raw Vulkan handle VkSemaphore.

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

Stvk::SemaphoreCreateFlags

Contract

Open integer representation of VkSemaphoreCreateFlags.

Khronos reference: VkSemaphoreCreateFlags

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::SemaphoreCreateInfo

pub struct SemaphoreCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: SemaphoreCreateFlags, /* private fields */ }
Native structure VkSemaphoreCreateInfo.

Contract

Native structure VkSemaphoreCreateInfo.

Khronos reference: VkSemaphoreCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: SemaphoreCreateFlags

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_flags

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