Struct VTMotionBlurConfiguration 

#[repr(C)]
pub struct VTMotionBlurConfiguration { /* private fields */ }

Available on crate features VTFrameProcessor_MotionBlur and objc2 only.

Configuration that is used to set up the MotionBlur Processor.

This configuration enables the MotionBlur on a VTFrameProcesing session.

See also Apple’s documentation

Implementations

impl VTMotionBlurConfiguration

pub unsafe fn initWithFrameWidth_frameHeight_usePrecomputedFlow_qualityPrioritization_revision( this: Allocated<Self>, frame_width: NSInteger, frame_height: NSInteger, use_precomputed_flow: bool, quality_prioritization: VTMotionBlurConfigurationQualityPrioritization, revision: VTMotionBlurConfigurationRevision, ) -> Option<Retained<Self>>

Creates a new VTMotionBlurConfiguration with specified flow width and height.

init will return nil if dimensions are out of range or revision is unsupported.

Parameter frameWidth: Width of source frame in pixels. Maximum value is 8192 for macOS, and 4096 for iOS.

Parameter frameHeight: Height of source frame in pixels. Maximum value is 4320 for macOS, and 2160 for iOS.

Parameter usePrecomputedFlow: Boolean value to indicate that Optical Flow will be provided by the user, if false this configuration will compute the optical flow on the fly.

Parameter qualityPrioritization: Used to control quality and performance levels. See VTMotionBlurConfigurationQualityPrioritization for more info.

Parameter revision: The specific algorithm or configuration revision that is to be used to perform the request.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

pub unsafe fn frameWidth(&self) -> NSInteger

Width of source frame in pixels.

pub unsafe fn frameHeight(&self) -> NSInteger

Height of source frame in pixels.

pub unsafe fn usePrecomputedFlow(&self) -> bool

Indicates that caller will provide optical flow.

pub unsafe fn qualityPrioritization( &self, ) -> VTMotionBlurConfigurationQualityPrioritization

parameter used to control quality and performance levels. See VTMotionBlurConfigurationQualityPrioritization for more info.

pub unsafe fn revision(&self) -> VTMotionBlurConfigurationRevision

The specific algorithm or configuration revision that is to be used to perform the request.

pub unsafe fn supportedRevisions() -> Retained<NSIndexSet>

Available on crate feature objc2-foundation only.

Provides the collection of currently-supported algorithm or configuration revisions for the class of configuration.

This property allows clients to introspect at runtime what revisions are available for each configuration.

pub unsafe fn defaultRevision() -> VTMotionBlurConfigurationRevision

Provides the default revision of a particular algorithm or configuration.

pub unsafe fn frameSupportedPixelFormats(&self) -> Retained<NSArray<NSNumber>>

Available on crate feature objc2-foundation only.

list of source frame supported pixel formats for current configuration

pub unsafe fn sourcePixelBufferAttributes( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

Available on crate feature objc2-foundation only.

returns a pixelBufferAttributes dictionary describing requirements for pixelBuffers used as source frames and reference frames.

pub unsafe fn destinationPixelBufferAttributes( &self, ) -> Retained<NSDictionary<NSString, AnyObject>>

Available on crate feature objc2-foundation only.

returns a pixelBufferAttributes dictionary describing requirements for pixelBuffers used as destination frames.

pub unsafe fn processorSupported() -> u8

reports that this processor is supported

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for VTMotionBlurConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for VTMotionBlurConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<VTMotionBlurConfiguration> for VTMotionBlurConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for VTMotionBlurConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for VTMotionBlurConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for VTMotionBlurConfiguration

const NAME: &'static str = "VTMotionBlurConfiguration"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<VTMotionBlurConfiguration as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for VTMotionBlurConfiguration

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

Formats the value using the given formatter.

impl Deref for VTMotionBlurConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for VTMotionBlurConfiguration

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 VTMotionBlurConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for VTMotionBlurConfiguration

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for VTMotionBlurConfiguration

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 VTMotionBlurConfiguration

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl VTFrameProcessorConfiguration for VTMotionBlurConfiguration

unsafe fn processorSupported() -> u8

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

Returns a Boolean indicating whether the processor supported on the current config.

unsafe fn frameSupportedPixelFormats(&self) -> Retained<NSArray<NSNumber>>

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-foundation only.

Returns a list of supported pixel formats for the current configuration

unsafe fn sourcePixelBufferAttributes(&self) -> Retained<NSDictionary>

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-foundation only.

Returns a dictionary of CVPixelBuffer attributes which source and reference frames passed to the processor must conform to.

unsafe fn destinationPixelBufferAttributes(&self) -> Retained<NSDictionary>

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-foundation only.

Returns a dictionary of CVPixelBuffer attributes which output frames passed to the processor must conform to.

unsafe fn nextFrameCount(&self) -> NSInteger

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

returns the number of “next” frames that this processor requires for processing.

unsafe fn previousFrameCount(&self) -> NSInteger

where Self: Sized + Message,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

returns the number of “previous” frames that this processor requires for processing.

unsafe fn maximumDimensions() -> CMVideoDimensions

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-core-media only.

returns the maximum dimension for a sourceFrame for the processor

unsafe fn minimumDimensions() -> CMVideoDimensions

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 and objc2-core-media only.

returns the minimum dimension for a sourceFrame for the processor

impl DowncastTarget for VTMotionBlurConfiguration

impl Eq for VTMotionBlurConfiguration

impl Send for VTMotionBlurConfiguration

impl Sync for VTMotionBlurConfiguration