Struct vulkano::command_buffer::cb::SubmitSyncBuilderLayer

pub struct SubmitSyncBuilderLayer<I> { /* fields omitted */ }

Layers that ensures that synchronization with buffers and images between command buffers is properly handled.

The following are handled:

• Return an error when submitting if the user didn't provide the guarantees for proper synchronization.

• Automatically generate pipeline barriers between command buffers if necessary to handle the transition between command buffers. TODO: ^ this is not the case yet

Methods

impl<I> SubmitSyncBuilderLayer<I>

fn new(
    inner: I,
    behavior: SubmitSyncBuilderLayerBehavior
) -> SubmitSyncBuilderLayer<I>

Builds a new layer that wraps around an existing builder.

Trait Implementations

impl<I, O, E> CommandBufferBuild for SubmitSyncBuilderLayer<I> where
    I: CommandBufferBuild<Out = O, Err = E>, 

type Out = SubmitSyncLayer<O>

The type of the built command buffer.

type Err = E

Error that can be returned when building.

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

Builds the command buffer.

impl<I> DeviceOwned for SubmitSyncBuilderLayer<I> where
    I: DeviceOwned, 

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

Returns the device that owns Self.

impl<I> CommandBufferBuilder for SubmitSyncBuilderLayer<I> where
    I: CommandBufferBuilder, 

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<'a, I, O, S, Pl> AddCommand<CmdBindDescriptorSets<S, Pl>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdBindDescriptorSets<S, Pl>, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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, I, O, V> AddCommand<CmdBindVertexBuffers<V>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdBindVertexBuffers<V>, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: CmdBindVertexBuffers<V>
) -> 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, I, O, C> AddCommand<CmdExecuteCommands<C>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdExecuteCommands<C>, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: CmdExecuteCommands<C>
) -> 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<I, O, Rp, F> AddCommand<CmdBeginRenderPass<Rp, F>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdBeginRenderPass<Rp, F>, Out = O>,
    F: FramebufferAbstract + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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<I, O, B> AddCommand<CmdBindIndexBuffer<B>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdBindIndexBuffer<B>, Out = O>,
    B: BufferAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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<I, O, P> AddCommand<CmdBindPipeline<P>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdBindPipeline<P>, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: CmdBindPipeline<P>) -> 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<I, O, S, D> AddCommand<CmdBlitImage<S, D>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdBlitImage<S, D>, Out = O>,
    S: ImageAccess + Send + Sync + Clone + 'static,
    D: ImageAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O> AddCommand<CmdClearAttachments> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdClearAttachments, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O, S, D> AddCommand<CmdCopyBuffer<S, D>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdCopyBuffer<S, D>, Out = O>,
    S: BufferAccess + Send + Sync + Clone + 'static,
    D: BufferAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O, S, D> AddCommand<CmdCopyBufferToImage<S, D>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdCopyBufferToImage<S, D>, Out = O>,
    S: BufferAccess + Send + Sync + Clone + 'static,
    D: ImageAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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<I, O, S, D> AddCommand<CmdCopyImage<S, D>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdCopyImage<S, D>, Out = O>,
    S: ImageAccess + Send + Sync + Clone + 'static,
    D: ImageAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O> AddCommand<CmdDispatchRaw> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdDispatchRaw, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O> AddCommand<CmdDrawRaw> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdDrawRaw, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O> AddCommand<CmdDrawIndexedRaw> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdDrawIndexedRaw, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O, B> AddCommand<CmdDrawIndirectRaw<B>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdDrawIndirectRaw<B>, Out = O>,
    B: BufferAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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<I, O> AddCommand<CmdEndRenderPass> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdEndRenderPass, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O, B> AddCommand<CmdFillBuffer<B>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdFillBuffer<B>, Out = O>,
    B: BufferAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O> AddCommand<CmdNextSubpass> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdNextSubpass, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O, Pc, Pl> AddCommand<CmdPushConstants<Pc, Pl>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdPushConstants<Pc, Pl>, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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<I, O, S, D> AddCommand<CmdResolveImage<S, D>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdResolveImage<S, D>, Out = O>,
    S: ImageAccess + Send + Sync + Clone + 'static,
    D: ImageAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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<I, O> AddCommand<CmdSetEvent> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdSetEvent, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O> AddCommand<CmdSetState> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdSetState, Out = O>, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(self, command: 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<I, O, B, D> AddCommand<CmdUpdateBuffer<B, D>> for SubmitSyncBuilderLayer<I> where
    I: AddCommand<CmdUpdateBuffer<B, D>, Out = O>,
    B: BufferAccess + Send + Sync + Clone + 'static, 

type Out = SubmitSyncBuilderLayer<O>

The new command buffer builder type.

fn add(
    self,
    command: 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.