Realm

vk · Structs · O1

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

StRustExperimental

Stvk::ObjectType

Contract

Open integer representation of VkObjectType.

Khronos reference: VkObjectType

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

Stvk::Offset2D

Contract

Native structure VkOffset2D.

Khronos reference: VkOffset2D

Fields

x

Field
x: i32

Native field x.

y

Field
y: i32

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

Set native field x without native effects.

set_y

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

Set native field y without native effects.

Stvk::Offset3D

Contract

Native structure VkOffset3D.

Khronos reference: VkOffset3D

Fields

x

Field
x: i32

Native field x.

y

Field
y: i32

Native field y.

z

Field
z: i32

Native field z.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_x

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

Set native field x without native effects.

set_y

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

Set native field y without native effects.

set_z

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

Set native field z without native effects.

Stvk::OH_NativeBuffer

Contract

Native type OH_NativeBuffer.

Khronos registry source: OH_NativeBuffer

Stvk::OHNativeWindow

Contract

Native type OHNativeWindow.

Khronos registry source: OHNativeWindow

Stvk::OpacityMicromapFormatKHR

Contract

Open integer representation of VkOpacityMicromapFormatKHR.

Khronos reference: VkOpacityMicromapFormatKHR

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

eq

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

Stvk::OpacityMicromapSpecialIndexKHR

Contract

Open integer representation of VkOpacityMicromapSpecialIndexKHR.

Khronos reference: VkOpacityMicromapSpecialIndexKHR

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

eq

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

Stvk::OpaqueCaptureDataCreateInfoEXT

pub struct OpaqueCaptureDataCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub p_data: *const HostAddressRangeConstEXT<'a>, /* private fields */ }
Native structure VkOpaqueCaptureDataCreateInfoEXT.

Contract

Native structure VkOpaqueCaptureDataCreateInfoEXT.

Khronos reference: VkOpaqueCaptureDataCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

p_data

Field
p_data: *const HostAddressRangeConstEXT<'a>

Native field pData.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_data

Method
pub fn set_data(self, value: &'a HostAddressRangeConstEXT<'a>) -> Self

Set native field pData 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::OpaqueCaptureDescriptorDataCreateInfoEXT

pub struct OpaqueCaptureDescriptorDataCreateInfoEXT<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub opaque_capture_descriptor_data: *const c_void, /* private fields */ }
Native structure VkOpaqueCaptureDescriptorDataCreateInfoEXT.

Contract

Native structure VkOpaqueCaptureDescriptorDataCreateInfoEXT.

Khronos reference: VkOpaqueCaptureDescriptorDataCreateInfoEXT

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

opaque_capture_descriptor_data

Field
opaque_capture_descriptor_data: *const c_void

Native field opaqueCaptureDescriptorData.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_opaque_capture_descriptor_data

Method
pub unsafe fn set_opaque_capture_descriptor_data( self, value: *const c_void, ) -> Self

Set native pointer opaqueCaptureDescriptorData 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::OpticalFlowExecuteFlagBitsNV

Contract

Open integer representation of VkOpticalFlowExecuteFlagBitsNV.

Khronos reference: VkOpticalFlowExecuteFlagBitsNV

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::OpticalFlowExecuteInfoNV

pub struct OpticalFlowExecuteInfoNV<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub flags: OpticalFlowExecuteFlagsNV, pub region_count: u32, pub p_regions: *const Rect2D, /* private fields */ }
Native structure VkOpticalFlowExecuteInfoNV.

Contract

Native structure VkOpticalFlowExecuteInfoNV.

Khronos reference: VkOpticalFlowExecuteInfoNV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

flags

Field
flags: OpticalFlowExecuteFlagsNV

Native field flags.

region_count

Field
region_count: u32

Native field regionCount.

p_regions

Field
p_regions: *const Rect2D

Native field pRegions.

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

Set native field flags without native effects.

set_region_count

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

Set native count regionCount 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_regions

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

Borrow pRegions and set checked native count regionCount. 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::OpticalFlowGridSizeFlagBitsNV

Contract

Open integer representation of VkOpticalFlowGridSizeFlagBitsNV.

Khronos reference: VkOpticalFlowGridSizeFlagBitsNV

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::OpticalFlowImageFormatInfoNV

pub struct OpticalFlowImageFormatInfoNV<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub usage: OpticalFlowUsageFlagsNV, /* private fields */ }
Native structure VkOpticalFlowImageFormatInfoNV.

Contract

Native structure VkOpticalFlowImageFormatInfoNV.

Khronos reference: VkOpticalFlowImageFormatInfoNV

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

usage

Field
usage: OpticalFlowUsageFlagsNV

Native field usage.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_usage

Method
pub fn set_usage(self, value: OpticalFlowUsageFlagsNV) -> Self

Set native field usage 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::OpticalFlowImageFormatPropertiesNV

pub struct OpticalFlowImageFormatPropertiesNV<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub format: Format, /* private fields */ }
Native structure VkOpticalFlowImageFormatPropertiesNV.

Contract

Native structure VkOpticalFlowImageFormatPropertiesNV.

Khronos reference: VkOpticalFlowImageFormatPropertiesNV

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.

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.

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

Contract

Open integer representation of VkOpticalFlowPerformanceLevelNV.

Khronos reference: VkOpticalFlowPerformanceLevelNV

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

eq

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

Stvk::OpticalFlowSessionBindingPointNV

Contract

Open integer representation of VkOpticalFlowSessionBindingPointNV.

Khronos reference: VkOpticalFlowSessionBindingPointNV

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

eq

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