Struct CVBuffer 

pub struct CVBuffer { /* private fields */ }

Available on crate feature CVBuffer only.

Base type for all CoreVideo buffers

See also Apple’s documentation

Implementations

impl CVBuffer

pub unsafe fn set_attachment( &self, key: &CFString, value: &CFType, attachment_mode: CVAttachmentMode, )

Sets or adds a attachment of a CVBuffer object

You can attach any CF object to a CVBuffer object to store additional information. CVBufferGetAttachment stores an attachement identified by a key. If the key doesn’t exist, the attachment will be added. If the key does exist, the existing attachment will be replaced. In bouth cases the retain count of the attachment will be incremented. The value can be any CFType but nil has no defined behavior.

Parameter buffer: Target CVBuffer object.

Parameter key: Key in form of a CFString identifying the desired attachment.

Parameter value: Attachment in form af a CF object.

Parameter attachmentMode: Specifies which attachment mode is desired for this attachment. A particular attachment key may only exist in a single mode at a time.

Safety

value should be of the correct type.

pub unsafe fn get_attachment( &self, key: &CFString, attachment_mode: *mut CVAttachmentMode, ) -> Option<CFRetained<CFType>>

👎Deprecated

Returns a specific attachment of a CVBuffer object

You can attach any CF object to a CVBuffer object to store additional information. CVBufferGetAttachment retrieves an attachement identified by a key.

Parameter buffer: Target CVBuffer object.

Parameter key: Key in form of a CFString identifying the desired attachment.

Parameter attachmentMode: Returns the mode of the attachment, if desired. May be NULL.

Returns: If found the attachment object

Safety

attachment_mode must be a valid pointer or null.

pub fn remove_attachment(&self, key: &CFString)

Removes a specific attachment of a CVBuffer object

CVBufferRemoveAttachment removes an attachement identified by a key. If found the attachement is removed and the retain count decremented.

Parameter buffer: Target CVBuffer object.

Parameter key: Key in form of a CFString identifying the desired attachment.

pub fn remove_all_attachments(&self)

Removes all attachments of a CVBuffer object

While CVBufferRemoveAttachment removes a specific attachement identified by a key CVBufferRemoveAllAttachments removes all attachments of a buffer and decrements their retain counts.

Parameter buffer: Target CVBuffer object.

pub fn get_attachments( &self, attachment_mode: CVAttachmentMode, ) -> Option<CFRetained<CFDictionary>>

👎Deprecated

Returns all attachments of a CVBuffer object

CVBufferGetAttachments is a convenience call that returns all attachments with their corresponding keys in a CFDictionary.

Parameter buffer: Target CVBuffer object.

Returns: A CFDictionary with all buffer attachments identified by there keys. If no attachment is present, the dictionary is empty. Returns NULL for invalid attachment mode.

pub unsafe fn set_attachments( &self, the_attachments: &CFDictionary, attachment_mode: CVAttachmentMode, )

Sets a set of attachments for a CVBuffer

CVBufferSetAttachments is a convenience call that in turn calls CVBufferSetAttachment for each key and value in the given dictionary. All key value pairs must be in the root level of the dictionary.

Parameter buffer: Target CVBuffer object.

Safety

the_attachments generics must be of the correct type.

pub fn propagate_attachments(&self, destination_buffer: &CVBuffer)

Copy all propagatable attachments from one buffer to another.

CVBufferPropagateAttachments is a convenience call that copies all attachments with a mode of kCVAttachmentMode_ShouldPropagate from one buffer to another.

Parameter sourceBuffer: CVBuffer to copy attachments from.

Parameter destinationBuffer: CVBuffer to copy attachments to.

pub fn attachments( &self, attachment_mode: CVAttachmentMode, ) -> Option<CFRetained<CFDictionary>>

Returns a copy of all attachments of a CVBuffer object. It is the caller’s responsibility to release the returned dictionary.

CVBufferCopyAttachments is a convenience call that returns a copy of all attachments with their corresponding keys in a CFDictionary.

Parameter buffer: Target CVBuffer object.

Returns: A CFDictionary with all buffer attachments identified by their keys. If no attachment is present or invalid attachment mode, returns NULL

pub unsafe fn attachment( &self, key: &CFString, attachment_mode: *mut CVAttachmentMode, ) -> Option<CFRetained<CFType>>

Returns a retained specific attachment of a CVBuffer object. It is the caller’s responsibility to release the returned value.

You can attach any CF object to a CVBuffer object to store additional information. CVBufferCopyAttachment retrieves a retained attachment identified by a key.

Parameter buffer: Target CVBuffer object.

Parameter key: Key in form of a CFString identifying the desired attachment.

Parameter attachmentMode: Returns the mode of the attachment, if desired. May be NULL.

Returns: If found the attachment object, return the value; otherwize, return NULL.

Safety

attachment_mode must be a valid pointer or null.

pub fn has_attachment(&self, key: &CFString) -> bool

Returns true if an attachment with the passed key is present on a CVBuffer object.

Parameter buffer: Target CVBuffer object.

Parameter key: Key in form of a CFString identifying the desired attachment.

Returns: True if an attachment with this key is present, otherwise false.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for CVBuffer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CVBuffer

fn as_ref(&self) -> &CFType

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

impl AsRef<CVBuffer> for CVBuffer

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CVBuffer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CVBuffer

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl Debug for CVBuffer

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

Formats the value using the given formatter.

impl Deref for CVBuffer

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CVBuffer

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 Message for CVBuffer

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CVBuffer

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 RefEncode for CVBuffer

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for CVBuffer

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for CVBuffer