Realm

vk · Structs · V11

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

StRustExperimental

Stvk::VideoSessionCreateFlagBitsKHR

Contract

Open integer representation of VkVideoSessionCreateFlagBitsKHR.

Khronos reference: VkVideoSessionCreateFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::VideoSessionCreateInfoKHR

pub struct VideoSessionCreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub queue_family_index: u32, pub flags: VideoSessionCreateFlagsKHR, pub p_video_profile: *const VideoProfileInfoKHR<'a>, pub picture_format: Format, pub max_coded_extent: Extent2D, pub reference_picture_format: Format, pub max_dpb_slots: u32, pub max_active_reference_pictures: u32, pub p_std_header_version: *const ExtensionProperties, /* private fields */ }
Native structure VkVideoSessionCreateInfoKHR.

Contract

Native structure VkVideoSessionCreateInfoKHR.

Khronos reference: VkVideoSessionCreateInfoKHR

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.

flags

Field
flags: VideoSessionCreateFlagsKHR

Native field flags.

p_video_profile

Field
p_video_profile: *const VideoProfileInfoKHR<'a>

Native field pVideoProfile.

picture_format

Field
picture_format: Format

Native field pictureFormat.

max_coded_extent

Field
max_coded_extent: Extent2D

Native field maxCodedExtent.

reference_picture_format

Field
reference_picture_format: Format

Native field referencePictureFormat.

max_dpb_slots

Field
max_dpb_slots: u32

Native field maxDpbSlots.

max_active_reference_pictures

Field
max_active_reference_pictures: u32

Native field maxActiveReferencePictures.

p_std_header_version

Field
p_std_header_version: *const ExtensionProperties

Native field pStdHeaderVersion.

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_flags

Method
pub fn set_flags(self, value: VideoSessionCreateFlagsKHR) -> Self

Set native field flags without native effects.

set_video_profile

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

Set native field pVideoProfile without native effects.

set_picture_format

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

Set native field pictureFormat without native effects.

set_max_coded_extent

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

Set native field maxCodedExtent without native effects.

set_reference_picture_format

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

Set native field referencePictureFormat without native effects.

set_max_dpb_slots

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

Set native field maxDpbSlots without native effects.

set_max_active_reference_pictures

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

Set native field maxActiveReferencePictures without native effects.

set_std_header_version

Method
pub fn set_std_header_version(self, value: &'a ExtensionProperties) -> Self

Set native field pStdHeaderVersion 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::VideoSessionKHR

Contract

Raw Vulkan handle VkVideoSessionKHR.

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

Stvk::VideoSessionMemoryRequirementsKHR

pub struct VideoSessionMemoryRequirementsKHR<'a> { pub s_type: StructureType, pub p_next: *mut c_void, pub memory_bind_index: u32, pub memory_requirements: MemoryRequirements, /* private fields */ }
Native structure VkVideoSessionMemoryRequirementsKHR.

Contract

Native structure VkVideoSessionMemoryRequirementsKHR.

Khronos reference: VkVideoSessionMemoryRequirementsKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *mut c_void

Native field pNext.

memory_bind_index

Field
memory_bind_index: u32

Native field memoryBindIndex.

memory_requirements

Field
memory_requirements: MemoryRequirements

Native field memoryRequirements.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_memory_bind_index

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

Set native field memoryBindIndex without native effects.

set_memory_requirements

Method
pub fn set_memory_requirements(self, value: MemoryRequirements) -> Self

Set native field memoryRequirements 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::VideoSessionParametersCreateFlagBitsKHR

Contract

Open integer representation of VkVideoSessionParametersCreateFlagBitsKHR.

Khronos reference: VkVideoSessionParametersCreateFlagBitsKHR

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::VideoSessionParametersCreateInfoKHR

pub struct VideoSessionParametersCreateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: VideoSessionParametersCreateFlagsKHR, pub video_session_parameters_template: VideoSessionParametersKHR, pub video_session: VideoSessionKHR, /* private fields */ }
Native structure VkVideoSessionParametersCreateInfoKHR.

Contract

Native structure VkVideoSessionParametersCreateInfoKHR.

Khronos reference: VkVideoSessionParametersCreateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: VideoSessionParametersCreateFlagsKHR

Native field flags.

video_session_parameters_template

Field
video_session_parameters_template: VideoSessionParametersKHR

Native field videoSessionParametersTemplate.

video_session

Field
video_session: VideoSessionKHR

Native field videoSession.

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

Set native field flags without native effects.

set_video_session_parameters_template

Method
pub fn set_video_session_parameters_template( self, value: VideoSessionParametersKHR, ) -> Self

Set native field videoSessionParametersTemplate without native effects.

set_video_session

Method
pub fn set_video_session(self, value: VideoSessionKHR) -> Self

Set native field videoSession 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::VideoSessionParametersKHR

Contract

Raw Vulkan handle VkVideoSessionParametersKHR.

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

Stvk::VideoSessionParametersUpdateInfoKHR

pub struct VideoSessionParametersUpdateInfoKHR<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub update_sequence_count: u32, /* private fields */ }
Native structure VkVideoSessionParametersUpdateInfoKHR.

Contract

Native structure VkVideoSessionParametersUpdateInfoKHR.

Khronos reference: VkVideoSessionParametersUpdateInfoKHR

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

update_sequence_count

Field
update_sequence_count: u32

Native field updateSequenceCount.

Methods and associated items

new

Method
pub fn new() -> Self

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

set_update_sequence_count

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

Set native field updateSequenceCount 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::Viewport

Contract

Native structure VkViewport.

Khronos reference: VkViewport

Fields

x

Field
x: f32

Native field x.

y

Field
y: f32

Native field y.

width

Field
width: f32

Native field width.

height

Field
height: f32

Native field height.

min_depth

Field
min_depth: f32

Native field minDepth.

max_depth

Field
max_depth: f32

Native field maxDepth.

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.

set_width

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

Set native field width without native effects.

set_height

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

Set native field height without native effects.

set_min_depth

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

Set native field minDepth without native effects.

set_max_depth

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

Set native field maxDepth without native effects.

Stvk::ViewportCoordinateSwizzleNV

Contract

Open integer representation of VkViewportCoordinateSwizzleNV.

Khronos reference: VkViewportCoordinateSwizzleNV

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

eq

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

Stvk::ViewportSwizzleNV

#[repr(C)]pub struct ViewportSwizzleNV { pub x: ViewportCoordinateSwizzleNV, pub y: ViewportCoordinateSwizzleNV, pub z: ViewportCoordinateSwizzleNV, pub w: ViewportCoordinateSwizzleNV, }
Native structure VkViewportSwizzleNV.

Contract

Native structure VkViewportSwizzleNV.

Khronos reference: VkViewportSwizzleNV

Fields

x

Field
x: ViewportCoordinateSwizzleNV

Native field x.

y

Field
y: ViewportCoordinateSwizzleNV

Native field y.

z

Field
z: ViewportCoordinateSwizzleNV

Native field z.

w

Field
w: ViewportCoordinateSwizzleNV

Native field w.

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

Set native field x without native effects.

set_y

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

Set native field y without native effects.

set_z

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

Set native field z without native effects.

set_w

Method
pub fn set_w(self, value: ViewportCoordinateSwizzleNV) -> Self

Set native field w without native effects.

Stvk::ViewportWScalingNV

Contract

Native structure VkViewportWScalingNV.

Khronos reference: VkViewportWScalingNV

Fields

xcoeff

Field
xcoeff: f32

Native field xcoeff.

ycoeff

Field
ycoeff: f32

Native field ycoeff.

Methods and associated items

new

Method
pub fn new() -> Self

Construct the record with its default native state.

set_xcoeff

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

Set native field xcoeff without native effects.

set_ycoeff

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

Set native field ycoeff without native effects.

Stvk::ViSurfaceCreateFlagsNN

Contract

Open integer representation of VkViSurfaceCreateFlagsNN.

Khronos reference: VkViSurfaceCreateFlagsNN

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

Output-1

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

Output-2

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

clone

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

Output-3

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

eq

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

Stvk::ViSurfaceCreateInfoNN

pub struct ViSurfaceCreateInfoNN<'a> { pub s_type: StructureType, pub p_next: *const c_void, pub flags: ViSurfaceCreateFlagsNN, pub window: *mut c_void, /* private fields */ }
Native structure VkViSurfaceCreateInfoNN.

Contract

Native structure VkViSurfaceCreateInfoNN.

Khronos reference: VkViSurfaceCreateInfoNN

Fields

s_type

Field
s_type: StructureType

Native field sType.

p_next

Field
p_next: *const c_void

Native field pNext.

flags

Field
flags: ViSurfaceCreateFlagsNN

Native field flags.

window

Field
window: *mut c_void

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

Set native field flags without native effects.

set_window

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