Realm

vk · Structs · S1

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

StRustExperimental

Stvk::SampleCountFlagBits

Contract

Open integer representation of VkSampleCountFlagBits.

Khronos reference: VkSampleCountFlagBits

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

Output-1

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

Output-2

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

Output-3

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

eq

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

Stvk::SampleLocationEXT

Contract

Native structure VkSampleLocationEXT.

Khronos reference: VkSampleLocationEXT

Fields

x

Field
x: f32

Native field x.

y

Field
y: f32

Native field y.

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

Set native field x without native effects.

set_y

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

Set native field y without native effects.

Stvk::SampleLocationsInfoEXT

pub struct SampleLocationsInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub sample_locations_per_pixel: SampleCountFlagBits, pub sample_location_grid_size: Extent2D, pub sample_locations_count: u32, pub p_sample_locations: *const SampleLocationEXT, /* private fields */ }
Native structure VkSampleLocationsInfoEXT.

Contract

Native structure VkSampleLocationsInfoEXT.

Khronos reference: VkSampleLocationsInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

sample_locations_per_pixel

Field
sample_locations_per_pixel: SampleCountFlagBits

Native field sampleLocationsPerPixel.

sample_location_grid_size

Field
sample_location_grid_size: Extent2D

Native field sampleLocationGridSize.

sample_locations_count

Field
sample_locations_count: u32

Native field sampleLocationsCount.

p_sample_locations

Field
p_sample_locations: *const SampleLocationEXT

Native field pSampleLocations.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_sample_locations_per_pixel

Method
pub fn set_sample_locations_per_pixel(self, value: SampleCountFlagBits) -> Self

Set native field sampleLocationsPerPixel without native effects.

set_sample_location_grid_size

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

Set native field sampleLocationGridSize without native effects.

set_sample_locations_count

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

Set native count sampleLocationsCount 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_sample_locations

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

Borrow pSampleLocations and set checked native count sampleLocationsCount. 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::Sampler

Contract

Raw Vulkan handle VkSampler.

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

Stvk::SamplerAddressMode

Contract

Open integer representation of VkSamplerAddressMode.

Khronos reference: VkSamplerAddressMode

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

eq

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

Stvk::SamplerBlockMatchWindowCreateInfoQCOM

pub struct SamplerBlockMatchWindowCreateInfoQCOM<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub window_extent: Extent2D, pub window_compare_mode: BlockMatchWindowCompareModeQCOM, /* private fields */ }
Native structure VkSamplerBlockMatchWindowCreateInfoQCOM.

Contract

Native structure VkSamplerBlockMatchWindowCreateInfoQCOM.

Khronos reference: VkSamplerBlockMatchWindowCreateInfoQCOM

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

window_extent

Field
window_extent: Extent2D

Native field windowExtent.

window_compare_mode

Field
window_compare_mode: BlockMatchWindowCompareModeQCOM

Native field windowCompareMode.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_window_extent

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

Set native field windowExtent without native effects.

set_window_compare_mode

Method
pub fn set_window_compare_mode( self, value: BlockMatchWindowCompareModeQCOM, ) -> Self

Set native field windowCompareMode 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::SamplerBorderColorComponentMappingCreateInfoEXT

pub struct SamplerBorderColorComponentMappingCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub components: ComponentMapping, pub srgb: Bool32, /* private fields */ }
Native structure VkSamplerBorderColorComponentMappingCreateInfoEXT.

Contract

Native structure VkSamplerBorderColorComponentMappingCreateInfoEXT.

Khronos reference: VkSamplerBorderColorComponentMappingCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

components

Field
components: ComponentMapping

Native field components.

srgb

Field
srgb: Bool32

Native field srgb.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_components

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

Set native field components without native effects.

set_srgb

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

Set native field srgb 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::SamplerCaptureDescriptorDataInfoEXT

pub struct SamplerCaptureDescriptorDataInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub sampler: Sampler, /* private fields */ }
Native structure VkSamplerCaptureDescriptorDataInfoEXT.

Contract

Native structure VkSamplerCaptureDescriptorDataInfoEXT.

Khronos reference: VkSamplerCaptureDescriptorDataInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

sampler

Field
sampler: Sampler

Native field sampler.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_sampler

Method
pub fn set_sampler(self, value: Sampler) -> Self

Set native field sampler 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::SamplerCreateFlagBits

Contract

Open integer representation of VkSamplerCreateFlagBits.

Khronos reference: VkSamplerCreateFlagBits

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::SamplerCreateInfo

pub struct SamplerCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: SamplerCreateFlags, pub mag_filter: Filter, pub min_filter: Filter, pub mipmap_mode: SamplerMipmapMode, pub address_mode_u: SamplerAddressMode, pub address_mode_v: SamplerAddressMode, pub address_mode_w: SamplerAddressMode, pub mip_lod_bias: f32, pub anisotropy_enable: Bool32, pub max_anisotropy: f32, pub compare_enable: Bool32, pub compare_op: CompareOp, pub min_lod: f32, pub max_lod: f32, pub border_color: BorderColor, pub unnormalized_coordinates: Bool32, /* private fields */ }
Native structure VkSamplerCreateInfo.

Contract

Native structure VkSamplerCreateInfo.

Khronos reference: VkSamplerCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: SamplerCreateFlags

Native field flags.

mag_filter

Field
mag_filter: Filter

Native field magFilter.

min_filter

Field
min_filter: Filter

Native field minFilter.

mipmap_mode

Field
mipmap_mode: SamplerMipmapMode

Native field mipmapMode.

address_mode_u

Field
address_mode_u: SamplerAddressMode

Native field addressModeU.

address_mode_v

Field
address_mode_v: SamplerAddressMode

Native field addressModeV.

address_mode_w

Field
address_mode_w: SamplerAddressMode

Native field addressModeW.

mip_lod_bias

Field
mip_lod_bias: f32

Native field mipLodBias.

anisotropy_enable

Field
anisotropy_enable: Bool32

Native field anisotropyEnable.

max_anisotropy

Field
max_anisotropy: f32

Native field maxAnisotropy.

compare_enable

Field
compare_enable: Bool32

Native field compareEnable.

compare_op

Field
compare_op: CompareOp

Native field compareOp.

min_lod

Field
min_lod: f32

Native field minLod.

max_lod

Field
max_lod: f32

Native field maxLod.

border_color

Field
border_color: BorderColor

Native field borderColor.

unnormalized_coordinates

Field
unnormalized_coordinates: Bool32

Native field unnormalizedCoordinates.

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

Set native field flags without native effects.

set_mag_filter

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

Set native field magFilter without native effects.

set_min_filter

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

Set native field minFilter without native effects.

set_mipmap_mode

Method
pub fn set_mipmap_mode(self, value: SamplerMipmapMode) -> Self

Set native field mipmapMode without native effects.

set_address_mode_u

Method
pub fn set_address_mode_u(self, value: SamplerAddressMode) -> Self

Set native field addressModeU without native effects.

set_address_mode_v

Method
pub fn set_address_mode_v(self, value: SamplerAddressMode) -> Self

Set native field addressModeV without native effects.

set_address_mode_w

Method
pub fn set_address_mode_w(self, value: SamplerAddressMode) -> Self

Set native field addressModeW without native effects.

set_mip_lod_bias

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

Set native field mipLodBias without native effects.

set_anisotropy_enable

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

Set native field anisotropyEnable without native effects.

set_max_anisotropy

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

Set native field maxAnisotropy without native effects.

set_compare_enable

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

Set native field compareEnable without native effects.

set_compare_op

Method
pub fn set_compare_op(self, value: CompareOp) -> Self

Set native field compareOp without native effects.

set_min_lod

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

Set native field minLod without native effects.

set_max_lod

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

Set native field maxLod without native effects.

set_border_color

Method
pub fn set_border_color(self, value: BorderColor) -> Self

Set native field borderColor without native effects.

set_unnormalized_coordinates

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

Set native field unnormalizedCoordinates 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::SamplerCubicWeightsCreateInfoQCOM

pub struct SamplerCubicWeightsCreateInfoQCOM<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub cubic_weights: CubicFilterWeightsQCOM, /* private fields */ }
Native structure VkSamplerCubicWeightsCreateInfoQCOM.

Contract

Native structure VkSamplerCubicWeightsCreateInfoQCOM.

Khronos reference: VkSamplerCubicWeightsCreateInfoQCOM

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

cubic_weights

Field
cubic_weights: CubicFilterWeightsQCOM

Native field cubicWeights.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_cubic_weights

Method
pub fn set_cubic_weights(self, value: CubicFilterWeightsQCOM) -> Self

Set native field cubicWeights 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::SamplerCustomBorderColorCreateInfoEXT

pub struct SamplerCustomBorderColorCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub custom_border_color: ClearColorValue, pub format: Format, /* private fields */ }
Native structure VkSamplerCustomBorderColorCreateInfoEXT.

Contract

Native structure VkSamplerCustomBorderColorCreateInfoEXT.

Khronos reference: VkSamplerCustomBorderColorCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

custom_border_color

Field
custom_border_color: ClearColorValue

Native field customBorderColor.

format

Field
format: Format

Native field format.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_custom_border_color

Method
pub fn set_custom_border_color(self, value: ClearColorValue) -> Self

Set native field customBorderColor without native effects.

set_format

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

Set native field format 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::SamplerCustomBorderColorIndexCreateInfoEXT

pub struct SamplerCustomBorderColorIndexCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub index: u32, /* private fields */ }
Native structure VkSamplerCustomBorderColorIndexCreateInfoEXT.

Contract

Native structure VkSamplerCustomBorderColorIndexCreateInfoEXT.

Khronos reference: VkSamplerCustomBorderColorIndexCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

index

Field
index: u32

Native field index.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_index

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

Set native field index 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::SamplerMipmapMode

Contract

Open integer representation of VkSamplerMipmapMode.

Khronos reference: VkSamplerMipmapMode

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

eq

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

Stvk::SamplerReductionMode

Contract

Open integer representation of VkSamplerReductionMode.

Khronos reference: VkSamplerReductionMode

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

eq

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

Stvk::SamplerReductionModeCreateInfo

pub struct SamplerReductionModeCreateInfo<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub reduction_mode: SamplerReductionMode, /* private fields */ }
Native structure VkSamplerReductionModeCreateInfo.

Contract

Native structure VkSamplerReductionModeCreateInfo.

Khronos reference: VkSamplerReductionModeCreateInfo

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

reduction_mode

Field
reduction_mode: SamplerReductionMode

Native field reductionMode.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_reduction_mode

Method
pub fn set_reduction_mode(self, value: SamplerReductionMode) -> Self

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