[−][src]Struct vulkano::command_buffer::synced::SyncCommandBufferBuilder

pub struct SyncCommandBufferBuilder<P> { /* fields omitted */ }

Wrapper around UnsafeCommandBufferBuilder that handles synchronization for you.

Each method of the UnsafeCommandBufferBuilder has an equivalent in this wrapper, except for pipeline_layout which is automatically handled. This wrapper automatically builds pipeline barriers, keeps used resources alive and implements the CommandBuffer trait.

Since the implementation needs to cache commands in a Vec, most methods have additional Send + Sync + 'static trait requirements on their generics.

If this builder finds out that a command isn't valid because of synchronization reasons (eg. trying to copy from a buffer to an image which share the same memory), then an error is returned. Note that all methods are still unsafe, because this builder doesn't check the validity of the commands except for synchronization purposes. The builder may panic if you pass invalid commands.

The P generic is the same as UnsafeCommandBufferBuilder.

Methods

`impl SyncCommandBufferBuilder`[src]

`pub unsafe fn new<Pool, R, F, A>( pool: &Pool, kind: Kind<R, F>, flags: Flags ) -> Result<SyncCommandBufferBuilder, OomError> where Pool: CommandPool<Builder = P, Alloc = A>, P: CommandPoolBuilderAlloc<Alloc = A>, A: CommandPoolAlloc, R: RenderPassAbstract, F: FramebufferAbstract,` [src]

Builds a new SyncCommandBufferBuilder. The parameters are the same as the UnsafeCommandBufferBuilder::new function.

Safety

See UnsafeCommandBufferBuilder::new() and SyncCommandBufferBuilder.

`pub unsafe fn from_unsafe_cmd( cmd: UnsafeCommandBufferBuilder, is_secondary: bool, inside_render_pass: bool ) -> SyncCommandBufferBuilder`[src]

Builds a SyncCommandBufferBuilder from an existing UnsafeCommandBufferBuilder.

Safety

See UnsafeCommandBufferBuilder::new() and SyncCommandBufferBuilder.

In addition to this, the UnsafeCommandBufferBuilder should be empty. If it isn't, then you must take into account the fact that the SyncCommandBufferBuilder won't be aware of any existing resource usage.

`pub fn build(self) -> Result<SyncCommandBuffer<P::Alloc>, OomError> where P: CommandPoolBuilderAlloc,` [src]

Builds the command buffer and turns it into a SyncCommandBuffer.

`impl SyncCommandBufferBuilder`[src]

`pub unsafe fn begin_render_pass<F, I>( &mut self, framebuffer: F, subpass_contents: SubpassContents, clear_values: I ) -> Result<(), SyncCommandBufferBuilderError> where F: FramebufferAbstract + Send + Sync + 'static, I: Iterator<Item = ClearValue> + Send + Sync + 'static,` [src]

Calls vkBeginRenderPass on the builder.

`pub unsafe fn bind_index_buffer( &mut self, buffer: B, index_ty: IndexType ) -> Result<(), SyncCommandBufferBuilderError> where B: BufferAccess + Send + Sync + 'static,` [src]

Calls vkCmdBindIndexBuffer on the builder.

`pub unsafe fn bind_pipeline_graphics<Gp>(&mut self, pipeline: Gp) where Gp: GraphicsPipelineAbstract + Send + Sync + 'static,` [src]

Calls vkCmdBindPipeline on the builder with a graphics pipeline.

`pub unsafe fn bind_pipeline_compute<Cp>(&mut self, pipeline: Cp) where Cp: ComputePipelineAbstract + Send + Sync + 'static,` [src]

Calls vkCmdBindPipeline on the builder with a compute pipeline.

`pub fn bind_descriptor_sets( &mut self ) -> SyncCommandBufferBuilderBindDescriptorSets`[src]

Starts the process of binding descriptor sets. Returns an intermediate struct which can be used to add the sets.

`pub fn bind_vertex_buffers( &mut self ) -> SyncCommandBufferBuilderBindVertexBuffer`[src]

Starts the process of binding vertex buffers. Returns an intermediate struct which can be used to add the buffers.