Struct MPSGraphStencilOpDescriptor 

pub struct MPSGraphStencilOpDescriptor { /* private fields */ }

Available on crate features MPSGraphCore and MPSGraphStencilOps only.

The class that defines the parameters for a stencil operation.

Use this descriptor with the following MPSGraph method:

• MPSGraph/stencilWithSourceTensor:weightsTensor:descriptor:name:

See also Apple’s documentation

Implementations

impl MPSGraphStencilOpDescriptor

pub unsafe fn reductionMode(&self) -> MPSGraphReductionMode

The reduction mode to use within the stencil window.

Default value: MPSGraphReductionModeSum.

pub unsafe fn setReductionMode(&self, reduction_mode: MPSGraphReductionMode)

Setter for reductionMode.

pub unsafe fn offsets(&self) -> Retained<MPSShape>

Available on crate feature objc2-metal-performance-shaders only.

An array of length four that determines from which offset to start reading the input tensor.

Only used when paddingStyle is MPSGraphPaddingStyleExplicitOffset. For example zero offset means that the first stencil window will align its top-left corner (in 4 dimensions) to the top-left corner of the input tensor. Default value: @ [ @ 0, @ 0, @ 0, @ 0 ]

pub unsafe fn setOffsets(&self, offsets: &MPSShape)

Available on crate feature objc2-metal-performance-shaders only.

Setter for offsets.

This is copied when set.

pub unsafe fn strides(&self) -> Retained<MPSShape>

Available on crate feature objc2-metal-performance-shaders only.

The property that defines strides for spatial dimensions.

Must be four numbers, one for each spatial dimension, fastest running index last. Default value: @ [ @ 1, @ 1, @ 1, @ 1 ]

pub unsafe fn setStrides(&self, strides: &MPSShape)

Available on crate feature objc2-metal-performance-shaders only.

Setter for strides.

This is copied when set.

pub unsafe fn dilationRates(&self) -> Retained<MPSShape>

Available on crate feature objc2-metal-performance-shaders only.

The property that defines dilation rates for spatial dimensions.

Must be four numbers, one for each spatial dimension, fastest running index last. Default value: @ [ @ 1, @ 1, @ 1, @ 1 ]

pub unsafe fn setDilationRates(&self, dilation_rates: &MPSShape)

Available on crate feature objc2-metal-performance-shaders only.

Setter for dilationRates.

This is copied when set.

pub unsafe fn explicitPadding(&self) -> Retained<MPSShape>

Available on crate feature objc2-metal-performance-shaders only.

The property that defines padding values for spatial dimensions.

Must be eight numbers, two for each spatial dimension. For example paddingValues[0] defines the explicit padding amount before the first spatial dimension (slowest running index of spatial dimensions), paddingValues[1] defines the padding amount after the first spatial dimension etc. Used only when paddingStyle = MPSGraphPaddingStyleExplicit. Default value: @ [ @ 0, @ 0, @ 0, @ 0, @ 0, @ 0, @ 0, @ 0 ]

pub unsafe fn setExplicitPadding(&self, explicit_padding: &MPSShape)

Available on crate feature objc2-metal-performance-shaders only.

Setter for explicitPadding.

This is copied when set.

pub unsafe fn boundaryMode(&self) -> MPSGraphPaddingMode

The property that determines which values to use for padding the input tensor.

Default value: MPSGraphPaddingModeZero.

pub unsafe fn setBoundaryMode(&self, boundary_mode: MPSGraphPaddingMode)

Setter for boundaryMode.

pub unsafe fn paddingStyle(&self) -> MPSGraphPaddingStyle

The property that defines what kind of padding to apply to the stencil operation.

Default value: MPSGraphPaddingStyleExplicit.

pub unsafe fn setPaddingStyle(&self, padding_style: MPSGraphPaddingStyle)

Setter for paddingStyle.

pub unsafe fn paddingConstant(&self) -> c_float

The padding value for boundaryMode = MPSGraphPaddingModeConstant.

Default value: 0.

pub unsafe fn setPaddingConstant(&self, padding_constant: c_float)

Setter for paddingConstant.

pub unsafe fn descriptorWithReductionMode_offsets_strides_dilationRates_explicitPadding_boundaryMode_paddingStyle_paddingConstant( reduction_mode: MPSGraphReductionMode, offsets: &MPSShape, strides: &MPSShape, dilation_rates: &MPSShape, explicit_padding: &MPSShape, boundary_mode: MPSGraphPaddingMode, padding_style: MPSGraphPaddingStyle, padding_constant: c_float, ) -> Option<Retained<Self>>

Available on crate feature objc2-metal-performance-shaders only.

Creates a stencil operation descriptor with given values.

• Parameters:
• reductionMode: See reductionMode property.
• offsets: See offsets property.
• strides: See strides property.
• dilationRates: See dilationRates property.
• explicitPadding: See explicitPadding property.
• boundaryMode: See boundaryMode property.
• paddingStyle: See paddingStyle property.
• paddingConstant: See paddingConstant property.
• Returns: A valid MPSGraphStencilOpDescriptor object

pub unsafe fn descriptorWithOffsets_explicitPadding( offsets: &MPSShape, explicit_padding: &MPSShape, ) -> Option<Retained<Self>>

Available on crate feature objc2-metal-performance-shaders only.

Creates a stencil operation descriptor with default values.

• Parameters:
• offsets: See offsets property.
• explicitPadding: See explicitPadding property.
• Returns: A valid MPSGraphStencilOpDescriptor object

pub unsafe fn descriptorWithExplicitPadding( explicit_padding: &MPSShape, ) -> Option<Retained<Self>>

Available on crate feature objc2-metal-performance-shaders only.

Creates a stencil operation descriptor with default values.

• Parameters:
• explicitPadding: See explicitPadding property.
• Returns: A valid MPSGraphStencilOpDescriptor object

pub unsafe fn descriptorWithPaddingStyle( padding_style: MPSGraphPaddingStyle, ) -> Option<Retained<Self>>

Creates a stencil operation descriptor with default values.

• Parameters:
• paddingStyle: See paddingStyle property.
• Returns: A valid MPSGraphStencilOpDescriptor object

impl MPSGraphStencilOpDescriptor

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 MPSGraphStencilOpDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MPSGraphObject> for MPSGraphStencilOpDescriptor

fn as_ref(&self) -> &MPSGraphObject

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

impl AsRef<MPSGraphStencilOpDescriptor> for MPSGraphStencilOpDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MPSGraphStencilOpDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MPSGraphStencilOpDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MPSGraphObject> for MPSGraphStencilOpDescriptor

fn borrow(&self) -> &MPSGraphObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MPSGraphStencilOpDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MPSGraphStencilOpDescriptor

const NAME: &'static str = "MPSGraphStencilOpDescriptor"

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

type Super = MPSGraphObject

The superclass of this class.

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

type Result = MPSGraphStencilOpDescriptor

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

impl Debug for MPSGraphStencilOpDescriptor

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

Formats the value using the given formatter.

impl Deref for MPSGraphStencilOpDescriptor

type Target = MPSGraphObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MPSGraphStencilOpDescriptor

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 MPSGraphStencilOpDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MPSGraphStencilOpDescriptor

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 MPSGraphStencilOpDescriptor

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 MPSGraphStencilOpDescriptor

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 MPSGraphStencilOpDescriptor

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

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

impl DowncastTarget for MPSGraphStencilOpDescriptor

impl Eq for MPSGraphStencilOpDescriptor