vk · Structs · S6

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

StRustExperimental

Stvk::SparseImageMemoryRequirements2

pub struct SparseImageMemoryRequirements2<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub memory_requirements: SparseImageMemoryRequirements,
    /* private fields */
}

Native structure VkSparseImageMemoryRequirements2.

Contract

Native structure VkSparseImageMemoryRequirements2.

Khronos reference: VkSparseImageMemoryRequirements2

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

memory_requirements

Field

memory_requirements: SparseImageMemoryRequirements

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_requirements

Method

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

default

Method

fn default() -> Self

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

Stvk::SparseImageOpaqueMemoryBindInfo

pub struct SparseImageOpaqueMemoryBindInfo<'a> {
    pub image: Image,
    pub bind_count: u32,
    pub p_binds: *const SparseMemoryBind,
    /* private fields */
}

Native structure VkSparseImageOpaqueMemoryBindInfo.

Contract

Native structure VkSparseImageOpaqueMemoryBindInfo.

Khronos reference: VkSparseImageOpaqueMemoryBindInfo

Fields

image

Field

image: Image

Native field image.

bind_count

Field

bind_count: u32

Native field bindCount.

p_binds

Field

p_binds: *const SparseMemoryBind

Native field pBinds.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_image

Method

pub fn set_image(self, value: Image) -> Self

Set native field image without native effects.

set_bind_count

Method

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

Set native count bindCount 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_binds

Method

pub fn set_binds( self, value: &'a [SparseMemoryBind], ) -> Result<Self, ConstructionError>

Borrow pBinds and set checked native count bindCount. 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.

clone

Method

fn clone(&self) -> SparseImageOpaqueMemoryBindInfo<'a>

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SparseMemoryBind

#[repr(C)]pub struct SparseMemoryBind {
    pub resource_offset: DeviceSize,
    pub size: DeviceSize,
    pub memory: DeviceMemory,
    pub memory_offset: DeviceSize,
    pub flags: SparseMemoryBindFlags,
}

Native structure VkSparseMemoryBind.

Contract

Native structure VkSparseMemoryBind.

Khronos reference: VkSparseMemoryBind

Fields

resource_offset

Field

resource_offset: DeviceSize

Native field resourceOffset.

size

Field

size: DeviceSize

Native field size.

memory

Field

memory: DeviceMemory

Native field memory.

memory_offset

Field

memory_offset: DeviceSize

Native field memoryOffset.

flags

Field

flags: SparseMemoryBindFlags

Native field flags.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_resource_offset

Method

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

Set native field resourceOffset without native effects.

set_size

Method

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

Set native field size without native effects.

set_memory

Method

pub fn set_memory(self, value: DeviceMemory) -> Self

Set native field memory without native effects.

set_memory_offset

Method

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

Set native field memoryOffset without native effects.

set_flags

Method

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

Set native field flags without native effects.

clone

Method

fn clone(&self) -> SparseMemoryBind

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SparseMemoryBindFlagBits

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

Open integer representation of VkSparseMemoryBindFlagBits.

Contract

Open integer representation of VkSparseMemoryBindFlagBits.

Khronos reference: VkSparseMemoryBindFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

METADATA_BIT

Method

pub const METADATA_BIT: Self

Native value VK_SPARSE_MEMORY_BIND_METADATA_BIT.

Khronos reference: VK_SPARSE_MEMORY_BIND_METADATA_BIT

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

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

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

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

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

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

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: &SparseMemoryBindFlagBits) -> bool

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

Stvk::SpecializationInfo

pub struct SpecializationInfo<'a> {
    pub map_entry_count: u32,
    pub p_map_entries: *const SpecializationMapEntry,
    pub data_size: usize,
    pub p_data: *const c_void,
    /* private fields */
}

Native structure VkSpecializationInfo.

Contract

Native structure VkSpecializationInfo.

Khronos reference: VkSpecializationInfo

Fields

map_entry_count

Field

map_entry_count: u32

Native field mapEntryCount.

p_map_entries

Field

p_map_entries: *const SpecializationMapEntry

Native field pMapEntries.

data_size

Field

data_size: usize

Native field dataSize.

p_data

Field

p_data: *const c_void

Native field pData.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_map_entry_count

Method

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

Set native count mapEntryCount 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_map_entries

Method

pub fn set_map_entries( self, value: &'a [SpecializationMapEntry], ) -> Result<Self, ConstructionError>

Borrow pMapEntries and set checked native count mapEntryCount. 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.

set_data_size

Method

pub fn set_data_size(self, value: usize) -> Self

Set native count dataSize 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_data

Method

pub fn set_data(self, value: &'a [u8]) -> Result<Self, ConstructionError>

Borrow pData and set checked native byte size dataSize. 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.

clone

Method

fn clone(&self) -> SpecializationInfo<'a>

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SpecializationMapEntry

#[repr(C)]pub struct SpecializationMapEntry {
    pub constant_id: u32,
    pub offset: u32,
    pub size: usize,
}

Native structure VkSpecializationMapEntry.

Contract

Native structure VkSpecializationMapEntry.

Khronos reference: VkSpecializationMapEntry

Fields

constant_id

Field

constant_id: u32

Native field constantID.

offset

Field

offset: u32

Native field offset.

size

Field

size: usize

Native field size.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_constant_id

Method

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

Set native field constantID without native effects.

set_offset

Method

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

Set native field offset without native effects.

set_size

Method

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

Set native field size without native effects.

clone

Method

fn clone(&self) -> SpecializationMapEntry

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SpirvResourceTypeFlagBitsEXT

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

Open integer representation of VkSpirvResourceTypeFlagBitsEXT.

Contract

Open integer representation of VkSpirvResourceTypeFlagBitsEXT.

Khronos reference: VkSpirvResourceTypeFlagBitsEXT

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

ALL_EXT

Method

pub const ALL_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_ALL_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_ALL_EXT

SAMPLER_BIT_EXT

Method

pub const SAMPLER_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_SAMPLER_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_SAMPLER_BIT_EXT

SAMPLED_IMAGE_BIT_EXT

Method

pub const SAMPLED_IMAGE_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_SAMPLED_IMAGE_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_SAMPLED_IMAGE_BIT_EXT

READ_ONLY_IMAGE_BIT_EXT

Method

pub const READ_ONLY_IMAGE_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_READ_ONLY_IMAGE_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_READ_ONLY_IMAGE_BIT_EXT

READ_WRITE_IMAGE_BIT_EXT

Method

pub const READ_WRITE_IMAGE_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_READ_WRITE_IMAGE_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_READ_WRITE_IMAGE_BIT_EXT

COMBINED_SAMPLED_IMAGE_BIT_EXT

Method

pub const COMBINED_SAMPLED_IMAGE_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_COMBINED_SAMPLED_IMAGE_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_COMBINED_SAMPLED_IMAGE_BIT_EXT

UNIFORM_BUFFER_BIT_EXT

Method

pub const UNIFORM_BUFFER_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_UNIFORM_BUFFER_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_UNIFORM_BUFFER_BIT_EXT

READ_ONLY_STORAGE_BUFFER_BIT_EXT

Method

pub const READ_ONLY_STORAGE_BUFFER_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_READ_ONLY_STORAGE_BUFFER_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_READ_ONLY_STORAGE_BUFFER_BIT_EXT

READ_WRITE_STORAGE_BUFFER_BIT_EXT

Method

pub const READ_WRITE_STORAGE_BUFFER_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_READ_WRITE_STORAGE_BUFFER_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_READ_WRITE_STORAGE_BUFFER_BIT_EXT

ACCELERATION_STRUCTURE_BIT_EXT

Method

pub const ACCELERATION_STRUCTURE_BIT_EXT: Self

Native value VK_SPIRV_RESOURCE_TYPE_ACCELERATION_STRUCTURE_BIT_EXT.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_ACCELERATION_STRUCTURE_BIT_EXT

TENSOR_BIT_ARM

Method

pub const TENSOR_BIT_ARM: Self

Native value VK_SPIRV_RESOURCE_TYPE_TENSOR_BIT_ARM.

Khronos reference: VK_SPIRV_RESOURCE_TYPE_TENSOR_BIT_ARM

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

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

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

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

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

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

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: &SpirvResourceTypeFlagBitsEXT) -> bool

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

Stvk::SRTDataNV

#[repr(C)]pub struct SRTDataNV {
    pub sx: f32,
    pub a: f32,
    pub b: f32,
    pub pvx: f32,
    pub sy: f32,
    pub c: f32,
    pub pvy: f32,
    pub sz: f32,
    pub pvz: f32,
    pub qx: f32,
    pub qy: f32,
    pub qz: f32,
    pub qw: f32,
    pub tx: f32,
    pub ty: f32,
    pub tz: f32,
}

Native structure VkSRTDataNV.

Contract

Native structure VkSRTDataNV.

Khronos reference: VkSRTDataNV

Fields

sx

Field

sx: f32

Native field sx.

a

Field

a: f32

Native field a.

b

Field

b: f32

Native field b.

pvx

Field

pvx: f32

Native field pvx.

sy

Field

sy: f32

Native field sy.

c

Field

c: f32

Native field c.

pvy

Field

pvy: f32

Native field pvy.

sz

Field

sz: f32

Native field sz.

pvz

Field

pvz: f32

Native field pvz.

qx

Field

qx: f32

Native field qx.

qy

Field

qy: f32

Native field qy.

qz

Field

qz: f32

Native field qz.

qw

Field

qw: f32

Native field qw.

tx

Field

tx: f32

Native field tx.

ty

Field

ty: f32

Native field ty.

tz

Field

tz: f32

Native field tz.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_sx

Method

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

Set native field sx without native effects.

set_a

Method

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

Set native field a without native effects.

set_b

Method

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

Set native field b without native effects.

set_pvx

Method

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

Set native field pvx without native effects.

set_sy

Method

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

Set native field sy without native effects.

set_c

Method

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

Set native field c without native effects.

set_pvy

Method

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

Set native field pvy without native effects.

set_sz

Method

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

Set native field sz without native effects.

set_pvz

Method

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

Set native field pvz without native effects.

set_qx

Method

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

Set native field qx without native effects.

set_qy

Method

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

Set native field qy without native effects.

set_qz

Method

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

Set native field qz without native effects.

set_qw

Method

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

Set native field qw without native effects.

set_tx

Method

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

Set native field tx without native effects.

set_ty

Method

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

Set native field ty without native effects.

set_tz

Method

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

Set native field tz without native effects.

clone

Method

fn clone(&self) -> SRTDataNV

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::StdVideoAV1CDEF

#[repr(C)]pub struct StdVideoAV1CDEF {
    pub cdef_damping_minus_3: u8,
    pub cdef_bits: u8,
    pub cdef_y_pri_strength: [u8; 8],
    pub cdef_y_sec_strength: [u8; 8],
    pub cdef_uv_pri_strength: [u8; 8],
    pub cdef_uv_sec_strength: [u8; 8],
}

Native structure StdVideoAV1CDEF.

Contract

Native structure StdVideoAV1CDEF.

Khronos registry source: StdVideoAV1CDEF

Fields

cdef_damping_minus_3

Field

cdef_damping_minus_3: u8

Native field cdef_damping_minus_3.

cdef_bits

Field

cdef_bits: u8

Native field cdef_bits.

cdef_y_pri_strength

Field

cdef_y_pri_strength: [u8; 8]

Native field cdef_y_pri_strength.

cdef_y_sec_strength

Field

cdef_y_sec_strength: [u8; 8]

Native field cdef_y_sec_strength.

cdef_uv_pri_strength

Field

cdef_uv_pri_strength: [u8; 8]

Native field cdef_uv_pri_strength.

cdef_uv_sec_strength

Field

cdef_uv_sec_strength: [u8; 8]

Native field cdef_uv_sec_strength.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_cdef_damping_minus_3

Method

pub fn set_cdef_damping_minus_3(self, value: u8) -> Self

Set native field cdef_damping_minus_3 without native effects.

set_cdef_bits

Method

pub fn set_cdef_bits(self, value: u8) -> Self

Set native field cdef_bits without native effects.

set_cdef_y_pri_strength

Method

pub fn set_cdef_y_pri_strength(self, value: [u8; 8]) -> Self

Set native field cdef_y_pri_strength without native effects.

set_cdef_y_sec_strength

Method

pub fn set_cdef_y_sec_strength(self, value: [u8; 8]) -> Self

Set native field cdef_y_sec_strength without native effects.

set_cdef_uv_pri_strength

Method

pub fn set_cdef_uv_pri_strength(self, value: [u8; 8]) -> Self

Set native field cdef_uv_pri_strength without native effects.

set_cdef_uv_sec_strength

Method

pub fn set_cdef_uv_sec_strength(self, value: [u8; 8]) -> Self

Set native field cdef_uv_sec_strength without native effects.

clone

Method

fn clone(&self) -> StdVideoAV1CDEF

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::StdVideoAV1ChromaSamplePosition

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

Open integer representation of StdVideoAV1ChromaSamplePosition.

Contract

Open integer representation of StdVideoAV1ChromaSamplePosition.

Khronos registry source: StdVideoAV1ChromaSamplePosition

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

UNKNOWN

Method

pub const UNKNOWN: Self

Native value STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_UNKNOWN.

Khronos registry source: STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_UNKNOWN

VERTICAL

Method

pub const VERTICAL: Self

Native value STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_VERTICAL.

Khronos registry source: STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_VERTICAL

COLOCATED

Method

pub const COLOCATED: Self

Native value STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_COLOCATED.

Khronos registry source: STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_COLOCATED

RESERVED

Method

pub const RESERVED: Self

Native value STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_RESERVED.

Khronos registry source: STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_RESERVED

INVALID

Method

pub const INVALID: Self

Native value STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_INVALID.

Khronos registry source: STD_VIDEO_AV1_CHROMA_SAMPLE_POSITION_INVALID

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

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

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: &StdVideoAV1ChromaSamplePosition) -> bool

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

Stvk::StdVideoAV1ColorConfig

#[repr(C)]pub struct StdVideoAV1ColorConfig {
    pub flags: StdVideoAV1ColorConfigFlags,
    pub bit_depth: u8,
    pub subsampling_x: u8,
    pub subsampling_y: u8,
    pub reserved1: u8,
    pub color_primaries: StdVideoAV1ColorPrimaries,
    pub transfer_characteristics: StdVideoAV1TransferCharacteristics,
    pub matrix_coefficients: StdVideoAV1MatrixCoefficients,
    pub chroma_sample_position: StdVideoAV1ChromaSamplePosition,
}

Native structure StdVideoAV1ColorConfig.

Contract

Native structure StdVideoAV1ColorConfig.

Khronos registry source: StdVideoAV1ColorConfig

Fields

flags

Field

flags: StdVideoAV1ColorConfigFlags

Native field flags.

bit_depth

Field

bit_depth: u8

Native field BitDepth.

subsampling_x

Field

subsampling_x: u8

Native field subsampling_x.

subsampling_y

Field

subsampling_y: u8

Native field subsampling_y.

reserved1

Field

reserved1: u8

Native field reserved1.

color_primaries

Field

color_primaries: StdVideoAV1ColorPrimaries

Native field color_primaries.

transfer_characteristics

Field

transfer_characteristics: StdVideoAV1TransferCharacteristics

Native field transfer_characteristics.

matrix_coefficients

Field

matrix_coefficients: StdVideoAV1MatrixCoefficients

Native field matrix_coefficients.

chroma_sample_position

Field

chroma_sample_position: StdVideoAV1ChromaSamplePosition

Native field chroma_sample_position.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_flags

Method

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

Set native field flags without native effects.

set_bit_depth

Method

pub fn set_bit_depth(self, value: u8) -> Self

Set native field BitDepth without native effects.

set_subsampling_x

Method

pub fn set_subsampling_x(self, value: u8) -> Self

Set native field subsampling_x without native effects.

set_subsampling_y

Method

pub fn set_subsampling_y(self, value: u8) -> Self

Set native field subsampling_y without native effects.

set_reserved1

Method

pub fn set_reserved1(self, value: u8) -> Self

Set native field reserved1 without native effects.

set_color_primaries

Method

pub fn set_color_primaries(self, value: StdVideoAV1ColorPrimaries) -> Self

Set native field color_primaries without native effects.

set_transfer_characteristics

Method

pub fn set_transfer_characteristics( self, value: StdVideoAV1TransferCharacteristics, ) -> Self

Set native field transfer_characteristics without native effects.

set_matrix_coefficients

Method

pub fn set_matrix_coefficients( self, value: StdVideoAV1MatrixCoefficients, ) -> Self

Set native field matrix_coefficients without native effects.

set_chroma_sample_position

Method

pub fn set_chroma_sample_position( self, value: StdVideoAV1ChromaSamplePosition, ) -> Self

Set native field chroma_sample_position without native effects.

clone

Method

fn clone(&self) -> StdVideoAV1ColorConfig

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::StdVideoAV1ColorConfigFlags

#[repr(C)]pub struct StdVideoAV1ColorConfigFlags {
    pub _bitfield_1: u32,
}

Native structure StdVideoAV1ColorConfigFlags.

Contract

Native structure StdVideoAV1ColorConfigFlags.

Khronos registry source: StdVideoAV1ColorConfigFlags

Fields

_bitfield_1

Field

_bitfield_1: u32

No public source comment is attached to this declaration.

Methods and associated items

mono_chrome

Method

pub const fn mono_chrome(&self) -> u32

Read native bitfield mono_chrome.

set_mono_chrome

Method

pub fn set_mono_chrome(&mut self, value: u32)

Set native bitfield mono_chrome, retaining its low 1 bits.

color_range

Method

pub const fn color_range(&self) -> u32

Read native bitfield color_range.

set_color_range

Method

pub fn set_color_range(&mut self, value: u32)

Set native bitfield color_range, retaining its low 1 bits.

separate_uv_delta_q

Method

pub const fn separate_uv_delta_q(&self) -> u32

Read native bitfield separate_uv_delta_q.

set_separate_uv_delta_q

Method

pub fn set_separate_uv_delta_q(&mut self, value: u32)

Set native bitfield separate_uv_delta_q, retaining its low 1 bits.

color_description_present_flag

Method

pub const fn color_description_present_flag(&self) -> u32

Read native bitfield color_description_present_flag.

set_color_description_present_flag

Method

pub fn set_color_description_present_flag(&mut self, value: u32)

Set native bitfield color_description_present_flag, retaining its low 1 bits.

reserved

Method

pub const fn reserved(&self) -> u32

Read native bitfield reserved.

set_reserved

Method

pub fn set_reserved(&mut self, value: u32)

Set native bitfield reserved, retaining its low 28 bits.

new

Method

pub fn new() -> Self

Construct the record with its default native state.

clone

Method

fn clone(&self) -> StdVideoAV1ColorConfigFlags

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::StdVideoAV1ColorPrimaries

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

Open integer representation of StdVideoAV1ColorPrimaries.

Contract

Open integer representation of StdVideoAV1ColorPrimaries.

Khronos registry source: StdVideoAV1ColorPrimaries

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

BT_709

Method

pub const BT_709: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_BT_709.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_BT_709

UNSPECIFIED

Method

pub const UNSPECIFIED: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_UNSPECIFIED.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_UNSPECIFIED

BT_UNSPECIFIED

Method

pub const BT_UNSPECIFIED: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_BT_UNSPECIFIED.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_BT_UNSPECIFIED

BT_470_M

Method

pub const BT_470_M: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_BT_470_M.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_BT_470_M

BT_470_B_G

Method

pub const BT_470_B_G: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_BT_470_B_G.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_BT_470_B_G

BT_601

Method

pub const BT_601: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_BT_601.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_BT_601

SMPTE_240

Method

pub const SMPTE_240: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_SMPTE_240.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_SMPTE_240

GENERIC_FILM

Method

pub const GENERIC_FILM: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_GENERIC_FILM.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_GENERIC_FILM

BT_2020

Method

pub const BT_2020: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_BT_2020.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_BT_2020

XYZ

Method

pub const XYZ: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_XYZ.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_XYZ

SMPTE_431

Method

pub const SMPTE_431: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_SMPTE_431.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_SMPTE_431

SMPTE_432

Method

pub const SMPTE_432: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_SMPTE_432.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_SMPTE_432

EBU_3213

Method

pub const EBU_3213: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_EBU_3213.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_EBU_3213

INVALID

Method

pub const INVALID: Self

Native value STD_VIDEO_AV1_COLOR_PRIMARIES_INVALID.

Khronos registry source: STD_VIDEO_AV1_COLOR_PRIMARIES_INVALID

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

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

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: &StdVideoAV1ColorPrimaries) -> bool

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

Stvk::StdVideoAV1FilmGrain

#[repr(C)]pub struct StdVideoAV1FilmGrain {
    pub flags: StdVideoAV1FilmGrainFlags,
    pub grain_scaling_minus_8: u8,
    pub ar_coeff_lag: u8,
    pub ar_coeff_shift_minus_6: u8,
    pub grain_scale_shift: u8,
    pub grain_seed: u16,
    pub film_grain_params_ref_idx: u8,
    pub num_y_points: u8,
    pub point_y_value: [u8; 14],
    pub point_y_scaling: [u8; 14],
    pub num_cb_points: u8,
    pub point_cb_value: [u8; 10],
    pub point_cb_scaling: [u8; 10],
    pub num_cr_points: u8,
    pub point_cr_value: [u8; 10],
    pub point_cr_scaling: [u8; 10],
    pub ar_coeffs_y_plus_128: [i8; 24],
    pub ar_coeffs_cb_plus_128: [i8; 25],
    pub ar_coeffs_cr_plus_128: [i8; 25],
    pub cb_mult: u8,
    pub cb_luma_mult: u8,
    pub cb_offset: u16,
    pub cr_mult: u8,
    pub cr_luma_mult: u8,
    pub cr_offset: u16,
}

Native structure StdVideoAV1FilmGrain.

Contract

Native structure StdVideoAV1FilmGrain.

Khronos registry source: StdVideoAV1FilmGrain

Fields

flags

Field

flags: StdVideoAV1FilmGrainFlags

Native field flags.

grain_scaling_minus_8

Field

grain_scaling_minus_8: u8

Native field grain_scaling_minus_8.

ar_coeff_lag

Field

ar_coeff_lag: u8

Native field ar_coeff_lag.

ar_coeff_shift_minus_6

Field

ar_coeff_shift_minus_6: u8

Native field ar_coeff_shift_minus_6.

grain_scale_shift

Field

grain_scale_shift: u8

Native field grain_scale_shift.

grain_seed

Field

grain_seed: u16

Native field grain_seed.

film_grain_params_ref_idx

Field

film_grain_params_ref_idx: u8

Native field film_grain_params_ref_idx.

num_y_points

Field

num_y_points: u8

Native field num_y_points.

point_y_value

Field

point_y_value: [u8; 14]

Native field point_y_value.

point_y_scaling

Field

point_y_scaling: [u8; 14]

Native field point_y_scaling.

num_cb_points

Field

num_cb_points: u8

Native field num_cb_points.

point_cb_value

Field

point_cb_value: [u8; 10]

Native field point_cb_value.

point_cb_scaling

Field

point_cb_scaling: [u8; 10]

Native field point_cb_scaling.

num_cr_points

Field

num_cr_points: u8

Native field num_cr_points.

point_cr_value

Field

point_cr_value: [u8; 10]

Native field point_cr_value.

point_cr_scaling

Field

point_cr_scaling: [u8; 10]

Native field point_cr_scaling.

ar_coeffs_y_plus_128

Field

ar_coeffs_y_plus_128: [i8; 24]

Native field ar_coeffs_y_plus_128.

ar_coeffs_cb_plus_128

Field

ar_coeffs_cb_plus_128: [i8; 25]

Native field ar_coeffs_cb_plus_128.

ar_coeffs_cr_plus_128

Field

ar_coeffs_cr_plus_128: [i8; 25]

Native field ar_coeffs_cr_plus_128.

cb_mult

Field

cb_mult: u8

Native field cb_mult.

cb_luma_mult

Field

cb_luma_mult: u8

Native field cb_luma_mult.

cb_offset

Field

cb_offset: u16

Native field cb_offset.

cr_mult

Field

cr_mult: u8

Native field cr_mult.

cr_luma_mult

Field

cr_luma_mult: u8

Native field cr_luma_mult.

cr_offset

Field

cr_offset: u16

Native field cr_offset.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_flags

Method

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

Set native field flags without native effects.

set_grain_scaling_minus_8

Method

pub fn set_grain_scaling_minus_8(self, value: u8) -> Self

Set native field grain_scaling_minus_8 without native effects.

set_ar_coeff_lag

Method

pub fn set_ar_coeff_lag(self, value: u8) -> Self

Set native field ar_coeff_lag without native effects.

set_ar_coeff_shift_minus_6

Method

pub fn set_ar_coeff_shift_minus_6(self, value: u8) -> Self

Set native field ar_coeff_shift_minus_6 without native effects.

set_grain_scale_shift

Method

pub fn set_grain_scale_shift(self, value: u8) -> Self

Set native field grain_scale_shift without native effects.

set_grain_seed

Method

pub fn set_grain_seed(self, value: u16) -> Self

Set native field grain_seed without native effects.

set_film_grain_params_ref_idx

Method

pub fn set_film_grain_params_ref_idx(self, value: u8) -> Self

Set native field film_grain_params_ref_idx without native effects.

set_num_y_points

Method

pub fn set_num_y_points(self, value: u8) -> Self

Set native field num_y_points without native effects.

set_point_y_value

Method

pub fn set_point_y_value(self, value: [u8; 14]) -> Self

Set native field point_y_value without native effects.

set_point_y_scaling

Method

pub fn set_point_y_scaling(self, value: [u8; 14]) -> Self

Set native field point_y_scaling without native effects.

set_num_cb_points

Method

pub fn set_num_cb_points(self, value: u8) -> Self

Set native field num_cb_points without native effects.

set_point_cb_value

Method

pub fn set_point_cb_value(self, value: [u8; 10]) -> Self

Set native field point_cb_value without native effects.

set_point_cb_scaling

Method

pub fn set_point_cb_scaling(self, value: [u8; 10]) -> Self

Set native field point_cb_scaling without native effects.

set_num_cr_points

Method

pub fn set_num_cr_points(self, value: u8) -> Self

Set native field num_cr_points without native effects.

set_point_cr_value

Method

pub fn set_point_cr_value(self, value: [u8; 10]) -> Self

Set native field point_cr_value without native effects.

set_point_cr_scaling

Method

pub fn set_point_cr_scaling(self, value: [u8; 10]) -> Self

Set native field point_cr_scaling without native effects.

set_ar_coeffs_y_plus_128

Method

pub fn set_ar_coeffs_y_plus_128(self, value: [i8; 24]) -> Self

Set native field ar_coeffs_y_plus_128 without native effects.

set_ar_coeffs_cb_plus_128

Method

pub fn set_ar_coeffs_cb_plus_128(self, value: [i8; 25]) -> Self

Set native field ar_coeffs_cb_plus_128 without native effects.

set_ar_coeffs_cr_plus_128

Method

pub fn set_ar_coeffs_cr_plus_128(self, value: [i8; 25]) -> Self

Set native field ar_coeffs_cr_plus_128 without native effects.

set_cb_mult

Method

pub fn set_cb_mult(self, value: u8) -> Self

Set native field cb_mult without native effects.

set_cb_luma_mult

Method

pub fn set_cb_luma_mult(self, value: u8) -> Self

Set native field cb_luma_mult without native effects.

set_cb_offset

Method

pub fn set_cb_offset(self, value: u16) -> Self

Set native field cb_offset without native effects.

set_cr_mult

Method

pub fn set_cr_mult(self, value: u8) -> Self

Set native field cr_mult without native effects.

set_cr_luma_mult

Method

pub fn set_cr_luma_mult(self, value: u8) -> Self

Set native field cr_luma_mult without native effects.

set_cr_offset

Method

pub fn set_cr_offset(self, value: u16) -> Self

Set native field cr_offset without native effects.

clone

Method

fn clone(&self) -> StdVideoAV1FilmGrain

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::StdVideoAV1FilmGrainFlags

#[repr(C)]pub struct StdVideoAV1FilmGrainFlags {
    pub _bitfield_1: u32,
}

Native structure StdVideoAV1FilmGrainFlags.

Contract

Native structure StdVideoAV1FilmGrainFlags.

Khronos registry source: StdVideoAV1FilmGrainFlags

Fields

_bitfield_1

Field

_bitfield_1: u32

No public source comment is attached to this declaration.

Methods and associated items

chroma_scaling_from_luma

Method

pub const fn chroma_scaling_from_luma(&self) -> u32

Read native bitfield chroma_scaling_from_luma.

set_chroma_scaling_from_luma

Method

pub fn set_chroma_scaling_from_luma(&mut self, value: u32)

Set native bitfield chroma_scaling_from_luma, retaining its low 1 bits.

overlap_flag

Method

pub const fn overlap_flag(&self) -> u32

Read native bitfield overlap_flag.

set_overlap_flag

Method

pub fn set_overlap_flag(&mut self, value: u32)

Set native bitfield overlap_flag, retaining its low 1 bits.

clip_to_restricted_range

Method

pub const fn clip_to_restricted_range(&self) -> u32

Read native bitfield clip_to_restricted_range.

set_clip_to_restricted_range

Method

pub fn set_clip_to_restricted_range(&mut self, value: u32)

Set native bitfield clip_to_restricted_range, retaining its low 1 bits.

update_grain

Method

pub const fn update_grain(&self) -> u32

Read native bitfield update_grain.

set_update_grain

Method

pub fn set_update_grain(&mut self, value: u32)

Set native bitfield update_grain, retaining its low 1 bits.

reserved

Method

pub const fn reserved(&self) -> u32

Read native bitfield reserved.

set_reserved

Method

pub fn set_reserved(&mut self, value: u32)

Set native bitfield reserved, retaining its low 28 bits.

new

Method

pub fn new() -> Self

Construct the record with its default native state.

clone

Method

fn clone(&self) -> StdVideoAV1FilmGrainFlags

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::StdVideoAV1FrameRestorationType

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

Open integer representation of StdVideoAV1FrameRestorationType.

Contract

Open integer representation of StdVideoAV1FrameRestorationType.

Khronos registry source: StdVideoAV1FrameRestorationType

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

NONE

Method

pub const NONE: Self

Native value STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_NONE.

Khronos registry source: STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_NONE

WIENER

Method

pub const WIENER: Self

Native value STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_WIENER.

Khronos registry source: STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_WIENER

SGRPROJ

Method

pub const SGRPROJ: Self

Native value STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_SGRPROJ.

Khronos registry source: STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_SGRPROJ

SWITCHABLE

Method

pub const SWITCHABLE: Self

Native value STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_SWITCHABLE.

Khronos registry source: STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_SWITCHABLE

INVALID

Method

pub const INVALID: Self

Native value STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_INVALID.

Khronos registry source: STD_VIDEO_AV1_FRAME_RESTORATION_TYPE_INVALID

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

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

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: &StdVideoAV1FrameRestorationType) -> bool

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