Struct lava::VkCommandBuffer

pub struct VkCommandBuffer { /* fields omitted */ }

Wrapper for VkCommandBuffer.

Methods

impl VkCommandBuffer

pub fn vk_handle(&self) -> u64

Returns the internal Vulkan handle for the object.

pub fn is_null(&self) -> bool

Indicates if the Vulkan internal handle for this object is 0.

pub fn null() -> Self

Creates an object with a null Vulkan internal handle.

Calling a method with a null handle will most likely result in a crash.

pub fn begin(&self, begin_info: VkCommandBufferBeginInfo) -> LavaResult<()>

Wrapper for vkBeginCommandBuffer.

pub fn end(&self) -> LavaResult<()>

Wrapper for vkEndCommandBuffer.

pub fn reset(&self, flags: VkCommandBufferResetFlags) -> LavaResult<()>

Wrapper for vkResetCommandBuffer.

pub fn cmd_bind_pipeline(
    &self,
    pipeline_bind_point: VkPipelineBindPoint,
    pipeline: VkPipeline
)

Wrapper for vkCmdBindPipeline.

pub fn cmd_set_viewport(
    &self,
    first_viewport: usize,
    viewports: Vec<VkViewport>
)

Wrapper for vkCmdSetViewport.

pub fn cmd_set_scissor(&self, first_scissor: usize, scissors: Vec<VkRect2D>)

Wrapper for vkCmdSetScissor.

pub fn cmd_set_line_width(&self, line_width: f32)

Wrapper for vkCmdSetLineWidth.

pub fn cmd_set_depth_bias(
    &self,
    depth_bias_constant_factor: f32,
    depth_bias_clamp: f32,
    depth_bias_slope_factor: f32
)

Wrapper for vkCmdSetDepthBias.

pub fn cmd_set_blend_constants(&self, blend_constants: [f32; 4])

Wrapper for vkCmdSetBlendConstants.

pub fn cmd_set_depth_bounds(&self, min_depth_bounds: f32, max_depth_bounds: f32)

Wrapper for vkCmdSetDepthBounds.

pub fn cmd_set_stencil_compare_mask(
    &self,
    face_mask: VkStencilFaceFlags,
    compare_mask: u32
)

Wrapper for vkCmdSetStencilCompareMask.

pub fn cmd_set_stencil_write_mask(
    &self,
    face_mask: VkStencilFaceFlags,
    write_mask: u32
)

Wrapper for vkCmdSetStencilWriteMask.

pub fn cmd_set_stencil_reference(
    &self,
    face_mask: VkStencilFaceFlags,
    reference: usize
)

Wrapper for vkCmdSetStencilReference.

pub fn cmd_bind_descriptor_sets(
    &self,
    pipeline_bind_point: VkPipelineBindPoint,
    layout: VkPipelineLayout,
    first_set: usize,
    descriptor_sets: Vec<VkDescriptorSet>,
    dynamic_offsets: Vec<usize>
)

Wrapper for vkCmdBindDescriptorSets.

pub fn cmd_bind_index_buffer(
    &self,
    buffer: VkBuffer,
    offset: usize,
    index_type: VkIndexType
)

Wrapper for vkCmdBindIndexBuffer.

pub fn cmd_bind_vertex_buffers(
    &self,
    first_binding: usize,
    buffers: Vec<VkBuffer>,
    offsets: Vec<usize>
)

Wrapper for vkCmdBindVertexBuffers.

pub fn cmd_draw(
    &self,
    vertex_count: usize,
    instance_count: usize,
    first_vertex: usize,
    first_instance: usize
)

Wrapper for vkCmdDraw.

pub fn cmd_draw_indexed(
    &self,
    index_count: usize,
    instance_count: usize,
    first_index: usize,
    vertex_offset: isize,
    first_instance: usize
)

Wrapper for vkCmdDrawIndexed.

pub fn cmd_draw_indirect(
    &self,
    buffer: VkBuffer,
    offset: usize,
    draw_count: usize,
    stride: usize
)

Wrapper for vkCmdDrawIndirect.

pub fn cmd_draw_indexed_indirect(
    &self,
    buffer: VkBuffer,
    offset: usize,
    draw_count: usize,
    stride: usize
)

Wrapper for vkCmdDrawIndexedIndirect.

pub fn cmd_dispatch(
    &self,
    group_count_x: usize,
    group_count_y: usize,
    group_count_z: usize
)

Wrapper for vkCmdDispatch.

pub fn cmd_dispatch_indirect(&self, buffer: VkBuffer, offset: usize)

Wrapper for vkCmdDispatchIndirect.

pub fn cmd_copy_buffer(
    &self,
    src_buffer: VkBuffer,
    dst_buffer: VkBuffer,
    regions: Vec<VkBufferCopy>
)

Wrapper for vkCmdCopyBuffer.

pub fn cmd_copy_image(
    &self,
    src_image: VkImage,
    src_image_layout: VkImageLayout,
    dst_image: VkImage,
    dst_image_layout: VkImageLayout,
    regions: Vec<VkImageCopy>
)

Wrapper for vkCmdCopyImage.

pub fn cmd_blit_image(
    &self,
    src_image: VkImage,
    src_image_layout: VkImageLayout,
    dst_image: VkImage,
    dst_image_layout: VkImageLayout,
    regions: Vec<VkImageBlit>,
    filter: VkFilter
)

Wrapper for vkCmdBlitImage.

pub fn cmd_copy_buffer_to_image(
    &self,
    src_buffer: VkBuffer,
    dst_image: VkImage,
    dst_image_layout: VkImageLayout,
    regions: Vec<VkBufferImageCopy>
)

Wrapper for vkCmdCopyBufferToImage.

pub fn cmd_copy_image_to_buffer(
    &self,
    src_image: VkImage,
    src_image_layout: VkImageLayout,
    dst_buffer: VkBuffer,
    regions: Vec<VkBufferImageCopy>
)

Wrapper for vkCmdCopyImageToBuffer.

pub fn cmd_update_buffer(
    &self,
    dst_buffer: VkBuffer,
    dst_offset: usize,
    data: &[u8]
)

Wrapper for vkCmdUpdateBuffer.

pub fn cmd_fill_buffer(
    &self,
    dst_buffer: VkBuffer,
    dst_offset: usize,
    size: usize,
    data: u32
)

Wrapper for vkCmdFillBuffer.

pub fn cmd_clear_color_image(
    &self,
    image: VkImage,
    image_layout: VkImageLayout,
    color: VkClearColorValue,
    ranges: Vec<VkImageSubresourceRange>
)

Wrapper for vkCmdClearColorImage.

pub fn cmd_clear_depth_stencil_image(
    &self,
    image: VkImage,
    image_layout: VkImageLayout,
    depth_stencil: VkClearDepthStencilValue,
    ranges: Vec<VkImageSubresourceRange>
)

Wrapper for vkCmdClearDepthStencilImage.

pub fn cmd_clear_attachments(
    &self,
    attachments: Vec<VkClearAttachment>,
    rects: Vec<VkClearRect>
)

Wrapper for vkCmdClearAttachments.

pub fn cmd_resolve_image(
    &self,
    src_image: VkImage,
    src_image_layout: VkImageLayout,
    dst_image: VkImage,
    dst_image_layout: VkImageLayout,
    regions: Vec<VkImageResolve>
)

Wrapper for vkCmdResolveImage.

pub fn cmd_set_event(&self, event: VkEvent, stage_mask: VkPipelineStageFlags)

Wrapper for vkCmdSetEvent.

pub fn cmd_reset_event(&self, event: VkEvent, stage_mask: VkPipelineStageFlags)

Wrapper for vkCmdResetEvent.

pub fn cmd_wait_events(
    &self,
    events: Vec<VkEvent>,
    src_stage_mask: VkPipelineStageFlags,
    dst_stage_mask: VkPipelineStageFlags,
    memory_barriers: Vec<VkMemoryBarrier>,
    buffer_memory_barriers: Vec<VkBufferMemoryBarrier>,
    image_memory_barriers: Vec<VkImageMemoryBarrier>
)

Wrapper for vkCmdWaitEvents.

pub fn cmd_pipeline_barrier(
    &self,
    src_stage_mask: VkPipelineStageFlags,
    dst_stage_mask: VkPipelineStageFlags,
    dependency_flags: VkDependencyFlags,
    memory_barriers: Vec<VkMemoryBarrier>,
    buffer_memory_barriers: Vec<VkBufferMemoryBarrier>,
    image_memory_barriers: Vec<VkImageMemoryBarrier>
)

Wrapper for vkCmdPipelineBarrier.

pub fn cmd_begin_query(
    &self,
    query_pool: VkQueryPool,
    query: usize,
    flags: VkQueryControlFlags
)

Wrapper for vkCmdBeginQuery.

pub fn cmd_end_query(&self, query_pool: VkQueryPool, query: usize)

Wrapper for vkCmdEndQuery.

pub fn cmd_reset_query_pool(
    &self,
    query_pool: VkQueryPool,
    first_query: usize,
    query_count: usize
)

Wrapper for vkCmdResetQueryPool.

pub fn cmd_write_timestamp(
    &self,
    pipeline_stage: VkPipelineStageFlags,
    query_pool: VkQueryPool,
    query: usize
)

Wrapper for vkCmdWriteTimestamp.

pub fn cmd_copy_query_pool_results(
    &self,
    query_pool: VkQueryPool,
    first_query: usize,
    query_count: usize,
    dst_buffer: VkBuffer,
    dst_offset: usize,
    stride: usize,
    flags: VkQueryResultFlags
)

Wrapper for vkCmdCopyQueryPoolResults.

pub fn cmd_push_constants(
    &self,
    layout: VkPipelineLayout,
    stage_flags: VkShaderStageFlags,
    offset: usize,
    values: &[u8]
)

Wrapper for vkCmdPushConstants.

pub fn cmd_begin_render_pass(
    &self,
    render_pass_begin: VkRenderPassBeginInfo,
    contents: VkSubpassContents
)

Wrapper for vkCmdBeginRenderPass.

pub fn cmd_next_subpass(&self, contents: VkSubpassContents)

Wrapper for vkCmdNextSubpass.

pub fn cmd_end_render_pass(&self)

Wrapper for vkCmdEndRenderPass.

pub fn cmd_execute_commands(&self, command_buffers: Vec<VkCommandBuffer>)

Wrapper for vkCmdExecuteCommands.

pub fn cmd_set_device_mask(&self, device_mask: u32)

Wrapper for vkCmdSetDeviceMask.

pub fn cmd_dispatch_base(
    &self,
    base_group_x: usize,
    base_group_y: usize,
    base_group_z: usize,
    group_count_x: usize,
    group_count_y: usize,
    group_count_z: usize
)

Wrapper for vkCmdDispatchBase.

pub fn cmd_push_descriptor_set(
    &self,
    pipeline_bind_point: VkPipelineBindPoint,
    layout: VkPipelineLayout,
    set: usize,
    descriptor_writes: Vec<VkWriteDescriptorSet>
)

Wrapper for vkCmdPushDescriptorSetKHR.

pub fn cmd_push_descriptor_set_with_template(
    &self,
    descriptor_update_template: VkDescriptorUpdateTemplate,
    layout: VkPipelineLayout,
    set: usize,
    data: *mut u8
)

Wrapper for vkCmdPushDescriptorSetWithTemplateKHR.

pub fn cmd_begin_render_pass_2(
    &self,
    render_pass_begin: VkRenderPassBeginInfo,
    subpass_begin_info: VkSubpassBeginInfo
)

Wrapper for vkCmdBeginRenderPass2KHR.

pub fn cmd_next_subpass_2(
    &self,
    subpass_begin_info: VkSubpassBeginInfo,
    subpass_end_info: VkSubpassEndInfo
)

Wrapper for vkCmdNextSubpass2KHR.

pub fn cmd_end_render_pass_2(&self, subpass_end_info: VkSubpassEndInfo)

Wrapper for vkCmdEndRenderPass2KHR.

pub fn cmd_draw_indirect_count(
    &self,
    buffer: VkBuffer,
    offset: usize,
    count_buffer: VkBuffer,
    count_buffer_offset: usize,
    max_draw_count: usize,
    stride: usize
)

Wrapper for vkCmdDrawIndirectCountKHR.

pub fn cmd_draw_indexed_indirect_count(
    &self,
    buffer: VkBuffer,
    offset: usize,
    count_buffer: VkBuffer,
    count_buffer_offset: usize,
    max_draw_count: usize,
    stride: usize
)

Wrapper for vkCmdDrawIndexedIndirectCountKHR.

pub fn cmd_debug_marker_begin(&self, marker_info: VkDebugMarkerMarkerInfo)

Wrapper for vkCmdDebugMarkerBeginEXT.

pub fn cmd_debug_marker_end(&self)

Wrapper for vkCmdDebugMarkerEndEXT.

pub fn cmd_debug_marker_insert(&self, marker_info: VkDebugMarkerMarkerInfo)

Wrapper for vkCmdDebugMarkerInsertEXT.

pub fn cmd_bind_transform_feedback_buffers(
    &self,
    first_binding: usize,
    buffers: Vec<VkBuffer>,
    offsets: Vec<usize>,
    sizes: Option<Vec<usize>>
)

Wrapper for vkCmdBindTransformFeedbackBuffersEXT.

pub fn cmd_begin_transform_feedback(
    &self,
    first_counter_buffer: usize,
    counter_buffers: Vec<VkBuffer>,
    counter_buffer_offsets: Option<Vec<usize>>
)

Wrapper for vkCmdBeginTransformFeedbackEXT.

pub fn cmd_end_transform_feedback(
    &self,
    first_counter_buffer: usize,
    counter_buffers: Vec<VkBuffer>,
    counter_buffer_offsets: Option<Vec<usize>>
)

Wrapper for vkCmdEndTransformFeedbackEXT.

pub fn cmd_begin_query_indexed(
    &self,
    query_pool: VkQueryPool,
    query: usize,
    flags: VkQueryControlFlags,
    index: usize
)

Wrapper for vkCmdBeginQueryIndexedEXT.

pub fn cmd_end_query_indexed(
    &self,
    query_pool: VkQueryPool,
    query: usize,
    index: usize
)

Wrapper for vkCmdEndQueryIndexedEXT.

pub fn cmd_draw_indirect_byte_count(
    &self,
    instance_count: usize,
    first_instance: usize,
    counter_buffer: VkBuffer,
    counter_buffer_offset: usize,
    counter_offset: usize,
    vertex_stride: usize
)

Wrapper for vkCmdDrawIndirectByteCountEXT.

pub fn cmd_begin_conditional_rendering(
    &self,
    conditional_rendering_begin: VkConditionalRenderingBeginInfo
)

Wrapper for vkCmdBeginConditionalRenderingEXT.

pub fn cmd_end_conditional_rendering(&self)

Wrapper for vkCmdEndConditionalRenderingEXT.

pub fn cmd_process_commands(
    &self,
    process_commands_info: VkCmdProcessCommandsInfo
)

Wrapper for vkCmdProcessCommandsNVX.

pub fn cmd_reserve_space_for_commands(
    &self,
    reserve_space_info: VkCmdReserveSpaceForCommandsInfo
)

Wrapper for vkCmdReserveSpaceForCommandsNVX.

pub fn cmd_set_viewport_wscaling(
    &self,
    first_viewport: usize,
    viewport_wscalings: Vec<VkViewportWScaling>
)

Wrapper for vkCmdSetViewportWScalingNV.

pub fn cmd_set_discard_rectangle(
    &self,
    first_discard_rectangle: usize,
    discard_rectangles: Vec<VkRect2D>
)

Wrapper for vkCmdSetDiscardRectangleEXT.

pub fn cmd_begin_debug_utils_label(&self, label_info: VkDebugUtilsLabel)

Wrapper for vkCmdBeginDebugUtilsLabelEXT.

pub fn cmd_end_debug_utils_label(&self)

Wrapper for vkCmdEndDebugUtilsLabelEXT.

pub fn cmd_insert_debug_utils_label(&self, label_info: VkDebugUtilsLabel)

Wrapper for vkCmdInsertDebugUtilsLabelEXT.

pub fn cmd_set_sample_locations(
    &self,
    sample_locations_info: VkSampleLocationsInfo
)

Wrapper for vkCmdSetSampleLocationsEXT.

pub fn cmd_bind_shading_rate_image(
    &self,
    image_view: VkImageView,
    image_layout: VkImageLayout
)

Wrapper for vkCmdBindShadingRateImageNV.

pub fn cmd_set_viewport_shading_rate_palette(
    &self,
    first_viewport: usize,
    shading_rate_palettes: Vec<VkShadingRatePalette>
)

Wrapper for vkCmdSetViewportShadingRatePaletteNV.

pub fn cmd_set_coarse_sample_order(
    &self,
    sample_order_type: VkCoarseSampleOrderType,
    custom_sample_orders: Vec<VkCoarseSampleOrderCustom>
)

Wrapper for vkCmdSetCoarseSampleOrderNV.

pub fn cmd_build_acceleration_structure(
    &self,
    info: VkAccelerationStructureInfo,
    instance_data: Option<VkBuffer>,
    instance_offset: usize,
    update: bool,
    dst: VkAccelerationStructure,
    src: Option<VkAccelerationStructure>,
    scratch: VkBuffer,
    scratch_offset: usize
)

Wrapper for vkCmdBuildAccelerationStructureNV.

pub fn cmd_copy_acceleration_structure(
    &self,
    dst: VkAccelerationStructure,
    src: VkAccelerationStructure,
    mode: VkCopyAccelerationStructureMode
)

Wrapper for vkCmdCopyAccelerationStructureNV.

pub fn cmd_trace_rays(
    &self,
    raygen_shader_binding_table_buffer: VkBuffer,
    raygen_shader_binding_offset: usize,
    miss_shader_binding_table_buffer: Option<VkBuffer>,
    miss_shader_binding_offset: usize,
    miss_shader_binding_stride: usize,
    hit_shader_binding_table_buffer: Option<VkBuffer>,
    hit_shader_binding_offset: usize,
    hit_shader_binding_stride: usize,
    callable_shader_binding_table_buffer: Option<VkBuffer>,
    callable_shader_binding_offset: usize,
    callable_shader_binding_stride: usize,
    width: usize,
    height: usize,
    depth: usize
)

Wrapper for vkCmdTraceRaysNV.

pub fn cmd_write_acceleration_structures_properties(
    &self,
    acceleration_structures: Vec<VkAccelerationStructure>,
    query_type: VkQueryType,
    query_pool: VkQueryPool,
    first_query: usize
)

Wrapper for vkCmdWriteAccelerationStructuresPropertiesNV.

pub fn cmd_write_buffer_marker(
    &self,
    pipeline_stage: VkPipelineStageFlags,
    dst_buffer: VkBuffer,
    dst_offset: usize,
    marker: usize
)

Wrapper for vkCmdWriteBufferMarkerAMD.

pub fn cmd_draw_mesh_tasks(&self, task_count: usize, first_task: usize)

Wrapper for vkCmdDrawMeshTasksNV.

pub fn cmd_draw_mesh_tasks_indirect(
    &self,
    buffer: VkBuffer,
    offset: usize,
    draw_count: usize,
    stride: usize
)

Wrapper for vkCmdDrawMeshTasksIndirectNV.

pub fn cmd_draw_mesh_tasks_indirect_count(
    &self,
    buffer: VkBuffer,
    offset: usize,
    count_buffer: VkBuffer,
    count_buffer_offset: usize,
    max_draw_count: usize,
    stride: usize
)

Wrapper for vkCmdDrawMeshTasksIndirectCountNV.

pub fn cmd_set_exclusive_scissor(
    &self,
    first_exclusive_scissor: usize,
    exclusive_scissors: Vec<VkRect2D>
)

Wrapper for vkCmdSetExclusiveScissorNV.

pub fn cmd_set_checkpoint(&self, checkpoint_marker: *mut u8)

Wrapper for vkCmdSetCheckpointNV.

Trait Implementations

impl Copy for VkCommandBuffer

impl Clone for VkCommandBuffer

fn clone(&self) -> VkCommandBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq<VkCommandBuffer> for VkCommandBuffer

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Default for VkCommandBuffer

fn default() -> VkCommandBuffer

Returns the "default value" for a type.

impl Debug for VkCommandBuffer

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

Formats the value using the given formatter.