vk · Structs · C3 · VK

Stvk::ColorComponentFlagBits

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

Open integer representation of VkColorComponentFlagBits.

Contract

Open integer representation of VkColorComponentFlagBits.

Khronos reference: VkColorComponentFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

R_BIT

Method

pub const R_BIT: Self

Native value VK_COLOR_COMPONENT_R_BIT.

Khronos reference: VK_COLOR_COMPONENT_R_BIT

G_BIT

Method

pub const G_BIT: Self

Native value VK_COLOR_COMPONENT_G_BIT.

Khronos reference: VK_COLOR_COMPONENT_G_BIT

B_BIT

Method

pub const B_BIT: Self

Native value VK_COLOR_COMPONENT_B_BIT.

Khronos reference: VK_COLOR_COMPONENT_B_BIT

A_BIT

Method

pub const A_BIT: Self

Native value VK_COLOR_COMPONENT_A_BIT.

Khronos reference: VK_COLOR_COMPONENT_A_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 = ColorComponentFlagBits

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

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

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

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

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

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

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

Stvk::ColorSpaceKHR

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

Open integer representation of VkColorSpaceKHR.

Contract

Open integer representation of VkColorSpaceKHR.

Khronos reference: VkColorSpaceKHR

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

SRGB_NONLINEAR_KHR

Method

pub const SRGB_NONLINEAR_KHR: Self

Native value VK_COLOR_SPACE_SRGB_NONLINEAR_KHR.

Khronos reference: VK_COLOR_SPACE_SRGB_NONLINEAR_KHR

COLORSPACE_SRGB_NONLINEAR_KHR

Method

pub const COLORSPACE_SRGB_NONLINEAR_KHR: Self

Native value VK_COLORSPACE_SRGB_NONLINEAR_KHR.

Khronos reference: VK_COLORSPACE_SRGB_NONLINEAR_KHR

DISPLAY_P3_NONLINEAR_EXT

Method

pub const DISPLAY_P3_NONLINEAR_EXT: Self

Native value VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT

EXTENDED_SRGB_LINEAR_EXT

Method

pub const EXTENDED_SRGB_LINEAR_EXT: Self

Native value VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT

DISPLAY_P3_LINEAR_EXT

Method

pub const DISPLAY_P3_LINEAR_EXT: Self

Native value VK_COLOR_SPACE_DISPLAY_P3_LINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_DISPLAY_P3_LINEAR_EXT

DCI_P3_NONLINEAR_EXT

Method

pub const DCI_P3_NONLINEAR_EXT: Self

Native value VK_COLOR_SPACE_DCI_P3_NONLINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_DCI_P3_NONLINEAR_EXT

BT709_LINEAR_EXT

Method

pub const BT709_LINEAR_EXT: Self

Native value VK_COLOR_SPACE_BT709_LINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_BT709_LINEAR_EXT

BT709_NONLINEAR_EXT

Method

pub const BT709_NONLINEAR_EXT: Self

Native value VK_COLOR_SPACE_BT709_NONLINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_BT709_NONLINEAR_EXT

BT2020_LINEAR_EXT

Method

pub const BT2020_LINEAR_EXT: Self

Native value VK_COLOR_SPACE_BT2020_LINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_BT2020_LINEAR_EXT

HDR10_ST2084_EXT

Method

pub const HDR10_ST2084_EXT: Self

Native value VK_COLOR_SPACE_HDR10_ST2084_EXT.

Khronos reference: VK_COLOR_SPACE_HDR10_ST2084_EXT

DOLBYVISION_EXT

Method

pub const DOLBYVISION_EXT: Self

Native value VK_COLOR_SPACE_DOLBYVISION_EXT.

Khronos reference: VK_COLOR_SPACE_DOLBYVISION_EXT

HDR10_HLG_EXT

Method

pub const HDR10_HLG_EXT: Self

Native value VK_COLOR_SPACE_HDR10_HLG_EXT.

Khronos reference: VK_COLOR_SPACE_HDR10_HLG_EXT

ADOBERGB_LINEAR_EXT

Method

pub const ADOBERGB_LINEAR_EXT: Self

Native value VK_COLOR_SPACE_ADOBERGB_LINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_ADOBERGB_LINEAR_EXT

ADOBERGB_NONLINEAR_EXT

Method

pub const ADOBERGB_NONLINEAR_EXT: Self

Native value VK_COLOR_SPACE_ADOBERGB_NONLINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_ADOBERGB_NONLINEAR_EXT

PASS_THROUGH_EXT

Method

pub const PASS_THROUGH_EXT: Self

Native value VK_COLOR_SPACE_PASS_THROUGH_EXT.

Khronos reference: VK_COLOR_SPACE_PASS_THROUGH_EXT

EXTENDED_SRGB_NONLINEAR_EXT

Method

pub const EXTENDED_SRGB_NONLINEAR_EXT: Self

Native value VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT

DCI_P3_LINEAR_EXT

Method

pub const DCI_P3_LINEAR_EXT: Self

Native value VK_COLOR_SPACE_DCI_P3_LINEAR_EXT.

Khronos reference: VK_COLOR_SPACE_DCI_P3_LINEAR_EXT

DISPLAY_NATIVE_AMD

Method

pub const DISPLAY_NATIVE_AMD: Self

Native value VK_COLOR_SPACE_DISPLAY_NATIVE_AMD.

Khronos reference: VK_COLOR_SPACE_DISPLAY_NATIVE_AMD

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

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

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

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

Stvk::CommandBuffer

#[repr(transparent)]pub struct CommandBuffer(pub *mut c_void);

Raw Vulkan handle VkCommandBuffer.

Contract

Raw Vulkan handle VkCommandBuffer.

Khronos reference: VkCommandBuffer Calls using this identity must satisfy Vulkan lifetime and synchronization rules.

Fields

0

Field

0: *mut c_void

No public source comment is attached to this declaration.

Methods and associated items

NULL

Method

pub const NULL: Self

No public source comment is attached to this declaration.

is_null

Method

pub fn is_null(self) -> bool

No public source comment is attached to this declaration.

from_raw

Method

pub fn from_raw(value: u64) -> Self

No public source comment is attached to this declaration.

as_raw

Method

pub fn as_raw(self) -> u64

No public source comment is attached to this declaration.

clone

Method

fn clone(&self) -> CommandBuffer

Returns a duplicate of the value. Read more

fmt

Method

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

default

Method

fn default() -> Self

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

hash

Method

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

Feeds this value into the given Hasher. Read more

eq

Method

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

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

Stvk::CommandBufferAllocateInfo

pub struct CommandBufferAllocateInfo<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub command_pool: CommandPool,
    pub level: CommandBufferLevel,
    pub command_buffer_count: u32,
    /* private fields */
}

Native structure VkCommandBufferAllocateInfo.

Contract

Native structure VkCommandBufferAllocateInfo.

Khronos reference: VkCommandBufferAllocateInfo

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

command_pool

Field

command_pool: CommandPool

Native field commandPool.

level

Field

level: CommandBufferLevel

Native field level.

command_buffer_count

Field

command_buffer_count: u32

Native field commandBufferCount.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_command_pool

Method

pub fn set_command_pool(self, value: CommandPool) -> Self

Set native field commandPool without native effects.

set_level

Method

pub fn set_level(self, value: CommandBufferLevel) -> Self

Set native field level without native effects.

set_command_buffer_count

Method

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

Set native field commandBufferCount 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::CommandBufferBeginInfo

pub struct CommandBufferBeginInfo<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub flags: CommandBufferUsageFlags,
    pub p_inheritance_info: *const CommandBufferInheritanceInfo<'a>,
    /* private fields */
}

Native structure VkCommandBufferBeginInfo.

Contract

Native structure VkCommandBufferBeginInfo.

Khronos reference: VkCommandBufferBeginInfo

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

flags

Field

flags: CommandBufferUsageFlags

Native field flags.

p_inheritance_info

Field

p_inheritance_info: *const CommandBufferInheritanceInfo<'a>

Native field pInheritanceInfo.

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

Set native field flags without native effects.

set_inheritance_info

Method

pub fn set_inheritance_info( self, value: &'a CommandBufferInheritanceInfo<'a>, ) -> Self

Set native field pInheritanceInfo 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::CommandBufferInheritanceConditionalRenderingInfoEXT

pub struct CommandBufferInheritanceConditionalRenderingInfoEXT<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub conditional_rendering_enable: Bool32,
    /* private fields */
}

Native structure VkCommandBufferInheritanceConditionalRenderingInfoEXT.

Contract

Native structure VkCommandBufferInheritanceConditionalRenderingInfoEXT.

Khronos reference: VkCommandBufferInheritanceConditionalRenderingInfoEXT

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

conditional_rendering_enable

Field

conditional_rendering_enable: Bool32

Native field conditionalRenderingEnable.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_conditional_rendering_enable

Method

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

Set native field conditionalRenderingEnable 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::CommandBufferInheritanceDescriptorHeapInfoEXT

pub struct CommandBufferInheritanceDescriptorHeapInfoEXT<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub p_sampler_heap_bind_info: *const BindHeapInfoEXT<'a>,
    pub p_resource_heap_bind_info: *const BindHeapInfoEXT<'a>,
    /* private fields */
}

Native structure VkCommandBufferInheritanceDescriptorHeapInfoEXT.

Contract

Native structure VkCommandBufferInheritanceDescriptorHeapInfoEXT.

Khronos reference: VkCommandBufferInheritanceDescriptorHeapInfoEXT

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

p_sampler_heap_bind_info

Field

p_sampler_heap_bind_info: *const BindHeapInfoEXT<'a>

Native field pSamplerHeapBindInfo.

p_resource_heap_bind_info

Field

p_resource_heap_bind_info: *const BindHeapInfoEXT<'a>

Native field pResourceHeapBindInfo.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_sampler_heap_bind_info

Method

pub fn set_sampler_heap_bind_info(self, value: &'a BindHeapInfoEXT<'a>) -> Self

Set native field pSamplerHeapBindInfo without native effects.

set_resource_heap_bind_info

Method

pub fn set_resource_heap_bind_info(self, value: &'a BindHeapInfoEXT<'a>) -> Self

Set native field pResourceHeapBindInfo 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::CommandBufferInheritanceInfo

pub struct CommandBufferInheritanceInfo<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub render_pass: RenderPass,
    pub subpass: u32,
    pub framebuffer: Framebuffer,
    pub occlusion_query_enable: Bool32,
    pub query_flags: QueryControlFlags,
    pub pipeline_statistics: QueryPipelineStatisticFlags,
    /* private fields */
}

Native structure VkCommandBufferInheritanceInfo.

Contract

Native structure VkCommandBufferInheritanceInfo.

Khronos reference: VkCommandBufferInheritanceInfo

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

render_pass

Field

render_pass: RenderPass

Native field renderPass.

subpass

Field

subpass: u32

Native field subpass.

framebuffer

Field

framebuffer: Framebuffer

Native field framebuffer.

occlusion_query_enable

Field

occlusion_query_enable: Bool32

Native field occlusionQueryEnable.

query_flags

Field

query_flags: QueryControlFlags

Native field queryFlags.

pipeline_statistics

Field

pipeline_statistics: QueryPipelineStatisticFlags

Native field pipelineStatistics.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_render_pass

Method

pub fn set_render_pass(self, value: RenderPass) -> Self

Set native field renderPass without native effects.

set_subpass

Method

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

Set native field subpass without native effects.

set_framebuffer

Method

pub fn set_framebuffer(self, value: Framebuffer) -> Self

Set native field framebuffer without native effects.

set_occlusion_query_enable

Method

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

Set native field occlusionQueryEnable without native effects.

set_query_flags

Method

pub fn set_query_flags(self, value: QueryControlFlags) -> Self

Set native field queryFlags without native effects.

set_pipeline_statistics

Method

pub fn set_pipeline_statistics(self, value: QueryPipelineStatisticFlags) -> Self

Set native field pipelineStatistics 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::CommandBufferInheritanceRenderingInfo

pub struct CommandBufferInheritanceRenderingInfo<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub flags: RenderingFlags,
    pub view_mask: u32,
    pub color_attachment_count: u32,
    pub p_color_attachment_formats: *const Format,
    pub depth_attachment_format: Format,
    pub stencil_attachment_format: Format,
    pub rasterization_samples: SampleCountFlagBits,
    /* private fields */
}

Native structure VkCommandBufferInheritanceRenderingInfo.

Contract

Native structure VkCommandBufferInheritanceRenderingInfo.

Khronos reference: VkCommandBufferInheritanceRenderingInfo

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

flags

Field

flags: RenderingFlags

Native field flags.

view_mask

Field

view_mask: u32

Native field viewMask.

color_attachment_count

Field

color_attachment_count: u32

Native field colorAttachmentCount.

p_color_attachment_formats

Field

p_color_attachment_formats: *const Format

Native field pColorAttachmentFormats.

depth_attachment_format

Field

depth_attachment_format: Format

Native field depthAttachmentFormat.

stencil_attachment_format

Field

stencil_attachment_format: Format

Native field stencilAttachmentFormat.

rasterization_samples

Field

rasterization_samples: SampleCountFlagBits

Native field rasterizationSamples.

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

Set native field flags without native effects.

set_view_mask

Method

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

Set native field viewMask without native effects.

set_color_attachment_count

Method

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

Set native count colorAttachmentCount 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_color_attachment_formats

Method

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

Borrow pColorAttachmentFormats and set checked native count colorAttachmentCount. 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_depth_attachment_format

Method

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

Set native field depthAttachmentFormat without native effects.

set_stencil_attachment_format

Method

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

Set native field stencilAttachmentFormat without native effects.

set_rasterization_samples

Method

pub fn set_rasterization_samples(self, value: SampleCountFlagBits) -> Self

Set native field rasterizationSamples 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::CommandBufferInheritanceRenderPassTransformInfoQCOM

pub struct CommandBufferInheritanceRenderPassTransformInfoQCOM<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub transform: SurfaceTransformFlagBitsKHR,
    pub render_area: Rect2D,
    /* private fields */
}

Native structure VkCommandBufferInheritanceRenderPassTransformInfoQCOM.

Contract

Native structure VkCommandBufferInheritanceRenderPassTransformInfoQCOM.

Khronos reference: VkCommandBufferInheritanceRenderPassTransformInfoQCOM

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

transform

Field

transform: SurfaceTransformFlagBitsKHR

Native field transform.

render_area

Field

render_area: Rect2D

Native field renderArea.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_transform

Method

pub fn set_transform(self, value: SurfaceTransformFlagBitsKHR) -> Self

Set native field transform without native effects.

set_render_area

Method

pub fn set_render_area(self, value: Rect2D) -> Self

Set native field renderArea 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::CommandBufferInheritanceViewportScissorInfoNV

pub struct CommandBufferInheritanceViewportScissorInfoNV<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub viewport_scissor2_d: Bool32,
    pub viewport_depth_count: u32,
    pub p_viewport_depths: *const Viewport,
    /* private fields */
}

Native structure VkCommandBufferInheritanceViewportScissorInfoNV.

Contract

Native structure VkCommandBufferInheritanceViewportScissorInfoNV.

Khronos reference: VkCommandBufferInheritanceViewportScissorInfoNV

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

viewport_scissor2_d

Field

viewport_scissor2_d: Bool32

Native field viewportScissor2D.

viewport_depth_count

Field

viewport_depth_count: u32

Native field viewportDepthCount.

p_viewport_depths

Field

p_viewport_depths: *const Viewport

Native field pViewportDepths.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_viewport_scissor2_d

Method

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

Set native field viewportScissor2D without native effects.

set_viewport_depth_count

Method

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

Set native field viewportDepthCount without native effects.

set_viewport_depths

Method

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

Borrow pViewportDepths and set checked native count viewportDepthCount. 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::CommandBufferLevel

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

Open integer representation of VkCommandBufferLevel.

Contract

Open integer representation of VkCommandBufferLevel.

Khronos reference: VkCommandBufferLevel

Fields

0

Field

0: i32

No public source comment is attached to this declaration.

Methods and associated items

PRIMARY

Method

pub const PRIMARY: Self

Native value VK_COMMAND_BUFFER_LEVEL_PRIMARY.

Khronos reference: VK_COMMAND_BUFFER_LEVEL_PRIMARY

SECONDARY

Method

pub const SECONDARY: Self

Native value VK_COMMAND_BUFFER_LEVEL_SECONDARY.

Khronos reference: VK_COMMAND_BUFFER_LEVEL_SECONDARY

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

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

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

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

Stvk::CommandBufferResetFlagBits

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

Open integer representation of VkCommandBufferResetFlagBits.

Contract

Open integer representation of VkCommandBufferResetFlagBits.

Khronos reference: VkCommandBufferResetFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

RELEASE_RESOURCES_BIT

Method

pub const RELEASE_RESOURCES_BIT: Self

Native value VK_COMMAND_BUFFER_RESET_RELEASE_RESOURCES_BIT.

Khronos reference: VK_COMMAND_BUFFER_RESET_RELEASE_RESOURCES_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 = CommandBufferResetFlagBits

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

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

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

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

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

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

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

Stvk::CommandBufferSubmitInfo

pub struct CommandBufferSubmitInfo<'a> {
    pub s_type: StructureType,
    pub p_next: *const c_void,
    pub command_buffer: CommandBuffer,
    pub device_mask: u32,
    /* private fields */
}

Native structure VkCommandBufferSubmitInfo.

Contract

Native structure VkCommandBufferSubmitInfo.

Khronos reference: VkCommandBufferSubmitInfo

Fields

s_type

Field

s_type: StructureType

Native field sType.

p_next

Field

p_next: *const c_void

Native field pNext.

command_buffer

Field

command_buffer: CommandBuffer

Native field commandBuffer.

device_mask

Field

device_mask: u32

Native field deviceMask.

Methods and associated items

new

Method

pub fn new() -> Self

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

set_command_buffer

Method

pub fn set_command_buffer(self, value: CommandBuffer) -> Self

Set native field commandBuffer without native effects.

set_device_mask

Method

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

Set native field deviceMask 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::CommandBufferUsageFlagBits

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

Open integer representation of VkCommandBufferUsageFlagBits.

Contract

Open integer representation of VkCommandBufferUsageFlagBits.

Khronos reference: VkCommandBufferUsageFlagBits

Fields

0

Field

0: u32

No public source comment is attached to this declaration.

Methods and associated items

ONE_TIME_SUBMIT_BIT

Method

pub const ONE_TIME_SUBMIT_BIT: Self

Native value VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT.

Khronos reference: VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT

RENDER_PASS_CONTINUE_BIT

Method

pub const RENDER_PASS_CONTINUE_BIT: Self

Native value VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT.

Khronos reference: VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT

SIMULTANEOUS_USE_BIT

Method

pub const SIMULTANEOUS_USE_BIT: Self

Native value VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT.

Khronos reference: VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_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 = CommandBufferUsageFlagBits

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

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

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

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

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

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

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

Stvk::CommandMetadata

pub struct CommandMetadata {
    pub name: &'static str,
    pub alias_of: Option<&'static str>,
    pub dispatch: &'static str,
    pub physical_device: bool,
    pub requirements: &'static [&'static [CapabilityRequirement]],
}

No public source comment is attached to this declaration.

Fields

name

Field

name: &'static str

No public source comment is attached to this declaration.

alias_of

Field

alias_of: Option<&'static str>

No public source comment is attached to this declaration.

dispatch

Field

dispatch: &'static str

No public source comment is attached to this declaration.

physical_device

Field

physical_device: bool

Physical-device query, even though it uses instance dispatch.

requirements

Field

requirements: &'static [&'static [CapabilityRequirement]]

Alternatives of conjunctions for this exact command spelling.

Methods and associated items

fmt

Method

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more