Skip to main content

CVPixelBufferPool

Struct CVPixelBufferPool 

pub struct CVPixelBufferPool(/* private fields */);
Expand description

Opaque handle to CVPixelBufferPool

Implementations§

§

impl CVPixelBufferPool

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

Wraps a +1 retained CVPixelBufferPoolRef and returns None for null.

pub const unsafe fn from_ptr(ptr: *mut c_void) -> CVPixelBufferPool

Wraps a raw CVPixelBufferPoolRef by taking ownership without retaining it.

§Safety

The caller must ensure ptr is a valid +1 retained CVPixelBufferPoolRef.

pub const fn as_ptr(&self) -> *mut c_void

Returns the wrapped raw CVPixelBufferPoolRef.

pub fn create( width: usize, height: usize, pixel_format: u32, max_buffers: usize, ) -> Result<CVPixelBufferPool, i32>

Create a new pixel buffer pool

§Arguments
  • width - Width of pixel buffers in the pool
  • height - Height of pixel buffers in the pool
  • pixel_format - Pixel format type
  • max_buffers - Maximum number of buffers in the pool (0 for unlimited)
§Errors

Returns a Core Video error code if the pool creation fails.

pub fn create_pixel_buffer(&self) -> Result<CVPixelBuffer, i32>

Create a pixel buffer from the pool

§Errors

Returns a Core Video error code if the buffer creation fails.

pub fn flush(&self)

Flush the pixel buffer pool

Releases all available pixel buffers in the pool

pub fn type_id() -> usize

Get the Core Foundation type ID for CVPixelBufferPool

pub fn create_pixel_buffer_with_aux_attributes( &self, aux_attributes: Option<&HashMap<String, u32>>, ) -> Result<CVPixelBuffer, i32>

Create a pixel buffer from the pool with auxiliary attributes

This allows specifying additional attributes for the created buffer

§Errors

Returns a Core Video error code if the buffer creation fails.

pub fn try_create_pixel_buffer(&self) -> Option<CVPixelBuffer>

Try to create a pixel buffer from the pool without blocking

Returns None if no buffers are available

pub fn flush_with_options(&self, _flags: u32)

Flush the pool with specific options

Releases buffers based on the provided flags

pub fn is_empty(&self) -> bool

Check if the pool is empty (no available buffers)

Note: This is an approximation based on whether we can create a buffer

pub fn attributes(&self) -> Option<*const c_void>

Get the pool attributes

Returns the raw pointer to the CFDictionary containing pool attributes

pub fn pixel_buffer_attributes(&self) -> Option<*const c_void>

Get the pixel buffer attributes

Returns the raw pointer to the CFDictionary containing pixel buffer attributes

Trait Implementations§

§

impl Clone for CVPixelBufferPool

§

fn clone(&self) -> CVPixelBufferPool

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
§

impl Debug for CVPixelBufferPool

§

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

Formats the value using the given formatter. Read more
§

impl Display for CVPixelBufferPool

§

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

Formats the value using the given formatter. Read more
§

impl Drop for CVPixelBufferPool

§

fn drop(&mut self)

Executes the destructor for this type. Read more
§

impl Hash for CVPixelBufferPool

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for CVPixelBufferPool

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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 Eq for CVPixelBufferPool

§

impl Send for CVPixelBufferPool

§

impl Sync for CVPixelBufferPool

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.