Struct CommandBuffer 

pub struct CommandBuffer { /* private fields */ }

Implementations

impl CommandBuffer

pub fn new( pool: Vrc<CommandPool>, primary: bool, ) -> Result<Vrc<Self>, CommandBufferError>

pub fn new_multiple( pool: Vrc<CommandPool>, primary: bool, count: NonZeroU32, ) -> Result<Vec<Vrc<Self>>, CommandBufferError>

pub unsafe fn from_existing( pool: Vrc<CommandPool>, command_buffer: CommandBuffer, ) -> Self

Creates a new CommandBuffer from existing handle.

Safety

command_buffer must be valid handle allocated from pool.

pub fn reset(&self, release_resource: bool) -> Result<(), CommandBufferError>

Panic

This function will panic if the vutex cannot be locked.

pub fn begin_recording( &self, info: CommandBufferBeginInfo, ) -> Result<CommandBufferRecordingLockOutsideRenderPass<'_>, CommandBufferError>

Equivalent to calling CommandBufferRecordingLock::new(self)

Panic

This function will panic if the pool or the buffer vutex cannot be locked.

pub const fn pool(&self) -> &Vrc<CommandPool>

Methods from Deref<Target = Vutex<CommandBuffer>>

pub fn lock(&self) -> Result<VutexGuard<'_, T>, BorrowMutError>

Trait Implementations

impl Borrow<Vutex<CommandBuffer>> for CommandBuffer

fn borrow(&self) -> &Vutex<CommandBuffer>

Immutably borrows from an owned value.

impl Debug for CommandBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for CommandBuffer

type Target = Vutex<CommandBuffer>

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for CommandBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl HasSynchronizedHandle<CommandBuffer> for CommandBuffer

fn lock_handle(&self) -> VutexGuard<'_, T>

fn lock_safe_handle(&self) -> VutexGuardSafeHandleBorrow<'_, T>

impl Hash for CommandBuffer

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CommandBuffer

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CommandBuffer

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CommandBuffer

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CommandBuffer