Struct vulkano::command_buffer::AutoCommandBufferBuilder

pub struct AutoCommandBufferBuilder<L, P = StandardCommandPoolBuilder> { /* private fields */ }

Note that command buffers allocated from the default command pool (Arc<StandardCommandPool>) don’t implement the Send and Sync traits. If you use this pool, then the AutoCommandBufferBuilder will not implement Send and Sync either. Once a command buffer is built, however, it does implement Send and Sync.

Implementations

impl AutoCommandBufferBuilder<PrimaryAutoCommandBuffer, StandardCommandPoolBuilder>

pub fn primary(
    device: Arc<Device>,
    queue_family: QueueFamily<'_>,
    usage: CommandBufferUsage
) -> Result<AutoCommandBufferBuilder<PrimaryAutoCommandBuffer, StandardCommandPoolBuilder>, OomError>

Starts building a primary command buffer.

impl AutoCommandBufferBuilder<SecondaryAutoCommandBuffer, StandardCommandPoolBuilder>

pub fn secondary_compute(
    device: Arc<Device>,
    queue_family: QueueFamily<'_>,
    usage: CommandBufferUsage
) -> Result<AutoCommandBufferBuilder<SecondaryAutoCommandBuffer, StandardCommandPoolBuilder>, OomError>

Starts building a secondary compute command buffer.

pub fn secondary_compute_inherit_queries(
    device: Arc<Device>,
    queue_family: QueueFamily<'_>,
    usage: CommandBufferUsage,
    occlusion_query: Option<QueryControlFlags>,
    query_statistics_flags: QueryPipelineStatisticFlags
) -> Result<AutoCommandBufferBuilder<SecondaryAutoCommandBuffer, StandardCommandPoolBuilder>, BeginError>

Same as secondary_compute, but allows specifying how queries are being inherited.

pub fn secondary_graphics(
    device: Arc<Device>,
    queue_family: QueueFamily<'_>,
    usage: CommandBufferUsage,
    subpass: Subpass
) -> Result<AutoCommandBufferBuilder<SecondaryAutoCommandBuffer, StandardCommandPoolBuilder>, OomError>

Starts building a secondary graphics command buffer.

pub fn secondary_graphics_inherit_queries(
    device: Arc<Device>,
    queue_family: QueueFamily<'_>,
    usage: CommandBufferUsage,
    subpass: Subpass,
    occlusion_query: Option<QueryControlFlags>,
    query_statistics_flags: QueryPipelineStatisticFlags
) -> Result<AutoCommandBufferBuilder<SecondaryAutoCommandBuffer, StandardCommandPoolBuilder>, BeginError>

Same as secondary_graphics, but allows specifying how queries are being inherited.

impl<P> AutoCommandBufferBuilder<PrimaryAutoCommandBuffer<P::Alloc>, P> where
    P: CommandPoolBuilderAlloc, 

pub fn build(self) -> Result<PrimaryAutoCommandBuffer<P::Alloc>, BuildError>

Builds the command buffer.

impl<P> AutoCommandBufferBuilder<SecondaryAutoCommandBuffer<P::Alloc>, P> where
    P: CommandPoolBuilderAlloc, 

pub fn build(self) -> Result<SecondaryAutoCommandBuffer<P::Alloc>, BuildError>

Builds the command buffer.

impl<L, P> AutoCommandBufferBuilder<L, P>

pub fn state(&self) -> CommandBufferState<'_>

Returns the binding/setting state.

pub fn bind_descriptor_sets<S>(
    &mut self,
    pipeline_bind_point: PipelineBindPoint,
    pipeline_layout: Arc<PipelineLayout>,
    first_set: u32,
    descriptor_sets: S
) -> &mut Self where
    S: DescriptorSetsCollection, 

Binds descriptor sets for future dispatch or draw calls.

Panics

• Panics if the queue family of the command buffer does not support pipeline_bind_point.
• Panics if the highest descriptor set slot being bound is not less than the number of sets in pipeline_layout.
• Panics if self and any element of descriptor_sets do not belong to the same device.

pub fn bind_index_buffer<Ib, I>(&mut self, index_buffer: Arc<Ib>) -> &mut Self where
    Ib: TypedBufferAccess<Content = [I]> + 'static,
    I: Index + 'static, 

Binds an index buffer for future indexed draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if self and index_buffer do not belong to the same device.
• Panics if index_buffer does not have the index_buffer usage enabled.
• If the index buffer contains u8 indices, panics if the index_type_uint8 feature is not enabled on the device.

pub fn bind_pipeline_compute(
    &mut self,
    pipeline: Arc<ComputePipeline>
) -> &mut Self

Binds a compute pipeline for future dispatch calls.

Panics

• Panics if the queue family of the command buffer does not support compute operations.
• Panics if self and pipeline do not belong to the same device.

pub fn bind_pipeline_graphics(
    &mut self,
    pipeline: Arc<GraphicsPipeline>
) -> &mut Self

Binds a graphics pipeline for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if self and pipeline do not belong to the same device.

pub fn bind_vertex_buffers<V>(
    &mut self,
    first_binding: u32,
    vertex_buffers: V
) -> &mut Self where
    V: VertexBuffersCollection, 

Binds vertex buffers for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the highest vertex buffer binding being bound is greater than the max_vertex_input_bindings
• Panics if self and any element of vertex_buffers do not belong to the same device.
• Panics if any element of vertex_buffers does not have the vertex_buffer usage enabled.

pub fn blit_image(
    &mut self,
    source: Arc<dyn ImageAccess>,
    source_top_left: [i32; 3],
    source_bottom_right: [i32; 3],
    source_base_array_layer: u32,
    source_mip_level: u32,
    destination: Arc<dyn ImageAccess>,
    destination_top_left: [i32; 3],
    destination_bottom_right: [i32; 3],
    destination_base_array_layer: u32,
    destination_mip_level: u32,
    layer_count: u32,
    filter: Filter
) -> Result<&mut Self, BlitImageError>

Adds a command that blits an image to another.

A blit is similar to an image copy operation, except that the portion of the image that is transferred can be resized. You choose an area of the source and an area of the destination, and the implementation will resize the area of the source so that it matches the size of the area of the destination before writing it.

Blit operations have several restrictions:

• Blit operations are only allowed on queue families that support graphics operations.
• The format of the source and destination images must support blit operations, which depends on the Vulkan implementation. Vulkan guarantees that some specific formats must always be supported. See tables 52 to 61 of the specifications.
• Only single-sampled images are allowed.
• You can only blit between two images whose formats belong to the same type. The types are: floating-point, signed integers, unsigned integers, depth-stencil.
• If you blit between depth, stencil or depth-stencil images, the format of both images must match exactly.
• If you blit between depth, stencil or depth-stencil images, only the Nearest filter is allowed.
• For two-dimensional images, the Z coordinate must be 0 for the top-left offset and 1 for the bottom-right offset. Same for the Y coordinate for one-dimensional images.
• For non-array images, the base array layer must be 0 and the number of layers must be 1.

If layer_count is greater than 1, the blit will happen between each individual layer as if they were separate images.

Panic

• Panics if the source or the destination was not created with device.

pub fn clear_attachments<A, R>(
    &mut self,
    attachments: A,
    rects: R
) -> Result<&mut Self, ClearAttachmentsError> where
    A: IntoIterator<Item = ClearAttachment>,
    R: IntoIterator<Item = ClearRect>, 

Adds a command that clears specific regions of specific attachments of the framebuffer.

attachments specify the types of attachments and their clear values. rects specify the regions to clear.

A graphics pipeline must have been bound using bind_pipeline_graphics. And the command must be inside render pass.

If the render pass instance this is recorded in uses multiview, then ClearRect.base_array_layer must be zero and ClearRect.layer_count must be one.

The rectangle area must be inside the render area ranges.

pub fn clear_color_image(
    &mut self,
    image: Arc<dyn ImageAccess>,
    color: ClearValue
) -> Result<&mut Self, ClearColorImageError>

Adds a command that clears all the layers and mipmap levels of a color image with a specific value.

Panic

Panics if color is not a color value.

pub fn clear_color_image_dimensions(
    &mut self,
    image: Arc<dyn ImageAccess>,
    base_array_layer: u32,
    layer_count: u32,
    base_mip_level: u32,
    level_count: u32,
    color: ClearValue
) -> Result<&mut Self, ClearColorImageError>

Adds a command that clears a color image with a specific value.

Panic

• Panics if color is not a color value.

pub fn clear_depth_stencil_image(
    &mut self,
    image: Arc<dyn ImageAccess>,
    clear_value: ClearValue
) -> Result<&mut Self, ClearDepthStencilImageError>

Adds a command that clears all the layers of a depth / stencil image with a specific value.

Panic

Panics if clear_value is not a depth / stencil value.

pub fn clear_depth_stencil_image_dimensions(
    &mut self,
    image: Arc<dyn ImageAccess>,
    base_array_layer: u32,
    layer_count: u32,
    clear_value: ClearValue
) -> Result<&mut Self, ClearDepthStencilImageError>

Adds a command that clears a depth / stencil image with a specific value.

Panic

• Panics if clear_value is not a depth / stencil value.

pub fn copy_buffer<S, D, T>(
    &mut self,
    source: Arc<S>,
    destination: Arc<D>
) -> Result<&mut Self, CopyBufferError> where
    S: TypedBufferAccess<Content = T> + 'static,
    D: TypedBufferAccess<Content = T> + 'static,
    T: ?Sized, 

Adds a command that copies from a buffer to another.

This command will copy from the source to the destination. If their size is not equal, then the amount of data copied is equal to the smallest of the two.

pub fn copy_buffer_dimensions<S, D, T>(
    &mut self,
    source: Arc<S>,
    source_offset: DeviceSize,
    destination: Arc<D>,
    destination_offset: DeviceSize,
    count: DeviceSize
) -> Result<&mut Self, CopyBufferError> where
    S: TypedBufferAccess<Content = [T]> + 'static,
    D: TypedBufferAccess<Content = [T]> + 'static, 

Adds a command that copies a range from the source to the destination buffer. Panics if out of bounds.

pub fn copy_buffer_to_image(
    &mut self,
    source: Arc<dyn BufferAccess>,
    destination: Arc<dyn ImageAccess>
) -> Result<&mut Self, CopyBufferImageError>

Adds a command that copies from a buffer to an image.

pub fn copy_buffer_to_image_dimensions(
    &mut self,
    source: Arc<dyn BufferAccess>,
    destination: Arc<dyn ImageAccess>,
    offset: [u32; 3],
    size: [u32; 3],
    base_array_layer: u32,
    layer_count: u32,
    mip_level: u32
) -> Result<&mut Self, CopyBufferImageError>

Adds a command that copies from a buffer to an image.

pub fn copy_image(
    &mut self,
    source: Arc<dyn ImageAccess>,
    source_offset: [i32; 3],
    source_base_array_layer: u32,
    source_mip_level: u32,
    destination: Arc<dyn ImageAccess>,
    destination_offset: [i32; 3],
    destination_base_array_layer: u32,
    destination_mip_level: u32,
    extent: [u32; 3],
    layer_count: u32
) -> Result<&mut Self, CopyImageError>

Adds a command that copies an image to another.

Copy operations have several restrictions:

• Copy operations are only allowed on queue families that support transfer, graphics, or compute operations.
• The number of samples in the source and destination images must be equal.
• The size of the uncompressed element format of the source image must be equal to the compressed element format of the destination.
• If you copy between depth, stencil or depth-stencil images, the format of both images must match exactly.
• For two-dimensional images, the Z coordinate must be 0 for the image offsets and 1 for the extent. Same for the Y coordinate for one-dimensional images.
• For non-array images, the base array layer must be 0 and the number of layers must be 1.

If layer_count is greater than 1, the copy will happen between each individual layer as if they were separate images.

Panic

• Panics if the source or the destination was not created with device.

pub fn copy_image_to_buffer(
    &mut self,
    source: Arc<dyn ImageAccess>,
    destination: Arc<dyn BufferAccess>
) -> Result<&mut Self, CopyBufferImageError>

Adds a command that copies from an image to a buffer.

pub fn copy_image_to_buffer_dimensions(
    &mut self,
    source: Arc<dyn ImageAccess>,
    destination: Arc<dyn BufferAccess>,
    offset: [u32; 3],
    size: [u32; 3],
    base_array_layer: u32,
    layer_count: u32,
    mip_level: u32
) -> Result<&mut Self, CopyBufferImageError>

Adds a command that copies from an image to a buffer.

pub fn debug_marker_begin(
    &mut self,
    name: &'static CStr,
    color: [f32; 4]
) -> Result<&mut Self, DebugMarkerError>

Open a command buffer debug label region.

Note: you need to enable VK_EXT_debug_utils extension when creating an instance.

pub fn debug_marker_end(&mut self) -> Result<&mut Self, DebugMarkerError>

Close a command buffer label region.

Note: you need to open a command buffer label region first with debug_marker_begin. Note: you need to enable VK_EXT_debug_utils extension when creating an instance.

pub fn debug_marker_insert(
    &mut self,
    name: &'static CStr,
    color: [f32; 4]
) -> Result<&mut Self, DebugMarkerError>

Insert a label into a command buffer.

Note: you need to enable VK_EXT_debug_utils extension when creating an instance.

pub fn dispatch(
    &mut self,
    group_counts: [u32; 3]
) -> Result<&mut Self, DispatchError>

Perform a single compute operation using a compute pipeline.

A compute pipeline must have been bound using bind_pipeline_compute. Any resources used by the compute pipeline, such as descriptor sets, must have been set beforehand.

pub fn dispatch_indirect<Inb>(
    &mut self,
    indirect_buffer: Arc<Inb>
) -> Result<&mut Self, DispatchIndirectError> where
    Inb: TypedBufferAccess<Content = [DispatchIndirectCommand]> + 'static, 

Perform multiple compute operations using a compute pipeline. One dispatch is performed for each DispatchIndirectCommand struct in indirect_buffer.

A compute pipeline must have been bound using bind_pipeline_compute. Any resources used by the compute pipeline, such as descriptor sets, must have been set beforehand.

pub fn draw(
    &mut self,
    vertex_count: u32,
    instance_count: u32,
    first_vertex: u32,
    first_instance: u32
) -> Result<&mut Self, DrawError>

Perform a single draw operation using a graphics pipeline.

The parameters specify the first vertex and the number of vertices to draw, and the first instance and number of instances. For non-instanced drawing, specify instance_count as 1 and first_instance as 0.

A graphics pipeline must have been bound using bind_pipeline_graphics. Any resources used by the graphics pipeline, such as descriptor sets, vertex buffers and dynamic state, must have been set beforehand. If the bound graphics pipeline uses vertex buffers, then the provided vertex and instance ranges must be in range of the bound vertex buffers.

pub fn draw_indirect<Inb>(
    &mut self,
    indirect_buffer: Arc<Inb>
) -> Result<&mut Self, DrawIndirectError> where
    Inb: TypedBufferAccess<Content = [DrawIndirectCommand]> + Send + Sync + 'static, 

Perform multiple draw operations using a graphics pipeline.

One draw is performed for each DrawIndirectCommand struct in indirect_buffer. The maximum number of draw commands in the buffer is limited by the max_draw_indirect_count limit. This limit is 1 unless the multi_draw_indirect feature has been enabled.

A graphics pipeline must have been bound using bind_pipeline_graphics. Any resources used by the graphics pipeline, such as descriptor sets, vertex buffers and dynamic state, must have been set beforehand. If the bound graphics pipeline uses vertex buffers, then the vertex and instance ranges of each DrawIndirectCommand in the indirect buffer must be in range of the bound vertex buffers.

pub fn draw_indexed(
    &mut self,
    index_count: u32,
    instance_count: u32,
    first_index: u32,
    vertex_offset: i32,
    first_instance: u32
) -> Result<&mut Self, DrawIndexedError>

Perform a single draw operation using a graphics pipeline, using an index buffer.

The parameters specify the first index and the number of indices in the index buffer that should be used, and the first instance and number of instances. For non-instanced drawing, specify instance_count as 1 and first_instance as 0. The vertex_offset is a constant value that should be added to each index in the index buffer to produce the final vertex number to be used.

An index buffer must have been bound using bind_index_buffer, and the provided index range must be in range of the bound index buffer.

A graphics pipeline must have been bound using bind_pipeline_graphics. Any resources used by the graphics pipeline, such as descriptor sets, vertex buffers and dynamic state, must have been set beforehand. If the bound graphics pipeline uses vertex buffers, then the provided instance range must be in range of the bound vertex buffers. The vertex indices in the index buffer must be in range of the bound vertex buffers.

pub fn draw_indexed_indirect<Inb>(
    &mut self,
    indirect_buffer: Arc<Inb>
) -> Result<&mut Self, DrawIndexedIndirectError> where
    Inb: TypedBufferAccess<Content = [DrawIndexedIndirectCommand]> + 'static, 

Perform multiple draw operations using a graphics pipeline, using an index buffer.

One draw is performed for each DrawIndexedIndirectCommand struct in indirect_buffer. The maximum number of draw commands in the buffer is limited by the max_draw_indirect_count limit. This limit is 1 unless the multi_draw_indirect feature has been enabled.

An index buffer must have been bound using bind_index_buffer, and the index ranges of each DrawIndexedIndirectCommand in the indirect buffer must be in range of the bound index buffer.

A graphics pipeline must have been bound using bind_pipeline_graphics. Any resources used by the graphics pipeline, such as descriptor sets, vertex buffers and dynamic state, must have been set beforehand. If the bound graphics pipeline uses vertex buffers, then the instance ranges of each DrawIndexedIndirectCommand in the indirect buffer must be in range of the bound vertex buffers.

pub fn fill_buffer(
    &mut self,
    buffer: Arc<dyn BufferAccess>,
    data: u32
) -> Result<&mut Self, FillBufferError>

Adds a command that writes the content of a buffer.

This function is similar to the memset function in C. The data parameter is a number that will be repeatedly written through the entire buffer.

Note: This function is technically safe because buffers can only contain integers or floating point numbers, which are always valid whatever their memory representation is. But unless your buffer actually contains only 32-bits integers, you are encouraged to use this function only for zeroing the content of a buffer by passing 0 for the data.

pub fn push_constants<Pc>(
    &mut self,
    pipeline_layout: Arc<PipelineLayout>,
    offset: u32,
    push_constants: Pc
) -> &mut Self

Sets push constants for future dispatch or draw calls.

Panics

• Panics if offset is not a multiple of 4.
• Panics if the size of push_constants is not a multiple of 4.
• Panics if any of the bytes in push_constants do not fall within any of the pipeline layout’s push constant ranges.

pub fn push_descriptor_set(
    &mut self,
    pipeline_bind_point: PipelineBindPoint,
    pipeline_layout: Arc<PipelineLayout>,
    set_num: u32,
    descriptor_writes: impl IntoIterator<Item = WriteDescriptorSet>
) -> &mut Self

Pushes descriptor data directly into the command buffer for future dispatch or draw calls.

Panics

• Panics if the queue family of the command buffer does not support pipeline_bind_point.
• Panics if the khr_push_descriptor extension is not enabled on the device.
• Panics if set_num is not less than the number of sets in pipeline_layout.
• Panics if an element of descriptor_writes is not compatible with pipeline_layout.

pub fn set_blend_constants(&mut self, constants: [f32; 4]) -> &mut Self

Sets the dynamic blend constants for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_color_write_enable<I>(&mut self, enables: I) -> &mut Self where
    I: IntoIterator<Item = bool>,
    I::IntoIter: ExactSizeIterator, 

Sets whether dynamic color writes should be enabled for each attachment in the framebuffer.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the color_write_enable feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• If there is a graphics pipeline with color blend state bound, enables.len() must equal
• attachments.len().

pub fn set_cull_mode(&mut self, cull_mode: CullMode) -> &mut Self

Sets the dynamic cull mode for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_depth_bias(
    &mut self,
    constant_factor: f32,
    clamp: f32,
    slope_factor: f32
) -> &mut Self

Sets the dynamic depth bias values for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.
• If the depth_bias_clamp feature is not enabled on the device, panics if clamp is not 0.0.

pub fn set_depth_bias_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic depth bias is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state2 feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_depth_bounds(&mut self, min: f32, max: f32) -> &mut Self

Sets the dynamic depth bounds for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.
• If the ext_depth_range_unrestricted device extension is not enabled, panics if min or max is not between 0.0 and 1.0 inclusive.

pub fn set_depth_bounds_test_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic depth bounds testing is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_depth_compare_op(&mut self, compare_op: CompareOp) -> &mut Self

Sets the dynamic depth compare op for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_depth_test_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic depth testing is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_depth_write_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic depth write is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_discard_rectangle<I>(
    &mut self,
    first_rectangle: u32,
    rectangles: I
) -> &mut Self where
    I: IntoIterator<Item = Scissor>, 

Sets the dynamic discard rectangles for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the ext_discard_rectangles extension is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if the highest discard rectangle slot being set is greater than the max_discard_rectangles device property.

pub fn set_front_face(&mut self, face: FrontFace) -> &mut Self

Sets the dynamic front face for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_line_stipple(&mut self, factor: u32, pattern: u16) -> &mut Self

Sets the dynamic line stipple values for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the ext_line_rasterization extension is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if factor is not between 1 and 256 inclusive.

pub fn set_line_width(&mut self, line_width: f32) -> &mut Self

Sets the dynamic line width for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.
• If the wide_lines feature is not enabled, panics if line_width is not 1.0.

pub fn set_logic_op(&mut self, logic_op: LogicOp) -> &mut Self

Sets the dynamic logic op for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the extended_dynamic_state2_logic_op feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_patch_control_points(&mut self, num: u32) -> &mut Self

Sets the dynamic number of patch control points for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the extended_dynamic_state2_patch_control_points feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if num is 0.
• Panics if num is greater than the max_tessellation_patch_size property of the device.

pub fn set_primitive_restart_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic primitive restart is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state2 feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_primitive_topology(
    &mut self,
    topology: PrimitiveTopology
) -> &mut Self

Sets the dynamic primitive topology for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• If the geometry_shader feature is not enabled, panics if topology is a WithAdjacency topology.
• If the tessellation_shader feature is not enabled, panics if topology is PatchList.

pub fn set_rasterizer_discard_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic rasterizer discard is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state2 feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_scissor<I>(&mut self, first_scissor: u32, scissors: I) -> &mut Self where
    I: IntoIterator<Item = Scissor>, 

Sets the dynamic scissors for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if the highest scissor slot being set is greater than the max_viewports device property.
• If the multi_viewport feature is not enabled, panics if first_scissor is not 0, or if more than 1 scissor is provided.

pub fn set_scissor_with_count<I>(&mut self, scissors: I) -> &mut Self where
    I: IntoIterator<Item = Scissor>, 

Sets the dynamic scissors with count for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if the highest scissor slot being set is greater than the max_viewports device property.
• If the multi_viewport feature is not enabled, panics if more than 1 scissor is provided.

pub fn set_stencil_compare_mask(
    &mut self,
    faces: StencilFaces,
    compare_mask: u32
) -> &mut Self

Sets the dynamic stencil compare mask on one or both faces for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_stencil_op(
    &mut self,
    faces: StencilFaces,
    fail_op: StencilOp,
    pass_op: StencilOp,
    depth_fail_op: StencilOp,
    compare_op: CompareOp
) -> &mut Self

Sets the dynamic stencil ops on one or both faces for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_stencil_reference(
    &mut self,
    faces: StencilFaces,
    reference: u32
) -> &mut Self

Sets the dynamic stencil reference on one or both faces for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_stencil_test_enable(&mut self, enable: bool) -> &mut Self

Sets whether dynamic stencil testing is enabled for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_stencil_write_mask(
    &mut self,
    faces: StencilFaces,
    write_mask: u32
) -> &mut Self

Sets the dynamic stencil write mask on one or both faces for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.

pub fn set_viewport<I>(
    &mut self,
    first_viewport: u32,
    viewports: I
) -> &mut Self where
    I: IntoIterator<Item = Viewport>, 

Sets the dynamic viewports for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if the highest viewport slot being set is greater than the max_viewports device property.
• If the multi_viewport feature is not enabled, panics if first_viewport is not 0, or if more than 1 viewport is provided.

pub fn set_viewport_with_count<I>(&mut self, viewports: I) -> &mut Self where
    I: IntoIterator<Item = Viewport>, 

Sets the dynamic viewports with count for future draw calls.

Panics

• Panics if the queue family of the command buffer does not support graphics operations.
• Panics if the device API version is less than 1.3 and the extended_dynamic_state feature is not enabled on the device.
• Panics if the currently bound graphics pipeline already contains this state internally.
• Panics if the highest viewport slot being set is greater than the max_viewports device property.
• If the multi_viewport feature is not enabled, panics if more than 1 viewport is provided.

pub fn update_buffer<B, D, Dd>(
    &mut self,
    buffer: Arc<B>,
    data: Dd
) -> Result<&mut Self, UpdateBufferError> where
    B: TypedBufferAccess<Content = D> + 'static,
    D: BufferContents + ?Sized,
    Dd: SafeDeref<Target = D> + Send + Sync + 'static, 

Adds a command that writes data to a buffer.

If data is larger than the buffer, only the part of data that fits is written. If the buffer is larger than data, only the start of the buffer is written.

pub unsafe fn begin_query(
    &mut self,
    query_pool: Arc<QueryPool>,
    query: u32,
    flags: QueryControlFlags
) -> Result<&mut Self, BeginQueryError>

Adds a command that begins a query.

The query will be active until end_query is called for the same query.

Safety

The query must be unavailable, ensured by calling reset_query_pool.

pub fn end_query(
    &mut self,
    query_pool: Arc<QueryPool>,
    query: u32
) -> Result<&mut Self, EndQueryError>

Adds a command that ends an active query.

pub unsafe fn write_timestamp(
    &mut self,
    query_pool: Arc<QueryPool>,
    query: u32,
    stage: PipelineStage
) -> Result<&mut Self, WriteTimestampError>

Adds a command that writes a timestamp to a timestamp query.

Safety

The query must be unavailable, ensured by calling reset_query_pool.

pub fn copy_query_pool_results<D, T>(
    &mut self,
    query_pool: Arc<QueryPool>,
    queries: Range<u32>,
    destination: Arc<D>,
    flags: QueryResultFlags
) -> Result<&mut Self, CopyQueryPoolResultsError> where
    D: TypedBufferAccess<Content = [T]> + 'static,
    T: QueryResultElement, 

Adds a command that copies the results of a range of queries to a buffer on the GPU.

query_pool.ty().result_size() elements will be written for each query in the range, plus 1 extra element per query if QueryResultFlags::with_availability is enabled. The provided buffer must be large enough to hold the data.

See also get_results.

pub unsafe fn reset_query_pool(
    &mut self,
    query_pool: Arc<QueryPool>,
    queries: Range<u32>
) -> Result<&mut Self, ResetQueryPoolError>

Adds a command to reset a range of queries on a query pool.

The affected queries will be marked as “unavailable” after this command runs, and will no longer return any results. They will be ready to have new results recorded for them.

Safety

The queries in the specified range must not be active in another command buffer.

impl<P> AutoCommandBufferBuilder<PrimaryAutoCommandBuffer<P::Alloc>, P> where
    P: CommandPoolBuilderAlloc, 

Commands that can only be executed on primary command buffers

pub fn begin_render_pass<I>(
    &mut self,
    framebuffer: Arc<Framebuffer>,
    contents: SubpassContents,
    clear_values: I
) -> Result<&mut Self, BeginRenderPassError> where
    I: IntoIterator<Item = ClearValue>, 

Adds a command that enters a render pass.

If contents is SubpassContents::SecondaryCommandBuffers, then you will only be able to add secondary command buffers while you’re inside the first subpass of the render pass. If it is SubpassContents::Inline, you will only be able to add inline draw commands and not secondary command buffers.

C must contain exactly one clear value for each attachment in the framebuffer.

You must call this before you can add draw commands.

pub fn end_render_pass(
    &mut self
) -> Result<&mut Self, AutoCommandBufferBuilderContextError>

Adds a command that ends the current render pass.

This must be called after you went through all the subpasses and before you can build the command buffer or add further commands.

pub fn execute_commands<C>(
    &mut self,
    command_buffer: C
) -> Result<&mut Self, ExecuteCommandsError> where
    C: SecondaryCommandBuffer + 'static, 

Adds a command that executes a secondary command buffer.

If the flags that command_buffer was created with are more restrictive than those of self, then self will be restricted to match. E.g. executing a secondary command buffer with Flags::OneTimeSubmit will set self’s flags to Flags::OneTimeSubmit also.

pub fn execute_commands_from_vec<C>(
    &mut self,
    command_buffers: Vec<C>
) -> Result<&mut Self, ExecuteCommandsError> where
    C: SecondaryCommandBuffer + 'static, 

Adds a command that multiple secondary command buffers in a vector.

This requires that the secondary command buffers do not have resource conflicts; an error will be returned if there are any. Use execute_commands if you want to ensure that resource conflicts are automatically resolved.

pub fn next_subpass(
    &mut self,
    contents: SubpassContents
) -> Result<&mut Self, AutoCommandBufferBuilderContextError>

Adds a command that jumps to the next subpass of the current render pass.

Trait Implementations

impl<L, P> DeviceOwned for AutoCommandBufferBuilder<L, P>

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.