Struct CVPixelBufferPool 

pub struct CVPixelBufferPool { /* private fields */ }

Available on crate feature CVPixelBufferPool only.

Apple’s documentation

Implementations

impl CVPixelBufferPool

pub unsafe fn create( allocator: Option<&CFAllocator>, pool_attributes: Option<&CFDictionary>, pixel_buffer_attributes: Option<&CFDictionary>, pool_out: NonNull<*mut CVPixelBufferPool>, ) -> CVReturn

Available on crate feature CVReturn only.

Creates a new Pixel Buffer pool.

Parameter allocator: The CFAllocatorRef to use for allocating this buffer pool. May be NULL.

Parameter attributes: A CFDictionaryRef containing the attributes to be used for creating new PixelBuffers within the pool.

Parameter poolOut: The newly created pool will be placed here

Returns: Returns kCVReturnSuccess on success

Safety

• pool_attributes generics must be of the correct type.
• pixel_buffer_attributes generics must be of the correct type.
• pool_out must be a valid pointer.

pub fn attributes(&self) -> Option<CFRetained<CFDictionary>>

Returns the pool attributes dictionary for a CVPixelBufferPool

Parameter pool: The CVPixelBufferPoolRef to retrieve the attributes from

Returns: Returns the pool attributes dictionary, or NULL on failure.

pub fn pixel_buffer_attributes(&self) -> Option<CFRetained<CFDictionary>>

Returns the attributes of pixel buffers that will be created from this pool.

This function is provided for those cases where you may need to know some information about the buffers that will be created up front.

Parameter pool: The CVPixelBufferPoolRef to retrieve the attributes from

Returns: Returns the pixel buffer attributes dictionary, or NULL on failure.

pub unsafe fn create_pixel_buffer( allocator: Option<&CFAllocator>, pixel_buffer_pool: &CVPixelBufferPool, pixel_buffer_out: NonNull<*mut CVPixelBuffer>, ) -> CVReturn

Available on crate features CVBuffer and CVImageBuffer and CVPixelBuffer and CVReturn only.

Creates a new PixelBuffer object from the pool.

The function creates a new (attachment-free) CVPixelBuffer using the pixel buffer attributes specifed during pool creation.

Parameter allocator: The CFAllocatorRef to use for creating the pixel buffer. May be NULL.

Parameter pool: The CVPixelBufferPool that should create the new CVPixelBuffer.

Parameter pixelBufferOut: The newly created pixel buffer will be placed here

Returns: Returns kCVReturnSuccess on success

Safety

pixel_buffer_out must be a valid pointer.

pub unsafe fn create_pixel_buffer_with_aux_attributes( allocator: Option<&CFAllocator>, pixel_buffer_pool: &CVPixelBufferPool, aux_attributes: Option<&CFDictionary>, pixel_buffer_out: NonNull<*mut CVPixelBuffer>, ) -> CVReturn

Available on crate features CVBuffer and CVImageBuffer and CVPixelBuffer and CVReturn only.

Safety

• aux_attributes generics must be of the correct type.
• pixel_buffer_out must be a valid pointer.

impl CVPixelBufferPool

pub fn flush(&self, options: CVPixelBufferPoolFlushFlags)

Available on crate feature CVBase only.

Frees as many buffers from the pool as possible.

By default, this function will free all aged out buffers. Setting the kCVPixelBufferPoolFlushExcessBuffers flag will cause this call to free all unused buffers regardless of age.

Parameter pool: The CVPixelBufferPool to be flushed.

Parameter options: Set to kCVPixelBufferPoolFlushExcessBuffers to free all unused buffers regardless of their age.

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 CVPixelBufferPool

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CVPixelBufferPool

fn as_ref(&self) -> &CFType

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

impl AsRef<CVPixelBufferPool> for CVPixelBufferPool

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CVPixelBufferPool

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CVPixelBufferPool

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CVPixelBufferPool

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for CVPixelBufferPool

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

Formats the value using the given formatter.

impl Deref for CVPixelBufferPool

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CVPixelBufferPool

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 CVPixelBufferPool

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CVPixelBufferPool

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 CVPixelBufferPool

const ENCODING_REF: Encoding

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

impl Type for CVPixelBufferPool

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 CVPixelBufferPool