vk · Structs · S5

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

StRustExperimental

Stvk::ShaderModuleValidationCacheCreateInfoEXT

pub struct ShaderModuleValidationCacheCreateInfoEXT<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub validation_cache: ValidationCacheEXT,
    /* private fields */
}

Native structure VkShaderModuleValidationCacheCreateInfoEXT.

Contract

Native structure VkShaderModuleValidationCacheCreateInfoEXT.

Khronos reference: VkShaderModuleValidationCacheCreateInfoEXT

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

validation_cache

Field

validation_cache: ValidationCacheEXT

Native field validationCache.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_validation_cache

Method

pub fn set_validation_cache(self, value: ValidationCacheEXT) -> Self

Set native field validationCache 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::ShaderResourceUsageAMD

#[repr(C)]pub struct ShaderResourceUsageAMD {
    pub num_used_vgprs: u32,
    pub num_used_sgprs: u32,
    pub lds_size_per_local_work_group: u32,
    pub lds_usage_size_in_bytes: usize,
    pub scratch_mem_usage_in_bytes: usize,
}

Native structure VkShaderResourceUsageAMD.

Contract

Native structure VkShaderResourceUsageAMD.

Khronos reference: VkShaderResourceUsageAMD

Fields

num_used_vgprs

Field

num_used_vgprs: u32

Native field numUsedVgprs.

num_used_sgprs

Field

num_used_sgprs: u32

Native field numUsedSgprs.

lds_size_per_local_work_group

Field

lds_size_per_local_work_group: u32

Native field ldsSizePerLocalWorkGroup.

lds_usage_size_in_bytes

Field

lds_usage_size_in_bytes: usize

Native field ldsUsageSizeInBytes.

scratch_mem_usage_in_bytes

Field

scratch_mem_usage_in_bytes: usize

Native field scratchMemUsageInBytes.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_num_used_vgprs

Method

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

Set native field numUsedVgprs without native effects.

set_num_used_sgprs

Method

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

Set native field numUsedSgprs without native effects.

set_lds_size_per_local_work_group

Method

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

Set native field ldsSizePerLocalWorkGroup without native effects.

set_lds_usage_size_in_bytes

Method

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

Set native field ldsUsageSizeInBytes without native effects.

set_scratch_mem_usage_in_bytes

Method

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

Set native field scratchMemUsageInBytes without native effects.

clone

Method

fn clone(&self) -> ShaderResourceUsageAMD

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::ShaderStageFlagBits

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

Open integer representation of VkShaderStageFlagBits.

Contract

Open integer representation of VkShaderStageFlagBits.

Khronos reference: VkShaderStageFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

VERTEX_BIT

Method

pub const VERTEX_BIT: Self

Native value VK_SHADER_STAGE_VERTEX_BIT.

Khronos reference: VK_SHADER_STAGE_VERTEX_BIT

TESSELLATION_CONTROL_BIT

Method

pub const TESSELLATION_CONTROL_BIT: Self

Native value VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT.

Khronos reference: VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT

TESSELLATION_EVALUATION_BIT

Method

pub const TESSELLATION_EVALUATION_BIT: Self

Native value VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT.

Khronos reference: VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT

GEOMETRY_BIT

Method

pub const GEOMETRY_BIT: Self

Native value VK_SHADER_STAGE_GEOMETRY_BIT.

Khronos reference: VK_SHADER_STAGE_GEOMETRY_BIT

FRAGMENT_BIT

Method

pub const FRAGMENT_BIT: Self

Native value VK_SHADER_STAGE_FRAGMENT_BIT.

Khronos reference: VK_SHADER_STAGE_FRAGMENT_BIT

COMPUTE_BIT

Method

pub const COMPUTE_BIT: Self

Native value VK_SHADER_STAGE_COMPUTE_BIT.

Khronos reference: VK_SHADER_STAGE_COMPUTE_BIT

ALL_GRAPHICS

Method

pub const ALL_GRAPHICS: Self

Native value VK_SHADER_STAGE_ALL_GRAPHICS.

Khronos reference: VK_SHADER_STAGE_ALL_GRAPHICS

ALL

Method

pub const ALL: Self

Native value VK_SHADER_STAGE_ALL.

Khronos reference: VK_SHADER_STAGE_ALL

RAYGEN_BIT_KHR

Method

pub const RAYGEN_BIT_KHR: Self

Native value VK_SHADER_STAGE_RAYGEN_BIT_KHR.

Khronos reference: VK_SHADER_STAGE_RAYGEN_BIT_KHR

ANY_HIT_BIT_KHR

Method

pub const ANY_HIT_BIT_KHR: Self

Native value VK_SHADER_STAGE_ANY_HIT_BIT_KHR.

Khronos reference: VK_SHADER_STAGE_ANY_HIT_BIT_KHR

CLOSEST_HIT_BIT_KHR

Method

pub const CLOSEST_HIT_BIT_KHR: Self

Native value VK_SHADER_STAGE_CLOSEST_HIT_BIT_KHR.

Khronos reference: VK_SHADER_STAGE_CLOSEST_HIT_BIT_KHR

MISS_BIT_KHR

Method

pub const MISS_BIT_KHR: Self

Native value VK_SHADER_STAGE_MISS_BIT_KHR.

Khronos reference: VK_SHADER_STAGE_MISS_BIT_KHR

INTERSECTION_BIT_KHR

Method

pub const INTERSECTION_BIT_KHR: Self

Native value VK_SHADER_STAGE_INTERSECTION_BIT_KHR.

Khronos reference: VK_SHADER_STAGE_INTERSECTION_BIT_KHR

CALLABLE_BIT_KHR

Method

pub const CALLABLE_BIT_KHR: Self

Native value VK_SHADER_STAGE_CALLABLE_BIT_KHR.

Khronos reference: VK_SHADER_STAGE_CALLABLE_BIT_KHR

RAYGEN_BIT_NV

Method

pub const RAYGEN_BIT_NV: Self

Native value VK_SHADER_STAGE_RAYGEN_BIT_NV.

Khronos reference: VK_SHADER_STAGE_RAYGEN_BIT_NV

ANY_HIT_BIT_NV

Method

pub const ANY_HIT_BIT_NV: Self

Native value VK_SHADER_STAGE_ANY_HIT_BIT_NV.

Khronos reference: VK_SHADER_STAGE_ANY_HIT_BIT_NV

CLOSEST_HIT_BIT_NV

Method

pub const CLOSEST_HIT_BIT_NV: Self

Native value VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV.

Khronos reference: VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV

MISS_BIT_NV

Method

pub const MISS_BIT_NV: Self

Native value VK_SHADER_STAGE_MISS_BIT_NV.

Khronos reference: VK_SHADER_STAGE_MISS_BIT_NV

INTERSECTION_BIT_NV

Method

pub const INTERSECTION_BIT_NV: Self

Native value VK_SHADER_STAGE_INTERSECTION_BIT_NV.

Khronos reference: VK_SHADER_STAGE_INTERSECTION_BIT_NV

CALLABLE_BIT_NV

Method

pub const CALLABLE_BIT_NV: Self

Native value VK_SHADER_STAGE_CALLABLE_BIT_NV.

Khronos reference: VK_SHADER_STAGE_CALLABLE_BIT_NV

TASK_BIT_NV

Method

pub const TASK_BIT_NV: Self

Native value VK_SHADER_STAGE_TASK_BIT_NV.

Khronos reference: VK_SHADER_STAGE_TASK_BIT_NV

MESH_BIT_NV

Method

pub const MESH_BIT_NV: Self

Native value VK_SHADER_STAGE_MESH_BIT_NV.

Khronos reference: VK_SHADER_STAGE_MESH_BIT_NV

TASK_BIT_EXT

Method

pub const TASK_BIT_EXT: Self

Native value VK_SHADER_STAGE_TASK_BIT_EXT.

Khronos reference: VK_SHADER_STAGE_TASK_BIT_EXT

MESH_BIT_EXT

Method

pub const MESH_BIT_EXT: Self

Native value VK_SHADER_STAGE_MESH_BIT_EXT.

Khronos reference: VK_SHADER_STAGE_MESH_BIT_EXT

SUBPASS_SHADING_BIT_HUAWEI

Method

pub const SUBPASS_SHADING_BIT_HUAWEI: Self

Native value VK_SHADER_STAGE_SUBPASS_SHADING_BIT_HUAWEI.

Khronos reference: VK_SHADER_STAGE_SUBPASS_SHADING_BIT_HUAWEI

CLUSTER_CULLING_BIT_HUAWEI

Method

pub const CLUSTER_CULLING_BIT_HUAWEI: Self

Native value VK_SHADER_STAGE_CLUSTER_CULLING_BIT_HUAWEI.

Khronos reference: VK_SHADER_STAGE_CLUSTER_CULLING_BIT_HUAWEI

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

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

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

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

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

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

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

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

Stvk::ShaderStatisticsInfoAMD

#[repr(C)]pub struct ShaderStatisticsInfoAMD {
    pub shader_stage_mask: ShaderStageFlags,
    pub resource_usage: ShaderResourceUsageAMD,
    pub num_physical_vgprs: u32,
    pub num_physical_sgprs: u32,
    pub num_available_vgprs: u32,
    pub num_available_sgprs: u32,
    pub compute_work_group_size: [u32; 3],
}

Native structure VkShaderStatisticsInfoAMD.

Contract

Native structure VkShaderStatisticsInfoAMD.

Khronos reference: VkShaderStatisticsInfoAMD

Fields

shader_stage_mask

Field

shader_stage_mask: ShaderStageFlags

Native field shaderStageMask.

resource_usage

Field

resource_usage: ShaderResourceUsageAMD

Native field resourceUsage.

num_physical_vgprs

Field

num_physical_vgprs: u32

Native field numPhysicalVgprs.

num_physical_sgprs

Field

num_physical_sgprs: u32

Native field numPhysicalSgprs.

num_available_vgprs

Field

num_available_vgprs: u32

Native field numAvailableVgprs.

num_available_sgprs

Field

num_available_sgprs: u32

Native field numAvailableSgprs.

compute_work_group_size

Field

compute_work_group_size: [u32; 3]

Native field computeWorkGroupSize.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_shader_stage_mask

Method

pub fn set_shader_stage_mask(self, value: ShaderStageFlags) -> Self

Set native field shaderStageMask without native effects.

set_resource_usage

Method

pub fn set_resource_usage(self, value: ShaderResourceUsageAMD) -> Self

Set native field resourceUsage without native effects.

set_num_physical_vgprs

Method

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

Set native field numPhysicalVgprs without native effects.

set_num_physical_sgprs

Method

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

Set native field numPhysicalSgprs without native effects.

set_num_available_vgprs

Method

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

Set native field numAvailableVgprs without native effects.

set_num_available_sgprs

Method

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

Set native field numAvailableSgprs without native effects.

set_compute_work_group_size

Method

pub fn set_compute_work_group_size(self, value: [u32; 3]) -> Self

Set native field computeWorkGroupSize without native effects.

clone

Method

fn clone(&self) -> ShaderStatisticsInfoAMD

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::ShadingRatePaletteEntryNV

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

Open integer representation of VkShadingRatePaletteEntryNV.

Contract

Open integer representation of VkShadingRatePaletteEntryNV.

Khronos reference: VkShadingRatePaletteEntryNV

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

NO_INVOCATIONS_NV

Method

pub const NO_INVOCATIONS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV

_16_INVOCATIONS_PER_PIXEL_NV

Method

pub const _16_INVOCATIONS_PER_PIXEL_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_16_INVOCATIONS_PER_PIXEL_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_16_INVOCATIONS_PER_PIXEL_NV

_8_INVOCATIONS_PER_PIXEL_NV

Method

pub const _8_INVOCATIONS_PER_PIXEL_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_8_INVOCATIONS_PER_PIXEL_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_8_INVOCATIONS_PER_PIXEL_NV

_4_INVOCATIONS_PER_PIXEL_NV

Method

pub const _4_INVOCATIONS_PER_PIXEL_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_4_INVOCATIONS_PER_PIXEL_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_4_INVOCATIONS_PER_PIXEL_NV

_2_INVOCATIONS_PER_PIXEL_NV

Method

pub const _2_INVOCATIONS_PER_PIXEL_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_2_INVOCATIONS_PER_PIXEL_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_2_INVOCATIONS_PER_PIXEL_NV

_1_INVOCATION_PER_PIXEL_NV

Method

pub const _1_INVOCATION_PER_PIXEL_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_PIXEL_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_PIXEL_NV

_1_INVOCATION_PER_2X1_PIXELS_NV

Method

pub const _1_INVOCATION_PER_2X1_PIXELS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X1_PIXELS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X1_PIXELS_NV

_1_INVOCATION_PER_1X2_PIXELS_NV

Method

pub const _1_INVOCATION_PER_1X2_PIXELS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_1X2_PIXELS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_1X2_PIXELS_NV

_1_INVOCATION_PER_2X2_PIXELS_NV

Method

pub const _1_INVOCATION_PER_2X2_PIXELS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X2_PIXELS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X2_PIXELS_NV

_1_INVOCATION_PER_4X2_PIXELS_NV

Method

pub const _1_INVOCATION_PER_4X2_PIXELS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X2_PIXELS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X2_PIXELS_NV

_1_INVOCATION_PER_2X4_PIXELS_NV

Method

pub const _1_INVOCATION_PER_2X4_PIXELS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X4_PIXELS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_2X4_PIXELS_NV

_1_INVOCATION_PER_4X4_PIXELS_NV

Method

pub const _1_INVOCATION_PER_4X4_PIXELS_NV: Self

Native value VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X4_PIXELS_NV.

Khronos reference: VK_SHADING_RATE_PALETTE_ENTRY_1_INVOCATION_PER_4X4_PIXELS_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) -> ShadingRatePaletteEntryNV

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

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

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

Stvk::ShadingRatePaletteNV

pub struct ShadingRatePaletteNV<'a> {
    pub shading_rate_palette_entry_count: u32,
    pub p_shading_rate_palette_entries: *const ShadingRatePaletteEntryNV,
    /* private fields */
}

Native structure VkShadingRatePaletteNV.

Contract

Native structure VkShadingRatePaletteNV.

Khronos reference: VkShadingRatePaletteNV

Fields

shading_rate_palette_entry_count

Field

shading_rate_palette_entry_count: u32

Native field shadingRatePaletteEntryCount.

p_shading_rate_palette_entries

Field

p_shading_rate_palette_entries: *const ShadingRatePaletteEntryNV

Native field pShadingRatePaletteEntries.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_shading_rate_palette_entry_count

Method

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

Set native count shadingRatePaletteEntryCount 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_shading_rate_palette_entries

Method

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

Borrow pShadingRatePaletteEntries and set checked native count shadingRatePaletteEntryCount. 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) -> ShadingRatePaletteNV<'a>

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SharedPresentSurfaceCapabilities2KHR

pub struct SharedPresentSurfaceCapabilities2KHR<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub shared_present_supported_usage_flags: ImageUsageFlags2KHR,
    /* private fields */
}

Native structure VkSharedPresentSurfaceCapabilities2KHR.

Contract

Native structure VkSharedPresentSurfaceCapabilities2KHR.

Khronos reference: VkSharedPresentSurfaceCapabilities2KHR

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

shared_present_supported_usage_flags

Field

shared_present_supported_usage_flags: ImageUsageFlags2KHR

Native field sharedPresentSupportedUsageFlags.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_shared_present_supported_usage_flags

Method

pub fn set_shared_present_supported_usage_flags( self, value: ImageUsageFlags2KHR, ) -> Self

Set native field sharedPresentSupportedUsageFlags 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::SharedPresentSurfaceCapabilitiesKHR

pub struct SharedPresentSurfaceCapabilitiesKHR<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub shared_present_supported_usage_flags: ImageUsageFlags,
    /* private fields */
}

Native structure VkSharedPresentSurfaceCapabilitiesKHR.

Contract

Native structure VkSharedPresentSurfaceCapabilitiesKHR.

Khronos reference: VkSharedPresentSurfaceCapabilitiesKHR

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

shared_present_supported_usage_flags

Field

shared_present_supported_usage_flags: ImageUsageFlags

Native field sharedPresentSupportedUsageFlags.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_shared_present_supported_usage_flags

Method

pub fn set_shared_present_supported_usage_flags( self, value: ImageUsageFlags, ) -> Self

Set native field sharedPresentSupportedUsageFlags 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::SharingMode

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

Open integer representation of VkSharingMode.

Contract

Open integer representation of VkSharingMode.

Khronos reference: VkSharingMode

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

EXCLUSIVE

Method

pub const EXCLUSIVE: Self

Native value VK_SHARING_MODE_EXCLUSIVE.

Khronos reference: VK_SHARING_MODE_EXCLUSIVE

CONCURRENT

Method

pub const CONCURRENT: Self

Native value VK_SHARING_MODE_CONCURRENT.

Khronos reference: VK_SHARING_MODE_CONCURRENT

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

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

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

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

Stvk::SparseBufferMemoryBindInfo

pub struct SparseBufferMemoryBindInfo<'a> {
    pub buffer: Buffer,
    pub bind_count: u32,
    pub p_binds: *const SparseMemoryBind,
    /* private fields */
}

Native structure VkSparseBufferMemoryBindInfo.

Contract

Native structure VkSparseBufferMemoryBindInfo.

Khronos reference: VkSparseBufferMemoryBindInfo

Fields

buffer

Field

buffer: Buffer

Native field buffer.

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_buffer

Method

pub fn set_buffer(self, value: Buffer) -> Self

Set native field buffer 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) -> SparseBufferMemoryBindInfo<'a>

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SparseImageFormatFlagBits

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

Open integer representation of VkSparseImageFormatFlagBits.

Contract

Open integer representation of VkSparseImageFormatFlagBits.

Khronos reference: VkSparseImageFormatFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

SINGLE_MIPTAIL_BIT

Method

pub const SINGLE_MIPTAIL_BIT: Self

Native value VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT.

Khronos reference: VK_SPARSE_IMAGE_FORMAT_SINGLE_MIPTAIL_BIT

ALIGNED_MIP_SIZE_BIT

Method

pub const ALIGNED_MIP_SIZE_BIT: Self

Native value VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT.

Khronos reference: VK_SPARSE_IMAGE_FORMAT_ALIGNED_MIP_SIZE_BIT

NONSTANDARD_BLOCK_SIZE_BIT

Method

pub const NONSTANDARD_BLOCK_SIZE_BIT: Self

Native value VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_BIT.

Khronos reference: VK_SPARSE_IMAGE_FORMAT_NONSTANDARD_BLOCK_SIZE_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 = SparseImageFormatFlagBits

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

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

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

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

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

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

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

Stvk::SparseImageFormatProperties

#[repr(C)]pub struct SparseImageFormatProperties {
    pub aspect_mask: ImageAspectFlags,
    pub image_granularity: Extent3D,
    pub flags: SparseImageFormatFlags,
}

Native structure VkSparseImageFormatProperties.

Contract

Native structure VkSparseImageFormatProperties.

Khronos reference: VkSparseImageFormatProperties

Fields

aspect_mask

Field

aspect_mask: ImageAspectFlags

Native field aspectMask.

image_granularity

Field

image_granularity: Extent3D

Native field imageGranularity.

flags

Field

flags: SparseImageFormatFlags

Native field flags.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_aspect_mask

Method

pub fn set_aspect_mask(self, value: ImageAspectFlags) -> Self

Set native field aspectMask without native effects.

set_image_granularity

Method

pub fn set_image_granularity(self, value: Extent3D) -> Self

Set native field imageGranularity without native effects.

set_flags

Method

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

Set native field flags without native effects.

clone

Method

fn clone(&self) -> SparseImageFormatProperties

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SparseImageFormatProperties2

pub struct SparseImageFormatProperties2<'a> {
    pub s_type: StructureType,
    pub p_next: *mut c_void,
    pub properties: SparseImageFormatProperties,
    /* private fields */
}

Native structure VkSparseImageFormatProperties2.

Contract

Native structure VkSparseImageFormatProperties2.

Khronos reference: VkSparseImageFormatProperties2

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *mut c_void

Native field pNext.

properties

Field

properties: SparseImageFormatProperties

Native field properties.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_properties

Method

pub fn set_properties(self, value: SparseImageFormatProperties) -> Self

Set native field properties 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::SparseImageMemoryBind

#[repr(C)]pub struct SparseImageMemoryBind {
    pub subresource: ImageSubresource,
    pub offset: Offset3D,
    pub extent: Extent3D,
    pub memory: DeviceMemory,
    pub memory_offset: DeviceSize,
    pub flags: SparseMemoryBindFlags,
}

Native structure VkSparseImageMemoryBind.

Contract

Native structure VkSparseImageMemoryBind.

Khronos reference: VkSparseImageMemoryBind

Fields

subresource

Field

subresource: ImageSubresource

Native field subresource.

offset

Field

offset: Offset3D

Native field offset.

extent

Field

extent: Extent3D

Native field extent.

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_subresource

Method

pub fn set_subresource(self, value: ImageSubresource) -> Self

Set native field subresource without native effects.

set_offset

Method

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

Set native field offset without native effects.

set_extent

Method

pub fn set_extent(self, value: Extent3D) -> Self

Set native field extent 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) -> SparseImageMemoryBind

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SparseImageMemoryBindInfo

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

Native structure VkSparseImageMemoryBindInfo.

Contract

Native structure VkSparseImageMemoryBindInfo.

Khronos reference: VkSparseImageMemoryBindInfo

Fields

image

Field

image: Image

Native field image.

bind_count

Field

bind_count: u32

Native field bindCount.

p_binds

Field

p_binds: *const SparseImageMemoryBind

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_binds

Method

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

Errors

Returns a construction error if the length exceeds the native count width.

clone

Method

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

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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

Stvk::SparseImageMemoryRequirements

#[repr(C)]pub struct SparseImageMemoryRequirements {
    pub format_properties: SparseImageFormatProperties,
    pub image_mip_tail_first_lod: u32,
    pub image_mip_tail_size: DeviceSize,
    pub image_mip_tail_offset: DeviceSize,
    pub image_mip_tail_stride: DeviceSize,
}

Native structure VkSparseImageMemoryRequirements.

Contract

Native structure VkSparseImageMemoryRequirements.

Khronos reference: VkSparseImageMemoryRequirements

Fields

format_properties

Field

format_properties: SparseImageFormatProperties

Native field formatProperties.

image_mip_tail_first_lod

Field

image_mip_tail_first_lod: u32

Native field imageMipTailFirstLod.

image_mip_tail_size

Field

image_mip_tail_size: DeviceSize

Native field imageMipTailSize.

image_mip_tail_offset

Field

image_mip_tail_offset: DeviceSize

Native field imageMipTailOffset.

image_mip_tail_stride

Field

image_mip_tail_stride: DeviceSize

Native field imageMipTailStride.

Methods and associated items

new

Method

pub fn new() -> Self

Construct the record with its default native state.

set_format_properties

Method

pub fn set_format_properties(self, value: SparseImageFormatProperties) -> Self

Set native field formatProperties without native effects.

set_image_mip_tail_first_lod

Method

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

Set native field imageMipTailFirstLod without native effects.

set_image_mip_tail_size

Method

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

Set native field imageMipTailSize without native effects.

set_image_mip_tail_offset

Method

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

Set native field imageMipTailOffset without native effects.

set_image_mip_tail_stride

Method

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

Set native field imageMipTailStride without native effects.

clone

Method

fn clone(&self) -> SparseImageMemoryRequirements

Returns a duplicate of the value. Read more

default

Method

fn default() -> Self

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