Struct VTPixelTransferSession 

pub struct VTPixelTransferSession { /* private fields */ }

Available on crate feature VTPixelTransferSession only.

A reference to a Video Toolbox Pixel Transfer Session.

A pixel transfer session supports the copying and/or conversion of images from source CVPixelBuffers to destination CVPixelBuffers. The session reference is a reference-counted CF object. To create a pixel transfer session, call VTPixelTransferSessionCreate; then you can optionally configure the session using VTSessionSetProperty; then to transfer pixels, call VTPixelTransferSessionTransferImage. When you are done with the session, you should call VTPixelTransferSessionInvalidate to tear it down and CFRelease to release your object reference.

See also Apple’s documentation

Implementations

impl VTPixelTransferSession

pub unsafe fn create( allocator: Option<&CFAllocator>, pixel_transfer_session_out: NonNull<*mut VTPixelTransferSession>, ) -> i32

Creates a session for transferring images between CVPixelBuffers.

The function creates a session for transferring images between CVPixelBuffers.

Parameter allocator: An allocator for the session. Pass NULL to use the default allocator.

Parameter pixelTransferSessionOut: Points to a variable to receive the new pixel transfer session.

Safety

pixel_transfer_session_out must be a valid pointer.

pub unsafe fn invalidate(&self)

Tears down a pixel transfer session.

When you are done with a pixel transfer session you created, call VTPixelTransferSessionInvalidate to tear it down and then CFRelease to release your object reference. When a pixel transfer session’s retain count reaches zero, it is automatically invalidated, but since sessions may be retained by multiple parties, it can be hard to predict when this will happen. Calling VTPixelTransferSessionInvalidate ensures a deterministic, orderly teardown.

impl VTPixelTransferSession

pub unsafe fn transfer_image( &self, source_buffer: &CVPixelBuffer, destination_buffer: &CVPixelBuffer, ) -> i32

Available on crate feature objc2-core-video only.

Copies and/or converts an image from one pixel buffer to another.

By default, the full width and height of sourceBuffer are scaled to the full width and height of destinationBuffer. By default, all existing attachments on destinationBuffer are removed and new attachments are set describing the transferred image. Unrecognised attachments on sourceBuffer will be propagated to destinationBuffer. Some properties will modify this behaviour; see VTPixelTransferProperties.h for more details.

Parameter session: The pixel transfer session.

Parameter sourceBuffer: The source buffer.

Parameter destinationBuffer: The destination buffer.

Returns: If the transfer was successful, noErr; otherwise an error code, such as kVTPixelTransferNotSupportedErr.

Methods from Deref<Target = CFType>

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

where T: ConcreteType,

Available on crate feature VTSession only.

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

Available on crate feature VTSession only.

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 VTPixelTransferSession

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for VTPixelTransferSession

fn as_ref(&self) -> &CFType

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

impl AsRef<VTPixelTransferSession> for VTPixelTransferSession

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for VTPixelTransferSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for VTPixelTransferSession

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for VTPixelTransferSession

fn type_id() -> CFTypeID

Returns the CFTypeID for pixel transfer sessions.

impl Debug for VTPixelTransferSession

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

Formats the value using the given formatter.

impl Deref for VTPixelTransferSession

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for VTPixelTransferSession

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 VTPixelTransferSession

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for VTPixelTransferSession

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 VTPixelTransferSession

const ENCODING_REF: Encoding

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

impl Type for VTPixelTransferSession

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 VTPixelTransferSession