Struct vulkano::command_buffer::cb::UnsafeCommandBufferBuilder

pub struct UnsafeCommandBufferBuilder<P> where
    P: CommandPool,  { /* fields omitted */ }

Command buffer being built.

You can add commands to an UnsafeCommandBufferBuilder by using the AddCommand trait. The AddCommand<&Cmd> trait is implemented on the UnsafeCommandBufferBuilder for any Cmd that is a raw Vulkan command.

When you are finished adding commands, you can use the CommandBufferBuild trait to turn this builder into an UnsafeCommandBuffer.

Methods

impl<P> UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

unsafe fn new<R, F>(
    pool: &P,
    kind: Kind<R, F>,
    flags: Flags
) -> Result<UnsafeCommandBufferBuilder<P>, OomError> where
    R: RenderPassAbstract,
    F: FramebufferAbstract, 

Creates a new builder.

Safety

Creating and destroying an unsafe command buffer is not unsafe per se, but the commands that you add to it are unchecked, do not have any synchronization, and are not kept alive.

In other words, it is your job to make sure that the commands you add are valid, that they don't use resources that have been destroyed, and that they do not introduce any race condition.

Note: Some checks are still made with debug_assert!. Do not expect to be able to submit invalid commands.

unsafe fn already_allocated<R, F>(
    alloc: P::Builder,
    kind: Kind<R, F>,
    flags: Flags
) -> Result<UnsafeCommandBufferBuilder<P>, OomError> where
    R: RenderPassAbstract,
    F: FramebufferAbstract, 

Creates a new command buffer builder from an already-allocated command buffer.

Safety

See the new method.

The kind must match how the command buffer was allocated.

Trait Implementations

impl<P> DeviceOwned for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

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

Returns the device that owns Self.

impl<P> CommandBufferBuilder for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

fn queue_family(&self) -> QueueFamily

Returns the queue family of the command buffer builder.

fn fill_buffer<B, O>(
    self,
    buffer: B,
    data: u32
) -> Result<O, CommandBufferBuilderError<CmdFillBufferError>> where
    Self: Sized + AddCommand<CmdFillBuffer<B::Access>, Out = O>,
    B: Buffer, 

Adds a command that writes the content of a buffer.

fn update_buffer<B, D, O>(
    self,
    buffer: B,
    data: D
) -> Result<O, CommandBufferBuilderError<CmdUpdateBufferError>> where
    Self: Sized + AddCommand<CmdUpdateBuffer<B::Access, D>, Out = O>,
    B: Buffer + TypedBuffer<Content = D>,
    D: 'static, 

Adds a command that writes data to a buffer.

fn copy_buffer<S, D, O>(
    self,
    src: S,
    dest: D
) -> Result<O, CommandBufferBuilderError<CmdCopyBufferError>> where
    Self: Sized + AddCommand<CmdCopyBuffer<S::Access, D::Access>, Out = O>,
    S: Buffer,
    D: Buffer, 

Adds a command that copies from a buffer to another.

fn copy_buffer_to_image<B, I, O>(
    self,
    buffer: B,
    image: I
) -> Result<O, CommandBufferBuilderError<CmdCopyBufferToImageError>> where
    Self: Sized + AddCommand<CmdCopyBufferToImage<B::Access, I::Access>, Out = O>,
    B: Buffer,
    I: Image, 

Adds a command that copies the content of a buffer to an image.

fn copy_buffer_to_image_dimensions<B, I, O>(
    self,
    buffer: B,
    image: I,
    offset: [u32; 3],
    size: [u32; 3],
    first_layer: u32,
    num_layers: u32,
    mipmap: u32
) -> Result<O, CommandBufferBuilderError<CmdCopyBufferToImageError>> where
    Self: Sized + AddCommand<CmdCopyBufferToImage<B::Access, I::Access>, Out = O>,
    B: Buffer,
    I: Image, 

Same as copy_buffer_to_image but lets you specify a range for the destination image.

fn begin_render_pass<F, C, O>(
    self,
    framebuffer: F,
    secondary: bool,
    clear_values: C
) -> Result<O, CommandAddError> where
    Self: Sized + AddCommand<CmdBeginRenderPass<Arc<RenderPassAbstract + Send + Sync>, F>, Out = O>,
    F: FramebufferAbstract + RenderPassDescClearValues<C>, 

Adds a command that starts a render pass.

fn next_subpass<O>(self, secondary: bool) -> Result<O, CommandAddError> where
    Self: Sized + AddCommand<CmdNextSubpass, Out = O>, 

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

fn end_render_pass<O>(self) -> Result<O, CommandAddError> where
    Self: Sized + AddCommand<CmdEndRenderPass, Out = O>, 

Adds a command that ends the current render pass.

fn draw<P, S, Pc, V, O>(
    self,
    pipeline: P,
    dynamic: DynamicState,
    vertices: V,
    sets: S,
    push_constants: Pc
) -> Result<O, CommandAddError> where
    Self: Sized + AddCommand<CmdDraw<V, P, S, Pc>, Out = O>,
    S: DescriptorSetsCollection,
    P: VertexSource<V> + GraphicsPipelineAbstract + Clone, 

Adds a command that draws.

fn draw_indexed<P, S, Pc, V, Ib, I, O>(
    self,
    pipeline: P,
    dynamic: DynamicState,
    vertices: V,
    index_buffer: Ib,
    sets: S,
    push_constants: Pc
) -> Result<O, CommandAddError> where
    Self: Sized + AddCommand<CmdDrawIndexed<V, Ib::Access, P, S, Pc>, Out = O>,
    S: DescriptorSetsCollection,
    P: VertexSource<V> + GraphicsPipelineAbstract + Clone,
    Ib: Buffer,
    Ib::Access: TypedBufferAccess<Content = [I]>,
    I: Index + 'static, 

Adds a command that draws indexed vertices.

fn draw_indirect<P, S, Pc, V, B, O>(
    self,
    pipeline: P,
    dynamic: DynamicState,
    vertices: V,
    indirect_buffer: B,
    sets: S,
    push_constants: Pc
) -> Result<O, CommandAddError> where
    Self: Sized + AddCommand<CmdDrawIndirect<V, B::Access, P, S, Pc>, Out = O>,
    S: DescriptorSetsCollection,
    P: VertexSource<V> + GraphicsPipelineAbstract + Clone,
    B: Buffer,
    B::Access: TypedBufferAccess<Content = [DrawIndirectCommand]>, 

Adds an indirect draw command.

fn dispatch<P, S, Pc, O>(
    self,
    dimensions: [u32; 3],
    pipeline: P,
    sets: S,
    push_constants: Pc
) -> Result<O, CommandBufferBuilderError<CmdDispatchError>> where
    Self: Sized + AddCommand<CmdDispatch<P, S, Pc>, Out = O>,
    S: DescriptorSetsCollection,
    P: Clone + ComputePipelineAbstract, 

Executes a compute shader.

fn build(self) -> Result<Self::Out, Self::Err> where
    Self: Sized + CommandBufferBuild, 

Builds the actual command buffer.

fn supports_graphics(&self) -> bool

Returns true if the pool of the builder supports graphics operations.

fn supports_compute(&self) -> bool

Returns true if the pool of the builder supports compute operations.

impl<P> VulkanObject for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Object = CommandBuffer

The type of the object.

fn internal_object(&self) -> CommandBuffer

Returns a reference to the object.

impl<P> CommandBufferBuild for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBuffer<P>

The type of the built command buffer.

type Err = OomError

Error that can be returned when building.

fn build(self) -> Result<Self::Out, OomError>

Builds the command buffer.

impl<'a, P, Rp, F> AddCommand<&'a CmdBeginRenderPass<Rp, F>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdBeginRenderPass<Rp, F>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, Pl, S> AddCommand<&'a CmdBindDescriptorSets<S, Pl>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdBindDescriptorSets<S, Pl>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, B> AddCommand<&'a CmdBindIndexBuffer<B>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdBindIndexBuffer<B>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, Pl> AddCommand<&'a CmdBindPipeline<Pl>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdBindPipeline<Pl>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, B> AddCommand<&'a CmdBindVertexBuffers<B>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdBindVertexBuffers<B>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, S, D> AddCommand<&'a CmdBlitImage<S, D>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdBlitImage<S, D>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdClearAttachments> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdClearAttachments
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, S, D> AddCommand<&'a CmdCopyBuffer<S, D>> for UnsafeCommandBufferBuilder<P> where
    S: BufferAccess,
    D: BufferAccess,
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdCopyBuffer<S, D>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, S, D> AddCommand<&'a CmdCopyBufferToImage<S, D>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdCopyBufferToImage<S, D>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, S, D> AddCommand<&'a CmdCopyImage<S, D>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdCopyImage<S, D>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdDispatchRaw> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(self, command: &'a CmdDispatchRaw) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdDrawIndexedRaw> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdDrawIndexedRaw
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, B, P> AddCommand<&'a CmdDrawIndirectRaw<B>> for UnsafeCommandBufferBuilder<P> where
    B: BufferAccess,
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdDrawIndirectRaw<B>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdDrawRaw> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(self, command: &'a CmdDrawRaw) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdEndRenderPass> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdEndRenderPass
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, Cb> AddCommand<&'a CmdExecuteCommands<Cb>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdExecuteCommands<Cb>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, B> AddCommand<&'a CmdFillBuffer<B>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdFillBuffer<B>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdNextSubpass> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(self, command: &'a CmdNextSubpass) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdPipelineBarrier<'a>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdPipelineBarrier<'a>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, Pc, Pl> AddCommand<&'a CmdPushConstants<Pc, Pl>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool,
    Pl: PipelineLayoutAbstract, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdPushConstants<Pc, Pl>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, S, D> AddCommand<&'a CmdResolveImage<S, D>> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdResolveImage<S, D>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdSetEvent> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(self, command: &'a CmdSetEvent) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P> AddCommand<&'a CmdSetState> for UnsafeCommandBufferBuilder<P> where
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(self, command: &'a CmdSetState) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.

impl<'a, P, B, D> AddCommand<&'a CmdUpdateBuffer<B, D>> for UnsafeCommandBufferBuilder<P> where
    B: BufferAccess,
    P: CommandPool, 

type Out = UnsafeCommandBufferBuilder<P>

The new command buffer builder type.

fn add(
    self,
    command: &'a CmdUpdateBuffer<B, D>
) -> Result<Self::Out, CommandAddError>

Adds the command. This takes ownership of the builder and returns a new builder with the command appended at the end of it.