Skip to main content

CommandBufferDescriptor

Struct CommandBufferDescriptor 

Source
pub struct CommandBufferDescriptor(/* private fields */);
Expand description

A descriptor for configuring command buffer creation.

C++ equivalent: MTL::CommandBufferDescriptor

Implementations§

Source§

impl CommandBufferDescriptor

Source

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a new CommandBufferDescriptor from a raw pointer.

§Safety

The pointer must be a valid Metal command buffer descriptor object.

Source

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer to the descriptor.

Source

pub fn new() -> Option<Self>

Create a new command buffer descriptor.

C++ equivalent: CommandBufferDescriptor::alloc()->init()

Source

pub fn error_options(&self) -> CommandBufferErrorOption

Get the error options for the command buffer.

C++ equivalent: CommandBufferErrorOption errorOptions() const

Source

pub fn set_error_options(&self, error_options: CommandBufferErrorOption)

Set the error options for the command buffer.

C++ equivalent: void setErrorOptions(CommandBufferErrorOption errorOptions)

Source

pub fn retained_references(&self) -> bool

Check if the command buffer retains references to resources.

C++ equivalent: bool retainedReferences() const

Source

pub fn set_retained_references(&self, retained_references: bool)

Set whether the command buffer retains references to resources.

C++ equivalent: void setRetainedReferences(bool retainedReferences)

Source

pub fn log_state(&self) -> *mut c_void

Get the log state for the command buffer.

C++ equivalent: LogState* logState() const

Returns a raw pointer to the log state object.

Source

pub unsafe fn set_log_state(&self, log_state: *const c_void)

Set the log state for the command buffer.

C++ equivalent: void setLogState(const LogState* logState)

§Safety

The log_state pointer must be valid or null.

Trait Implementations§

Source§

impl Clone for CommandBufferDescriptor

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandBufferDescriptor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandBufferDescriptor

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for CommandBufferDescriptor

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for CommandBufferDescriptor

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.
Source§

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for CommandBufferDescriptor

Source§

impl Sync for CommandBufferDescriptor

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.