Struct MTLFXFrameInterpolatorDescriptor 

pub struct MTLFXFrameInterpolatorDescriptor { /* private fields */ }

Available on crate feature MTLFXFrameInterpolator only.

A set of properties that configure a frame interpolator, and a factory method that creates the effect.

A frame interpolator inspects two frames your game or app renders and, based on their properties, generates an extra frame at a fraction of the cost, helping you to increase your frame rate.

When you configure this descriptor, set the properties that determine the pixel format for each texture to the respective format of the texture you later assign to the scaler. For example, make sure that the format to which you set the colorTextureFormat property matches the format of the texture you later assign to the interpolator’s MTLFXFrameInterpolatorDescriptor/colorTexture property.

See also Apple’s documentation

Implementations

impl MTLFXFrameInterpolatorDescriptor

pub unsafe fn colorTextureFormat(&self) -> MTLPixelFormat

The pixel format of the input color texture for the frame interpolator you create with this descriptor.

pub unsafe fn setColorTextureFormat(&self, color_texture_format: MTLPixelFormat)

Setter for colorTextureFormat.

pub unsafe fn outputTextureFormat(&self) -> MTLPixelFormat

The pixel format of the output color texture for the frame interpolator you create with this descriptor.

pub unsafe fn setOutputTextureFormat( &self, output_texture_format: MTLPixelFormat, )

Setter for outputTextureFormat.

pub unsafe fn depthTextureFormat(&self) -> MTLPixelFormat

The pixel format of the input depth texture for the frame interpolator you create with this descriptor.

pub unsafe fn setDepthTextureFormat(&self, depth_texture_format: MTLPixelFormat)

Setter for depthTextureFormat.

pub unsafe fn motionTextureFormat(&self) -> MTLPixelFormat

The pixel format of the input motion texture for the frame interpolator you create with this descriptor.

pub unsafe fn setMotionTextureFormat( &self, motion_texture_format: MTLPixelFormat, )

Setter for motionTextureFormat.

pub unsafe fn uiTextureFormat(&self) -> MTLPixelFormat

The pixel format for the frame interpolator of an input texture containing your game’s custom UI.

pub unsafe fn setUITextureFormat(&self, ui_texture_format: MTLPixelFormat)

Setter for uiTextureFormat.

pub unsafe fn scaler( &self, ) -> Option<Retained<ProtocolObject<dyn MTLFXFrameInterpolatableScaler>>>

Available on crate feature MTLFXTemporalScaler only.

pub unsafe fn setScaler( &self, scaler: Option<&ProtocolObject<dyn MTLFXFrameInterpolatableScaler>>, )

Available on crate feature MTLFXTemporalScaler only.

Setter for scaler.

pub unsafe fn inputWidth(&self) -> NSUInteger

The width, in pixels, of the input motion and depth texture for the frame interpolator.

pub unsafe fn setInputWidth(&self, input_width: NSUInteger)

Setter for inputWidth.

pub unsafe fn inputHeight(&self) -> NSUInteger

The height, in pixels, of the input motion and depth texture for the frame interpolator.

pub unsafe fn setInputHeight(&self, input_height: NSUInteger)

Setter for inputHeight.

pub unsafe fn outputWidth(&self) -> NSUInteger

The width, in pixels, of the output color texture for the frame interpolator.

pub unsafe fn setOutputWidth(&self, output_width: NSUInteger)

Setter for outputWidth.

pub unsafe fn outputHeight(&self) -> NSUInteger

The height, in pixels, of the output color texture for the frame interpolator.

pub unsafe fn setOutputHeight(&self, output_height: NSUInteger)

Setter for outputHeight.

pub unsafe fn newFrameInterpolatorWithDevice( &self, device: &ProtocolObject<dyn MTLDevice>, ) -> Option<Retained<ProtocolObject<dyn MTLFXFrameInterpolator>>>

Creates a frame interpolator instance for a Metal device.

• Parameters:
• device: The Metal device that creates the frame interpolator.
• Returns: A new frame interpolator instance upon success, or nil otherwise.

pub unsafe fn newFrameInterpolatorWithDevice_compiler( &self, device: &ProtocolObject<dyn MTLDevice>, compiler: &ProtocolObject<dyn MTL4Compiler>, ) -> Option<Retained<ProtocolObject<dyn MTL4FXFrameInterpolator>>>

Available on crate feature MTL4FXFrameInterpolator only.

Creates a frame interpolator instance for a Metal device.

• Parameters:
• device: The Metal device that creates the frame interpolator.
• compiler: A compiler instance this method can use to build pipeline state objects.
• Returns: A new frame interpolator instance upon success, or nil otherwise.

pub unsafe fn supportsMetal4FX(device: &ProtocolObject<dyn MTLDevice>) -> bool

Queries whether a Metal device supports frame interpolation compatible with a Metal 4 command buffer.

• Parameters:

• device: The GPU device for which this methods tests support.

• Returns: <doc ://com.apple.documentation/documentation/swift/true> if the device supports frame interpolation for Metal 4, <doc ://com.apple.documentation/documentation/swift/false> otherwise.

pub unsafe fn supportsDevice(device: &ProtocolObject<dyn MTLDevice>) -> bool

Queries whether a Metal device supports frame interpolation.

• Parameters:

• device: The GPU device for which this methods tests support.

• Returns: <doc ://com.apple.documentation/documentation/swift/true> if the device supports frame interpolation, <doc ://com.apple.documentation/documentation/swift/false> otherwise.

impl MTLFXFrameInterpolatorDescriptor

Methods declared on superclass NSObject.

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

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

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 MTLFXFrameInterpolatorDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLFXFrameInterpolatorDescriptor> for MTLFXFrameInterpolatorDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLFXFrameInterpolatorDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLFXFrameInterpolatorDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLFXFrameInterpolatorDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLFXFrameInterpolatorDescriptor

const NAME: &'static str = "MTLFXFrameInterpolatorDescriptor"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<MTLFXFrameInterpolatorDescriptor 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 CopyingHelper for MTLFXFrameInterpolatorDescriptor

type Result = MTLFXFrameInterpolatorDescriptor

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for MTLFXFrameInterpolatorDescriptor

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

Formats the value using the given formatter.

impl Deref for MTLFXFrameInterpolatorDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLFXFrameInterpolatorDescriptor

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 MTLFXFrameInterpolatorDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLFXFrameInterpolatorDescriptor

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for MTLFXFrameInterpolatorDescriptor

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 MTLFXFrameInterpolatorDescriptor

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 MTLFXFrameInterpolatorDescriptor

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

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

impl DowncastTarget for MTLFXFrameInterpolatorDescriptor

impl Eq for MTLFXFrameInterpolatorDescriptor