vk · Structs · H1 · VK

Stvk::HdrMetadataEXT

pub struct HdrMetadataEXT<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub display_primary_red: XYColorEXT,
    pub display_primary_green: XYColorEXT,
    pub display_primary_blue: XYColorEXT,
    pub white_point: XYColorEXT,
    pub max_luminance: f32,
    pub min_luminance: f32,
    pub max_content_light_level: f32,
    pub max_frame_average_light_level: f32,
    /* private fields */
}

Native structure VkHdrMetadataEXT.

Contract

Native structure VkHdrMetadataEXT.

Khronos reference: VkHdrMetadataEXT

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

display_primary_red

Field

display_primary_red: XYColorEXT

Native field displayPrimaryRed.

display_primary_green

Field

display_primary_green: XYColorEXT

Native field displayPrimaryGreen.

display_primary_blue

Field

display_primary_blue: XYColorEXT

Native field displayPrimaryBlue.

white_point

Field

white_point: XYColorEXT

Native field whitePoint.

max_luminance

Field

max_luminance: f32

Native field maxLuminance.

min_luminance

Field

min_luminance: f32

Native field minLuminance.

max_content_light_level

Field

max_content_light_level: f32

Native field maxContentLightLevel.

max_frame_average_light_level

Field

max_frame_average_light_level: f32

Native field maxFrameAverageLightLevel.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_display_primary_red

Method

pub fn set_display_primary_red(self, value: XYColorEXT) -> Self

Set native field displayPrimaryRed without native effects.

set_display_primary_green

Method

pub fn set_display_primary_green(self, value: XYColorEXT) -> Self

Set native field displayPrimaryGreen without native effects.

set_display_primary_blue

Method

pub fn set_display_primary_blue(self, value: XYColorEXT) -> Self

Set native field displayPrimaryBlue without native effects.

set_white_point

Method

pub fn set_white_point(self, value: XYColorEXT) -> Self

Set native field whitePoint without native effects.

set_max_luminance

Method

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

Set native field maxLuminance without native effects.

set_min_luminance

Method

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

Set native field minLuminance without native effects.

set_max_content_light_level

Method

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

Set native field maxContentLightLevel without native effects.

set_max_frame_average_light_level

Method

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

Set native field maxFrameAverageLightLevel 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::HdrVividDynamicMetadataHUAWEI

pub struct HdrVividDynamicMetadataHUAWEI<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub dynamic_metadata_size: usize,
    pub p_dynamic_metadata: *const c_void,
    /* private fields */
}

Native structure VkHdrVividDynamicMetadataHUAWEI.

Contract

Native structure VkHdrVividDynamicMetadataHUAWEI.

Khronos reference: VkHdrVividDynamicMetadataHUAWEI

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

dynamic_metadata_size

Field

dynamic_metadata_size: usize

Native field dynamicMetadataSize.

p_dynamic_metadata

Field

p_dynamic_metadata: *const c_void

Native field pDynamicMetadata.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_dynamic_metadata_size

Method

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

Set native count dynamicMetadataSize 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_dynamic_metadata

Method

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

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

default

Method

fn default() -> Self

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

Stvk::HeadlessSurfaceCreateFlagsEXT

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

Open integer representation of VkHeadlessSurfaceCreateFlagsEXT.

Contract

Open integer representation of VkHeadlessSurfaceCreateFlagsEXT.

Khronos reference: VkHeadlessSurfaceCreateFlagsEXT

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

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

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

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

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

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

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

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

Stvk::HeadlessSurfaceCreateInfoEXT

pub struct HeadlessSurfaceCreateInfoEXT<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub flags: HeadlessSurfaceCreateFlagsEXT,
    /* private fields */
}

Native structure VkHeadlessSurfaceCreateInfoEXT.

Contract

Native structure VkHeadlessSurfaceCreateInfoEXT.

Khronos reference: VkHeadlessSurfaceCreateInfoEXT

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

flags

Field

flags: HeadlessSurfaceCreateFlagsEXT

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_flags

Method

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

pub struct HostAddressRangeConstEXT<'a> {
    pub address: *const c_void,
    pub size: usize,
    /* private fields */
}

Native structure VkHostAddressRangeConstEXT.

Contract

Native structure VkHostAddressRangeConstEXT.

Khronos reference: VkHostAddressRangeConstEXT

Fields

address

Field

address: *const c_void

Native field address.

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_address

Method

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

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

Method

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

Set native count size 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.

clone

Method

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

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::HostAddressRangeEXT

pub struct HostAddressRangeEXT<'a> {
    pub address: *mut c_void,
    pub size: usize,
    /* private fields */
}

Native structure VkHostAddressRangeEXT.

Contract

Native structure VkHostAddressRangeEXT.

Khronos reference: VkHostAddressRangeEXT

Fields

address

Field

address: *mut c_void

Native field address.

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_address

Method

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

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

Method

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

Set native count size 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.

default

Method

fn default() -> Self

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

Stvk::HostImageCopyDevicePerformanceQuery

pub struct HostImageCopyDevicePerformanceQuery<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub optimal_device_access: Bool32,
    pub identical_memory_layout: Bool32,
    /* private fields */
}

Native structure VkHostImageCopyDevicePerformanceQuery.

Contract

Native structure VkHostImageCopyDevicePerformanceQuery.

Khronos reference: VkHostImageCopyDevicePerformanceQuery

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

optimal_device_access

Field

optimal_device_access: Bool32

Native field optimalDeviceAccess.

identical_memory_layout

Field

identical_memory_layout: Bool32

Native field identicalMemoryLayout.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_optimal_device_access

Method

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

Set native field optimalDeviceAccess without native effects.

set_identical_memory_layout

Method

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

Set native field identicalMemoryLayout 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::HostImageCopyFlagBits

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

Open integer representation of VkHostImageCopyFlagBits.

Contract

Open integer representation of VkHostImageCopyFlagBits.

Khronos reference: VkHostImageCopyFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

MEMCPY_BIT

Method

pub const MEMCPY_BIT: Self

Native value VK_HOST_IMAGE_COPY_MEMCPY_BIT.

Khronos reference: VK_HOST_IMAGE_COPY_MEMCPY_BIT

MEMCPY

Method

pub const MEMCPY: Self

Native value VK_HOST_IMAGE_COPY_MEMCPY.

Khronos reference: VK_HOST_IMAGE_COPY_MEMCPY

MEMCPY_BIT_EXT

Method

pub const MEMCPY_BIT_EXT: Self

Native value VK_HOST_IMAGE_COPY_MEMCPY_BIT_EXT.

Khronos reference: VK_HOST_IMAGE_COPY_MEMCPY_BIT_EXT

MEMCPY_EXT

Method

pub const MEMCPY_EXT: Self

Native value VK_HOST_IMAGE_COPY_MEMCPY_EXT.

Khronos reference: VK_HOST_IMAGE_COPY_MEMCPY_EXT

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

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

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

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

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

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

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

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

Stvk::HostImageLayoutTransitionInfo

pub struct HostImageLayoutTransitionInfo<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub image: Image,
    pub old_layout: ImageLayout,
    pub new_layout: ImageLayout,
    pub subresource_range: ImageSubresourceRange,
    /* private fields */
}

Native structure VkHostImageLayoutTransitionInfo.

Contract

Native structure VkHostImageLayoutTransitionInfo.

Khronos reference: VkHostImageLayoutTransitionInfo

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

image

Field

image: Image

Native field image.

old_layout

Field

old_layout: ImageLayout

Native field oldLayout.

new_layout

Field

new_layout: ImageLayout

Native field newLayout.

subresource_range

Field

subresource_range: ImageSubresourceRange

Native field subresourceRange.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_image

Method

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

Set native field image without native effects.

set_old_layout

Method

pub fn set_old_layout(self, value: ImageLayout) -> Self

Set native field oldLayout without native effects.

set_new_layout

Method

pub fn set_new_layout(self, value: ImageLayout) -> Self

Set native field newLayout without native effects.

set_subresource_range

Method

pub fn set_subresource_range(self, value: ImageSubresourceRange) -> Self

Set native field subresourceRange 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