Struct VTSuperResolutionScalerConfiguration 

pub struct VTSuperResolutionScalerConfiguration { /* private fields */ }

Available on crate features VTFrameProcessor_SuperResolutionScaler and objc2 only.

Configuration that you use to set up the super-resolution processor.

This configuration enables the super-resolution processor on a VTFrameProcessor session.

Important: The super-resolution processor may require ML models which the framework needs to download in order to operate. Before calling VTFrameProcessor/startSessionWithConfiguration:error: with an instance of this class, it is important that you verify that the necessary models are present by checking configurationModelStatus. If models are not available, you can trigger model download using the downloadConfigurationModelWithCompletionHandler: method. Best practice is to confirm availability of models and drive download with user awareness and interaction before engaging workflows that need this processor.

See also Apple’s documentation

Implementations

impl VTSuperResolutionScalerConfiguration

pub unsafe fn initWithFrameWidth_frameHeight_scaleFactor_inputType_usePrecomputedFlow_qualityPrioritization_revision( this: Allocated<Self>, frame_width: NSInteger, frame_height: NSInteger, scale_factor: NSInteger, input_type: VTSuperResolutionScalerConfigurationInputType, use_precomputed_flow: bool, quality_prioritization: VTSuperResolutionScalerConfigurationQualityPrioritization, revision: VTSuperResolutionScalerConfigurationRevision, ) -> Option<Retained<Self>>

Creates a new super-resolution scaler processor configuration.

This processor increases resolution of an image or video. Returns nil if dimensions are out of range or revision is unsupported.

• Parameters:
• frameWidth: Width of source frame in pixels. With VTSuperResolutionScalerConfigurationInputTypeVideo, maximum width is 1920 on macOS and 1440 on iOS. With VTSuperResolutionScalerConfigurationInputTypeImage, maximum width is 1920.
• frameHeight: Height of source frame in pixels. With VTSuperResolutionScalerConfigurationInputTypeVideo, maximum height is 1080. With VTSuperResolutionScalerConfigurationInputTypeImage, maximum height is 1920 on macOS and 1080 on iOS.
• scaleFactor: Indicates the scale factor between input and output.
• inputType: Indicates the type of input, either video or image.
• usePrecomputedFlow: Boolean value to indicate that you provide optical flow; if false, this configuration computes the optical flow on the fly.
• qualityPrioritization: A level you use to prioritize quality or performance; for more information about supported levels, see VTSuperResolutionScalerConfigurationQualityPrioritization.
• revision: The specific algorithm or configuration revision you use 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.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn frameHeight(&self) -> NSInteger

Height of source frame in pixels.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn inputType(&self) -> VTSuperResolutionScalerConfigurationInputType

Indicates the type of input.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn usesPrecomputedFlow(&self) -> bool

Indicates that you provide optical flow.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn scaleFactor(&self) -> NSInteger

Indicates the scale factor between input and output.

This property is not atomic.

Safety

This might not be thread-safe.

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

A parameter to control quality and performance levels.

For more information about supported levels, see VTSuperResolutionScalerConfigurationQualityPrioritization.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn revision(&self) -> VTSuperResolutionScalerConfigurationRevision

The specific algorithm or configuration revision you use to perform the request.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature objc2-foundation only.

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

A property you use to introspect at runtime which revisions are available for each configuration.

pub unsafe fn defaultRevision() -> VTSuperResolutionScalerConfigurationRevision

Provides the default revision of a specific algorithm or configuration.

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

Available on crate feature objc2-foundation only.

Available supported pixel formats for source frames for current configuration.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature objc2-foundation only.

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent source frames and reference frames.

Use CVPixelBufferCreateResolvedAttributesDictionary to combine this dictionary with your pixel buffer attributes dictionary.

This property is not atomic.

Safety

This might not be thread-safe.

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

Available on crate feature objc2-foundation only.

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent destination frames.

Use CVPixelBufferCreateResolvedAttributesDictionary to combine this dictionary with your pixel buffer attributes dictionary.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn configurationModelStatus( &self, ) -> VTSuperResolutionScalerConfigurationModelStatus

Reports the download status of models that the system needs for the current configuration.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn downloadConfigurationModelWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(*mut NSError)>, )

Available on crate features block2 and objc2-foundation only.

Downloads models that the system needs for the current configuration.

This method downloads model assets required for the current configuration in background. You should call this method if configurationModelStatus is VTSuperResolutionScalerConfigurationModelStatusDownloadRequired. After this method is called, you can query configurationModelPercentageAvailable to determine progress of model asset download process. If the download fails, the completion handler is invoked with an NSError, and the configurationModelStatus goes back to VTSuperResolutionScalerConfigurationModelStatusDownloadRequired. If the download succeeds, the completion handler is invoked with nil NSError.

pub unsafe fn configurationModelPercentageAvailable(&self) -> c_float

Returns a floating point value between 0.0 and 1.0 indicating the percentage of required model assets that have been downloaded.

This property is not atomic.

Safety

This might not be thread-safe.

pub unsafe fn isSupported() -> bool

Reports whether the system supports this processor.

pub unsafe fn supportedScaleFactors() -> Retained<NSArray<NSNumber>>

Available on crate feature objc2-foundation only.

Reports the set of supported scale factors to use when initializing a super-resolution scaler configuration.

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 VTSuperResolutionScalerConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for VTSuperResolutionScalerConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<VTSuperResolutionScalerConfiguration> for VTSuperResolutionScalerConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for VTSuperResolutionScalerConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for VTSuperResolutionScalerConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for VTSuperResolutionScalerConfiguration

const NAME: &'static str = "VTSuperResolutionScalerConfiguration"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<VTSuperResolutionScalerConfiguration 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 VTSuperResolutionScalerConfiguration

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

Formats the value using the given formatter.

impl Deref for VTSuperResolutionScalerConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for VTSuperResolutionScalerConfiguration

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 VTSuperResolutionScalerConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for VTSuperResolutionScalerConfiguration

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 VTSuperResolutionScalerConfiguration

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 VTSuperResolutionScalerConfiguration

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

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

impl VTFrameProcessorConfiguration for VTSuperResolutionScalerConfiguration

unsafe fn isSupported() -> bool

where Self: Sized + ClassType,

Available on crate features VTFrameProcessorConfiguration and objc2 only.

Returns a Boolean indicating whether the system supports this processor on the current configuration.

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

where Self: Sized + Message,

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

List of supported pixel formats for source frames for the current configuration.

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

where Self: Sized + Message,

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

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent source frames and reference frames.

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

where Self: Sized + Message,

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

Pixel buffer attributes dictionary that describes requirements for pixel buffers which represent destination frames.

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 dimensions 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 dimensions for a sourceFrame for the processor.

impl DowncastTarget for VTSuperResolutionScalerConfiguration

impl Eq for VTSuperResolutionScalerConfiguration

impl Send for VTSuperResolutionScalerConfiguration

impl Sync for VTSuperResolutionScalerConfiguration