vk · Structs · O2

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

StRustExperimental

Stvk::OpticalFlowSessionCreateFlagBitsNV

#[repr(transparent)]pub struct OpticalFlowSessionCreateFlagBitsNV(pub u32);

Open integer representation of VkOpticalFlowSessionCreateFlagBitsNV.

Contract

Open integer representation of VkOpticalFlowSessionCreateFlagBitsNV.

Khronos reference: VkOpticalFlowSessionCreateFlagBitsNV

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

ENABLE_HINT_BIT_NV

Method

pub const ENABLE_HINT_BIT_NV: Self

Native value VK_OPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_SESSION_CREATE_ENABLE_HINT_BIT_NV

ENABLE_COST_BIT_NV

Method

pub const ENABLE_COST_BIT_NV: Self

Native value VK_OPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_SESSION_CREATE_ENABLE_COST_BIT_NV

ENABLE_GLOBAL_FLOW_BIT_NV

Method

pub const ENABLE_GLOBAL_FLOW_BIT_NV: Self

Native value VK_OPTICAL_FLOW_SESSION_CREATE_ENABLE_GLOBAL_FLOW_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_SESSION_CREATE_ENABLE_GLOBAL_FLOW_BIT_NV

ALLOW_REGIONS_BIT_NV

Method

pub const ALLOW_REGIONS_BIT_NV: Self

Native value VK_OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_SESSION_CREATE_ALLOW_REGIONS_BIT_NV

BOTH_DIRECTIONS_BIT_NV

Method

pub const BOTH_DIRECTIONS_BIT_NV: Self

Native value VK_OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_SESSION_CREATE_BOTH_DIRECTIONS_BIT_NV

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 = OpticalFlowSessionCreateFlagBitsNV

The resulting type after applying the & operator.

bitand

Method

fn bitand(self, rhs: Self) -> Self

Performs the & operation. Read more

Output-1

Method

type Output = OpticalFlowSessionCreateFlagBitsNV

The resulting type after applying the | operator.

bitor

Method

fn bitor(self, rhs: Self) -> Self

Performs the | operation. Read more

Output-2

Method

type Output = OpticalFlowSessionCreateFlagBitsNV

The resulting type after applying the ^ operator.

bitxor

Method

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation. Read more

clone

Method

fn clone(&self) -> OpticalFlowSessionCreateFlagBitsNV

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() -> OpticalFlowSessionCreateFlagBitsNV

Returns the “default value” for a type. Read more

hash

Method

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more

Output-3

Method

type Output = OpticalFlowSessionCreateFlagBitsNV

The resulting type after applying the ! operator.

not

Method

fn not(self) -> Self

Performs the unary ! operation. Read more

eq

Method

fn eq(&self, other: &OpticalFlowSessionCreateFlagBitsNV) -> bool

Tests for self and other values to be equal, and is used by ==.

Stvk::OpticalFlowSessionCreateInfoNV

pub struct OpticalFlowSessionCreateInfoNV<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub width: u32,
    pub height: u32,
    pub image_format: Format,
    pub flow_vector_format: Format,
    pub cost_format: Format,
    pub output_grid_size: OpticalFlowGridSizeFlagsNV,
    pub hint_grid_size: OpticalFlowGridSizeFlagsNV,
    pub performance_level: OpticalFlowPerformanceLevelNV,
    pub flags: OpticalFlowSessionCreateFlagsNV,
    /* private fields */
}

Native structure VkOpticalFlowSessionCreateInfoNV.

Contract

Native structure VkOpticalFlowSessionCreateInfoNV.

Khronos reference: VkOpticalFlowSessionCreateInfoNV

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

width

Field

width: u32

Native field width.

height

Field

height: u32

Native field height.

image_format

Field

image_format: Format

Native field imageFormat.

flow_vector_format

Field

flow_vector_format: Format

Native field flowVectorFormat.

cost_format

Field

cost_format: Format

Native field costFormat.

output_grid_size

Field

output_grid_size: OpticalFlowGridSizeFlagsNV

Native field outputGridSize.

hint_grid_size

Field

hint_grid_size: OpticalFlowGridSizeFlagsNV

Native field hintGridSize.

performance_level

Field

performance_level: OpticalFlowPerformanceLevelNV

Native field performanceLevel.

flags

Field

flags: OpticalFlowSessionCreateFlagsNV

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_width

Method

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

Set native field width without native effects.

set_height

Method

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

Set native field height without native effects.

set_image_format

Method

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

Set native field imageFormat without native effects.

set_flow_vector_format

Method

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

Set native field flowVectorFormat without native effects.

set_cost_format

Method

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

Set native field costFormat without native effects.

set_output_grid_size

Method

pub fn set_output_grid_size(self, value: OpticalFlowGridSizeFlagsNV) -> Self

Set native field outputGridSize without native effects.

set_hint_grid_size

Method

pub fn set_hint_grid_size(self, value: OpticalFlowGridSizeFlagsNV) -> Self

Set native field hintGridSize without native effects.

set_performance_level

Method

pub fn set_performance_level(self, value: OpticalFlowPerformanceLevelNV) -> Self

Set native field performanceLevel without native effects.

set_flags

Method

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

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::OpticalFlowSessionCreatePrivateDataInfoNV

pub struct OpticalFlowSessionCreatePrivateDataInfoNV<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub id: u32,
    pub size: u32,
    pub p_private_data: *const c_void,
    /* private fields */
}

Native structure VkOpticalFlowSessionCreatePrivateDataInfoNV.

Contract

Native structure VkOpticalFlowSessionCreatePrivateDataInfoNV.

Khronos reference: VkOpticalFlowSessionCreatePrivateDataInfoNV

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

id

Field

id: u32

Native field id.

size

Field

size: u32

Native field size.

p_private_data

Field

p_private_data: *const c_void

Native field pPrivateData.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_id

Method

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

Set native field id without native effects.

set_size

Method

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

Set native field size without native effects.

set_private_data

Method

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

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

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::OpticalFlowSessionNV

#[repr(transparent)]pub struct OpticalFlowSessionNV(pub u64);

Raw Vulkan handle VkOpticalFlowSessionNV.

Contract

Raw Vulkan handle VkOpticalFlowSessionNV.

Khronos reference: VkOpticalFlowSessionNV 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) -> OpticalFlowSessionNV

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() -> Self

Returns the “default value” for a type. Read more

hash

Method

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more

eq

Method

fn eq(&self, other: &OpticalFlowSessionNV) -> bool

Tests for self and other values to be equal, and is used by ==.

Stvk::OpticalFlowUsageFlagBitsNV

#[repr(transparent)]pub struct OpticalFlowUsageFlagBitsNV(pub u32);

Open integer representation of VkOpticalFlowUsageFlagBitsNV.

Contract

Open integer representation of VkOpticalFlowUsageFlagBitsNV.

Khronos reference: VkOpticalFlowUsageFlagBitsNV

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

UNKNOWN_NV

Method

pub const UNKNOWN_NV: Self

Native value VK_OPTICAL_FLOW_USAGE_UNKNOWN_NV.

Khronos reference: VK_OPTICAL_FLOW_USAGE_UNKNOWN_NV

INPUT_BIT_NV

Method

pub const INPUT_BIT_NV: Self

Native value VK_OPTICAL_FLOW_USAGE_INPUT_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_USAGE_INPUT_BIT_NV

OUTPUT_BIT_NV

Method

pub const OUTPUT_BIT_NV: Self

Native value VK_OPTICAL_FLOW_USAGE_OUTPUT_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_USAGE_OUTPUT_BIT_NV

HINT_BIT_NV

Method

pub const HINT_BIT_NV: Self

Native value VK_OPTICAL_FLOW_USAGE_HINT_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_USAGE_HINT_BIT_NV

COST_BIT_NV

Method

pub const COST_BIT_NV: Self

Native value VK_OPTICAL_FLOW_USAGE_COST_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_USAGE_COST_BIT_NV

GLOBAL_FLOW_BIT_NV

Method

pub const GLOBAL_FLOW_BIT_NV: Self

Native value VK_OPTICAL_FLOW_USAGE_GLOBAL_FLOW_BIT_NV.

Khronos reference: VK_OPTICAL_FLOW_USAGE_GLOBAL_FLOW_BIT_NV

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 = OpticalFlowUsageFlagBitsNV

The resulting type after applying the & operator.

bitand

Method

fn bitand(self, rhs: Self) -> Self

Performs the & operation. Read more

Output-1

Method

type Output = OpticalFlowUsageFlagBitsNV

The resulting type after applying the | operator.

bitor

Method

fn bitor(self, rhs: Self) -> Self

Performs the | operation. Read more

Output-2

Method

type Output = OpticalFlowUsageFlagBitsNV

The resulting type after applying the ^ operator.

bitxor

Method

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation. Read more

clone

Method

fn clone(&self) -> OpticalFlowUsageFlagBitsNV

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() -> OpticalFlowUsageFlagBitsNV

Returns the “default value” for a type. Read more

hash

Method

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more

Output-3

Method

type Output = OpticalFlowUsageFlagBitsNV

The resulting type after applying the ! operator.

not

Method

fn not(self) -> Self

Performs the unary ! operation. Read more

eq

Method

fn eq(&self, other: &OpticalFlowUsageFlagBitsNV) -> bool

Tests for self and other values to be equal, and is used by ==.

Stvk::OutOfBandQueueTypeInfoNV

pub struct OutOfBandQueueTypeInfoNV<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub queue_type: OutOfBandQueueTypeNV,
    /* private fields */
}

Native structure VkOutOfBandQueueTypeInfoNV.

Contract

Native structure VkOutOfBandQueueTypeInfoNV.

Khronos reference: VkOutOfBandQueueTypeInfoNV

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

queue_type

Field

queue_type: OutOfBandQueueTypeNV

Native field queueType.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_queue_type

Method

pub fn set_queue_type(self, value: OutOfBandQueueTypeNV) -> Self

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

Errors

Returns a construction error for a changed structure tag or already-linked node.

default

Method

fn default() -> Self

Returns the “default value” for a type. Read more

Stvk::OutOfBandQueueTypeNV

#[repr(transparent)]pub struct OutOfBandQueueTypeNV(pub i32);

Open integer representation of VkOutOfBandQueueTypeNV.

Contract

Open integer representation of VkOutOfBandQueueTypeNV.

Khronos reference: VkOutOfBandQueueTypeNV

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

RENDER_NV

Method

pub const RENDER_NV: Self

Native value VK_OUT_OF_BAND_QUEUE_TYPE_RENDER_NV.

Khronos reference: VK_OUT_OF_BAND_QUEUE_TYPE_RENDER_NV

PRESENT_NV

Method

pub const PRESENT_NV: Self

Native value VK_OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV.

Khronos reference: VK_OUT_OF_BAND_QUEUE_TYPE_PRESENT_NV

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) -> OutOfBandQueueTypeNV

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() -> OutOfBandQueueTypeNV

Returns the “default value” for a type. Read more

hash

Method

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more

eq

Method

fn eq(&self, other: &OutOfBandQueueTypeNV) -> bool

Tests for self and other values to be equal, and is used by ==.