Struct VTHDRPerFrameMetadataGenerationSession 

pub struct VTHDRPerFrameMetadataGenerationSession { /* private fields */ }

Available on crate feature VTHDRPerFrameMetadataGenerationSession only.

A mechanism for generating HDR Per Frame Metadata and attaching that metadata to a CVPixelBuffer and the backing IOSurface.

VTHDRPerFrameMetadataGenerationSessionRef is a CF type, so call CFRelease to release your object reference.

See also Apple’s documentation

Implementations

impl VTHDRPerFrameMetadataGenerationSession

pub unsafe fn create( allocator: Option<&CFAllocator>, frames_per_second: c_float, options: Option<&CFDictionary>, hdr_per_frame_metadata_generation_session_out: NonNull<*mut VTHDRPerFrameMetadataGenerationSession>, ) -> i32

Creates a VTHDRPerFrameMetadataGenerationSession object.

The returned VTHDRPerFrameMetadataGenerationSession object may be used to perform HDR Per Frame Metadata Generation Call CFRelease to release your object reference.

Parameter framesPerSecond: Value must be greater than 0.0

Parameter options: CFDictionary may contain the key kVTHDRPerFrameMetadataGenerationOptionsHDRFormatsKey.

Safety

• options generics must be of the correct type.
• hdr_per_frame_metadata_generation_session_out must be a valid pointer.

pub unsafe fn attach_metadata( &self, pixel_buffer: &CVPixelBuffer, scene_change: bool, ) -> i32

Available on crate feature objc2-core-video only.

Attaches the Per Frame Metadata to the CVPixelBuffer and the backing IOSurface

Call this to analyze and attach HDR Metadata. This call will change CVPixelBuffer attachments and backing IOSurface attachments.

Parameter hdrPerFrameMetadataGenerationSession: Parameter pixelBuffer: Parameter sceneChange: If this frame changes significantly in brightness from the previous frame, for example going from an indoor scene to an outdoor scene or from a night scene to a daytime scene, set this to true.

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 VTHDRPerFrameMetadataGenerationSession

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for VTHDRPerFrameMetadataGenerationSession

fn as_ref(&self) -> &CFType

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

impl AsRef<VTHDRPerFrameMetadataGenerationSession> for VTHDRPerFrameMetadataGenerationSession

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for VTHDRPerFrameMetadataGenerationSession

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for VTHDRPerFrameMetadataGenerationSession

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for VTHDRPerFrameMetadataGenerationSession

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for VTHDRPerFrameMetadataGenerationSession

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

Formats the value using the given formatter.

impl Deref for VTHDRPerFrameMetadataGenerationSession

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for VTHDRPerFrameMetadataGenerationSession

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 VTHDRPerFrameMetadataGenerationSession

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for VTHDRPerFrameMetadataGenerationSession

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 VTHDRPerFrameMetadataGenerationSession

const ENCODING_REF: Encoding

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

impl Type for VTHDRPerFrameMetadataGenerationSession

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 VTHDRPerFrameMetadataGenerationSession