Struct CommandBufferRef 

pub struct CommandBufferRef(/* private fields */);

A borrowed reference to a CommandBuffer.

Implementations

impl CommandBufferRef

pub fn label(&self) -> &str

pub fn set_label(&self, label: &str)

pub fn enqueue(&self)

pub fn commit(&self)

pub fn status(&self) -> MTLCommandBufferStatus

pub fn present_drawable(&self, drawable: &DrawableRef)

pub fn wait_until_completed(&self)

pub fn wait_until_scheduled(&self)

pub fn add_completed_handler(&self, block: &Block<(&'_ CommandBufferRef,), ()>)

pub fn add_scheduled_handler(&self, block: &Block<(&'_ CommandBufferRef,), ()>)

pub fn new_blit_command_encoder(&self) -> &BlitCommandEncoderRef

Create a blit command encoder.

Although this method is named with a new_ prefix, the actual Metal method is not, and it returns an object that has been added to the autorelease pool. See https://github.com/gfx-rs/metal-rs/issues/128.

pub fn blit_command_encoder_with_descriptor( &self, descriptor: &BlitPassDescriptorRef, ) -> &BlitCommandEncoderRef

pub fn new_compute_command_encoder(&self) -> &ComputeCommandEncoderRef

Create a compute command encoder.

Although this method is named with a new_ prefix, the actual Metal method is not, and it returns an object that has been added to the autorelease pool. See https://github.com/gfx-rs/metal-rs/issues/128.

pub fn compute_command_encoder_with_dispatch_type( &self, ty: MTLDispatchType, ) -> &ComputeCommandEncoderRef

pub fn compute_command_encoder_with_descriptor( &self, descriptor: &ComputePassDescriptorRef, ) -> &ComputeCommandEncoderRef

pub fn new_render_command_encoder( &self, descriptor: &RenderPassDescriptorRef, ) -> &RenderCommandEncoderRef

Create a render command encoder.

Although this method is named with a new_ prefix, the actual Metal method is not, and it returns an object that has been added to the autorelease pool. See https://github.com/gfx-rs/metal-rs/issues/128.

pub fn new_parallel_render_command_encoder( &self, descriptor: &RenderPassDescriptorRef, ) -> &ParallelRenderCommandEncoderRef

Create a parallel render command encoder.

Although this method is named with a new_ prefix, the actual Metal method is not, and it returns an object that has been added to the autorelease pool. See https://github.com/gfx-rs/metal-rs/issues/128.

pub fn new_acceleration_structure_command_encoder( &self, ) -> &AccelerationStructureCommandEncoderRef

Create an acceleration structure command encoder.

Although this method is named with a new_ prefix, the actual Metal method is not, and it returns an object that has been added to the autorelease pool. See https://github.com/gfx-rs/metal-rs/issues/128.

pub fn acceleration_structure_command_encoder_with_descriptor( &self, descriptor: &AccelerationStructurePassDescriptorRef, ) -> &AccelerationStructureCommandEncoderRef

Create an acceleration structure command encoder.

Although this method is named with a new_ prefix, the actual Metal method is not, and it returns an object that has been added to the autorelease pool. See https://github.com/gfx-rs/metal-rs/issues/128.

pub fn encode_signal_event(&self, event: &EventRef, new_value: u64)

pub fn encode_wait_for_event(&self, event: &EventRef, value: u64)

pub fn push_debug_group(&self, name: &str)

pub fn pop_debug_group(&self)

Trait Implementations

impl AsMut<CommandBufferRef> for CommandBuffer

fn as_mut(&mut self) -> &mut CommandBufferRef

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<CommandBufferRef> for CommandBuffer

fn as_ref(&self) -> &CommandBufferRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<CommandBufferRef> for CommandBuffer

fn borrow(&self) -> &CommandBufferRef

Immutably borrows from an owned value.

impl BorrowMut<CommandBufferRef> for CommandBuffer

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

Mutably borrows from an owned value.

impl Debug for CommandBufferRef

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

Formats the value using the given formatter.

impl ForeignTypeRef for CommandBufferRef

type CType = MTLCommandBuffer

The raw C type.

unsafe fn from_ptr<'a>(ptr: *mut Self::CType) -> &'a Self

Constructs a shared instance of this type from its raw type.

unsafe fn from_ptr_mut<'a>(ptr: *mut Self::CType) -> &'a mut Self

Constructs a mutable reference of this type from its raw type.

fn as_ptr(&self) -> *mut Self::CType

Returns a raw pointer to the wrapped value.

impl Message for CommandBufferRef

unsafe fn send_message<A, R>( &self, sel: Sel, args: A, ) -> Result<R, MessageError>

where Self: Sized, A: MessageArguments, R: Any,

Sends a message to self with the given selector and arguments.

fn verify_message<A, R>(&self, sel: Sel) -> Result<(), MessageError>

where Self: Sized, A: EncodeArguments, R: Encode,

Verifies that the argument and return types match the encoding of the method for the given selector.

impl Send for CommandBufferRef

impl Sync for CommandBufferRef

impl ToOwned for CommandBufferRef

type Owned = CommandBuffer

The resulting type after obtaining ownership.

fn to_owned(&self) -> CommandBuffer

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.