Skip to main content

CommandBuffer

Struct CommandBuffer 

Source
pub struct CommandBuffer { /* private fields */ }
Expand description

Used to send instructions to the GPU.

Implementations§

Source§

impl CommandBuffer

Source

pub fn record<F: FnOnce()>( &self, flags: CommandBufferUsageFlags, f: F, ) -> Result<(), Error>

Records instructions in the given closure to this command buffer.

Runs begin(), the closure then end().

§Examples
cmd_buffer.record(plate::CommandBufferUsageFlags::empty(), || {
    // cmd_buffer.draw(..);
})?;
Source

pub fn begin(&self, flags: CommandBufferUsageFlags) -> Result<(), Error>

Begin recording instructions to this command buffer.

§Examples
cmd_buffer.begin(plate::CommandBufferUsageFlags::empty())?;
// cmd_buffer.draw(..);
Source

pub fn end(&self) -> Result<(), Error>

Stop recording instructions to this command buffer.

§Examples
// cmd_buffer.draw(..);
cmd_buffer.end()?;
Source

pub fn draw( &self, vert_count: u32, instance_count: u32, first_vert: u32, first_instance: u32, )

Calls a draw command.

To be used when recording a CommandBuffer.

§Examples
cmd_buffer.record(plate::CommandBufferUsageFlags::empty(), || {
    cmd_buffer.draw(3, 1, 0, 0);
})?;
Source

pub fn draw_indexed( &self, index_count: u32, instance_count: u32, first_index: u32, vertex_offset: i32, first_instance: u32, )

Calls a draw_indexed command.

To be used when recording a CommandBuffer.

§Examples
cmd_buffer.record(plate::CommandBufferUsageFlags::empty(), || {
    cmd_buffer.draw_indexed(3, 1, 0, 0, 0);
})?;

Trait Implementations§

Source§

impl Deref for CommandBuffer

Source§

type Target = CommandBuffer

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.