Struct vulkano::command_buffer::sys::UnsafeCommandBufferBuilder
[−]
[src]
pub struct UnsafeCommandBufferBuilder<P> { /* 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>
[src]
unsafe fn new<Pool, R, F, A>(
pool: &Pool,
kind: Kind<R, F>,
flags: Flags
) -> Result<UnsafeCommandBufferBuilder<P>, OomError> where
Pool: CommandPool<Builder = P, Alloc = A>,
P: CommandPoolBuilderAlloc<Alloc = A>,
A: CommandPoolAlloc,
R: RenderPassAbstract,
F: FramebufferAbstract,
pool: &Pool,
kind: Kind<R, F>,
flags: Flags
) -> Result<UnsafeCommandBufferBuilder<P>, OomError> where
Pool: CommandPool<Builder = P, Alloc = A>,
P: CommandPoolBuilderAlloc<Alloc = A>,
A: CommandPoolAlloc,
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,
kind: Kind<R, F>,
flags: Flags
) -> Result<UnsafeCommandBufferBuilder<P>, OomError> where
R: RenderPassAbstract,
F: FramebufferAbstract,
P: CommandPoolBuilderAlloc,
alloc: P,
kind: Kind<R, F>,
flags: Flags
) -> Result<UnsafeCommandBufferBuilder<P>, OomError> where
R: RenderPassAbstract,
F: FramebufferAbstract,
P: CommandPoolBuilderAlloc,
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.
fn queue_family(&self) -> QueueFamily where
P: CommandPoolBuilderAlloc,
P: CommandPoolBuilderAlloc,
Returns the queue family of the builder.
fn build(self) -> Result<UnsafeCommandBuffer<P::Alloc>, OomError> where
P: CommandPoolBuilderAlloc,
P: CommandPoolBuilderAlloc,
Turns the builder into an actual command buffer.
unsafe fn begin_render_pass<F: ?Sized, I>(
&mut self,
framebuffer: &F,
subpass_contents: SubpassContents,
clear_values: I
) where
F: FramebufferAbstract,
I: Iterator<Item = ClearValue>,
&mut self,
framebuffer: &F,
subpass_contents: SubpassContents,
clear_values: I
) where
F: FramebufferAbstract,
I: Iterator<Item = ClearValue>,
Calls vkCmdBeginRenderPass
on the builder.
unsafe fn bind_descriptor_sets<'s, Pl: ?Sized, S, I>(
&mut self,
graphics: bool,
pipeline_layout: &Pl,
first_binding: u32,
sets: S,
dynamic_offsets: I
) where
Pl: PipelineLayoutAbstract,
S: Iterator<Item = &'s UnsafeDescriptorSet>,
I: Iterator<Item = u32>,
&mut self,
graphics: bool,
pipeline_layout: &Pl,
first_binding: u32,
sets: S,
dynamic_offsets: I
) where
Pl: PipelineLayoutAbstract,
S: Iterator<Item = &'s UnsafeDescriptorSet>,
I: Iterator<Item = u32>,
Calls vkCmdBindDescriptorSets
on the builder.
Does nothing if the list of descriptor sets is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn bind_index_buffer<B: ?Sized>(
&mut self,
buffer: &B,
index_ty: IndexType
) where
B: BufferAccess,
&mut self,
buffer: &B,
index_ty: IndexType
) where
B: BufferAccess,
Calls vkCmdBindIndexBuffer
on the builder.
unsafe fn bind_pipeline_compute<Cp: ?Sized>(&mut self, pipeline: &Cp) where
Cp: ComputePipelineAbstract,
Cp: ComputePipelineAbstract,
Calls vkCmdBindPipeline
on the builder with a compute pipeline.
unsafe fn bind_pipeline_graphics<Gp: ?Sized>(&mut self, pipeline: &Gp) where
Gp: GraphicsPipelineAbstract,
Gp: GraphicsPipelineAbstract,
Calls vkCmdBindPipeline
on the builder with a graphics pipeline.
unsafe fn bind_vertex_buffers(
&mut self,
first_binding: u32,
params: UnsafeCommandBufferBuilderBindVertexBuffer
)
&mut self,
first_binding: u32,
params: UnsafeCommandBufferBuilderBindVertexBuffer
)
Calls vkCmdBindVertexBuffers
on the builder.
Does nothing if the list of buffers is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn blit_image<S: ?Sized, D: ?Sized, R>(
&mut self,
source: &S,
source_layout: ImageLayout,
destination: &D,
destination_layout: ImageLayout,
regions: R,
filter: Filter
) where
S: ImageAccess,
D: ImageAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderImageBlit>,
&mut self,
source: &S,
source_layout: ImageLayout,
destination: &D,
destination_layout: ImageLayout,
regions: R,
filter: Filter
) where
S: ImageAccess,
D: ImageAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderImageBlit>,
Calls vkCmdBlitImage
on the builder.
Does nothing if the list of regions is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn clear_color_image<I: ?Sized, R>(
&mut self,
image: &I,
layout: ImageLayout,
color: ClearValue,
regions: R
) where
I: ImageAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderColorImageClear>,
&mut self,
image: &I,
layout: ImageLayout,
color: ClearValue,
regions: R
) where
I: ImageAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderColorImageClear>,
Calls vkCmdClearColorImage
on the builder.
Does nothing if the list of regions is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn copy_buffer<S: ?Sized, D: ?Sized, R>(
&mut self,
source: &S,
destination: &D,
regions: R
) where
S: BufferAccess,
D: BufferAccess,
R: Iterator<Item = (usize, usize, usize)>,
&mut self,
source: &S,
destination: &D,
regions: R
) where
S: BufferAccess,
D: BufferAccess,
R: Iterator<Item = (usize, usize, usize)>,
Calls vkCmdCopyBuffer
on the builder.
Does nothing if the list of regions is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn copy_buffer_to_image<S: ?Sized, D: ?Sized, R>(
&mut self,
source: &S,
destination: &D,
destination_layout: ImageLayout,
regions: R
) where
S: BufferAccess,
D: ImageAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderBufferImageCopy>,
&mut self,
source: &S,
destination: &D,
destination_layout: ImageLayout,
regions: R
) where
S: BufferAccess,
D: ImageAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderBufferImageCopy>,
Calls vkCmdCopyBufferToImage
on the builder.
Does nothing if the list of regions is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn copy_image_to_buffer<S: ?Sized, D: ?Sized, R>(
&mut self,
source: &S,
source_layout: ImageLayout,
destination: &D,
regions: R
) where
S: ImageAccess,
D: BufferAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderBufferImageCopy>,
&mut self,
source: &S,
source_layout: ImageLayout,
destination: &D,
regions: R
) where
S: ImageAccess,
D: BufferAccess,
R: Iterator<Item = UnsafeCommandBufferBuilderBufferImageCopy>,
Calls vkCmdCopyImageToBuffer
on the builder.
Does nothing if the list of regions is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn dispatch(&mut self, dimensions: [u32; 3])
Calls vkCmdDispatch
on the builder.
unsafe fn dispatch_indirect<B: ?Sized>(&mut self, buffer: &B) where
B: BufferAccess,
B: BufferAccess,
Calls vkCmdDispatchIndirect
on the builder.
unsafe fn draw(
&mut self,
vertex_count: u32,
instance_count: u32,
first_vertex: u32,
first_instance: u32
)
&mut self,
vertex_count: u32,
instance_count: u32,
first_vertex: u32,
first_instance: u32
)
Calls vkCmdDraw
on the builder.
unsafe fn draw_indexed(
&mut self,
index_count: u32,
instance_count: u32,
first_index: u32,
vertex_offset: i32,
first_instance: u32
)
&mut self,
index_count: u32,
instance_count: u32,
first_index: u32,
vertex_offset: i32,
first_instance: u32
)
Calls vkCmdDrawIndexed
on the builder.
unsafe fn draw_indirect<B: ?Sized>(
&mut self,
buffer: &B,
draw_count: u32,
stride: u32
) where
B: BufferAccess,
&mut self,
buffer: &B,
draw_count: u32,
stride: u32
) where
B: BufferAccess,
Calls vkCmdDrawIndirect
on the builder.
unsafe fn draw_indexed_indirect<B: ?Sized>(
&mut self,
buffer: &B,
draw_count: u32,
stride: u32
) where
B: BufferAccess,
&mut self,
buffer: &B,
draw_count: u32,
stride: u32
) where
B: BufferAccess,
Calls vkCmdDrawIndexedIndirect
on the builder.
unsafe fn end_render_pass(&mut self)
Calls vkCmdEndRenderPass
on the builder.
unsafe fn execute_commands(
&mut self,
cbs: UnsafeCommandBufferBuilderExecuteCommands
)
&mut self,
cbs: UnsafeCommandBufferBuilderExecuteCommands
)
Calls vkCmdExecuteCommands
on the builder.
Does nothing if the list of command buffers is empty, as it would be a no-op and isn't a valid usage of the command anyway.
unsafe fn fill_buffer<B: ?Sized>(&mut self, buffer: &B, data: u32) where
B: BufferAccess,
B: BufferAccess,
Calls vkCmdFillBuffer
on the builder.
unsafe fn next_subpass(&mut self, subpass_contents: SubpassContents)
Calls vkCmdNextSubpass
on the builder.
unsafe fn pipeline_barrier(
&mut self,
command: &UnsafeCommandBufferBuilderPipelineBarrier
)
&mut self,
command: &UnsafeCommandBufferBuilderPipelineBarrier
)
unsafe fn push_constants<Pl: ?Sized, D: ?Sized>(
&mut self,
pipeline_layout: &Pl,
stages: ShaderStages,
offset: u32,
size: u32,
data: &D
) where
Pl: PipelineLayoutAbstract,
D: ,
&mut self,
pipeline_layout: &Pl,
stages: ShaderStages,
offset: u32,
size: u32,
data: &D
) where
Pl: PipelineLayoutAbstract,
D: ,
Calls vkCmdPushConstants
on the builder.
unsafe fn reset_event(&mut self, event: &Event, stages: PipelineStages)
Calls vkCmdResetEvent
on the builder.
unsafe fn set_blend_constants(&mut self, constants: [f32; 4])
Calls vkCmdSetBlendConstants
on the builder.
unsafe fn set_depth_bias(
&mut self,
constant_factor: f32,
clamp: f32,
slope_factor: f32
)
&mut self,
constant_factor: f32,
clamp: f32,
slope_factor: f32
)
Calls vkCmdSetDepthBias
on the builder.
unsafe fn set_depth_bounds(&mut self, min: f32, max: f32)
Calls vkCmdSetDepthBounds
on the builder.
unsafe fn set_event(&mut self, event: &Event, stages: PipelineStages)
Calls vkCmdSetEvent
on the builder.
unsafe fn set_line_width(&mut self, line_width: f32)
Calls vkCmdSetLineWidth
on the builder.
unsafe fn set_scissor<I>(&mut self, first_scissor: u32, scissors: I) where
I: Iterator<Item = Scissor>,
I: Iterator<Item = Scissor>,
Calls vkCmdSetScissor
on the builder.
If the list is empty then the command is automatically ignored.
unsafe fn set_viewport<I>(&mut self, first_viewport: u32, viewports: I) where
I: Iterator<Item = Viewport>,
I: Iterator<Item = Viewport>,
Calls vkCmdSetViewport
on the builder.
If the list is empty then the command is automatically ignored.
unsafe fn update_buffer<B: ?Sized, D: ?Sized>(&mut self, buffer: &B, data: &D) where
B: BufferAccess,
D: ,
B: BufferAccess,
D: ,
Calls vkCmdUpdateBuffer
on the builder.
Trait Implementations
impl<P> Debug for UnsafeCommandBufferBuilder<P>
[src]
impl<P> DeviceOwned for UnsafeCommandBufferBuilder<P>
[src]
impl<P> VulkanObject for UnsafeCommandBufferBuilder<P>
[src]
type Object = CommandBuffer
The type of the object.
fn internal_object(&self) -> CommandBuffer
Returns a reference to the object.