Struct MTLRasterizationRateLayerDescriptor 

pub struct MTLRasterizationRateLayerDescriptor { /* private fields */ }

Available on crate feature MTLRasterizationRate only.

Describes the minimum rasterization rate screen space using two piecewise linear functions.

The two piecewise linear function (PLF) describe the desired rasterization quality on the horizontal and vertical axis separately. Each quality sample in the PLF is stored in an array as single precision floating point value between 0 (lowest quality) and 1 (highest quality). The first sample in the array describes the quality at the top (vertical) or left (horizontal) edge of screen space. The last sample in the array describes the quality at the bottom (vertical) or right (horizontal) edge of screen space. All other samples are spaced equidistant in screen space. MTLRasterizationRateLayerDescriptor instances will be stored inside a MTLRasterizationRateMapDescriptor which in turn is compiled by MTLDevice into a MTLRasterizationRateMap. Because MTLDevice may not support the requested granularity, the provided samples may be rounded up (towards higher quality) during compilation.

See also Apple’s documentation

Implementations

impl MTLRasterizationRateLayerDescriptor

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

Do not use, instead use initWithNumSamples:

pub unsafe fn initWithSampleCount( this: Allocated<Self>, sample_count: MTLSize, ) -> Retained<Self>

Available on crate feature MTLTypes only.

Initialize a descriptor for a layer with the given number of quality samples on the horizontal and vertical axis.

Parameter sampleCount: The width and height components are the number of samples on the horizontal and vertical axis respectively. The depth component is ignored.

All values are initialized to zero.

Safety

sampleCount might not be bounds-checked.

pub unsafe fn initWithSampleCount_horizontal_vertical( this: Allocated<Self>, sample_count: MTLSize, horizontal: NonNull<c_float>, vertical: NonNull<c_float>, ) -> Retained<Self>

Available on crate feature MTLTypes only.

Initialize a descriptor for a layer with the given number of quality samples on the horizontal and vertical axis.

Parameter sampleCount: The width and height components are the number of samples on the horizontal and vertical axis respectively. The depth component is ignored.

Parameter horizontal: The initial sample values on the horizontal axis. Must point to an array of sampleCount.width elements, of which the values will be copied into the MTLRasterizationRateLayerDescriptor.

Parameter vertical: The initial sample values on the vertical axis. Must point to an array of sampleCount.height elements, of which the values will be copied into the MTLRasterizationRateLayerDescriptor.

Use initWithSampleCount: to initialize with zeroes instead.

Safety

• sampleCount might not be bounds-checked.
• horizontal must be a valid pointer.
• vertical must be a valid pointer.

pub fn maxSampleCount(&self) -> MTLSize

Available on crate feature MTLTypes only.

Returns: The maximum number of quality samples that this descriptor can use to describe its function, for the horizontal and vertical axis, this is the sampleCount that the descriptor was initialized with. The depth component of the returned MTLSize is always 0.

pub fn horizontalSampleStorage(&self) -> NonNull<c_float>

Provide direct access to the quality samples stored in the descriptor.

Returns: Pointer to the (mutable) storage array for samples on the horizontal axis.

The returned pointer points to the first element of an array of sampleCount.width elements.

pub fn verticalSampleStorage(&self) -> NonNull<c_float>

Provide direct access to the quality samples stored in the descriptor.

Returns: Pointer to the (mutable) storage array for samples on the vertical axis.

The returned pointer points to the first element of an array of sampleCount.height elements.

pub fn horizontal(&self) -> Retained<MTLRasterizationRateSampleArray>

Provide convenient bounds-checked access to the quality samples stored in the descriptor.

Returns: Returns a syntactic sugar helper to get or set sample values on the horizontal axis.

pub fn vertical(&self) -> Retained<MTLRasterizationRateSampleArray>

Provide convenient bounds-checked access to the quality samples stored in the descriptor.

Returns: Returns a syntactic sugar helper to get or set sample values on the vertical axis.

impl MTLRasterizationRateLayerDescriptor

Methods declared on superclass NSObject.

pub fn new() -> Retained<Self>

impl MTLRasterizationRateLayerDescriptor

pub unsafe fn setSampleCount(&self, sample_count: MTLSize)

Available on crate feature MTLTypes only.

Setter for sampleCount.

Safety

This might not be bounds-checked.

impl MTLRasterizationRateLayerDescriptor

pub fn sampleCount(&self) -> MTLSize

Available on crate feature MTLTypes only.

The number of quality samples that this descriptor uses to describe its current function, for the horizontal and vertical axis. The depth component of the returned MTLSize is always 0.

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 MTLRasterizationRateLayerDescriptor

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTLRasterizationRateLayerDescriptor> for MTLRasterizationRateLayerDescriptor

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTLRasterizationRateLayerDescriptor

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTLRasterizationRateLayerDescriptor

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTLRasterizationRateLayerDescriptor

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTLRasterizationRateLayerDescriptor

const NAME: &'static str = "MTLRasterizationRateLayerDescriptor"

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

type Super = NSObject

The superclass of this class.

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

type Result = MTLRasterizationRateLayerDescriptor

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

impl Debug for MTLRasterizationRateLayerDescriptor

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

Formats the value using the given formatter.

impl DefaultRetained for MTLRasterizationRateLayerDescriptor

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for MTLRasterizationRateLayerDescriptor

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTLRasterizationRateLayerDescriptor

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 MTLRasterizationRateLayerDescriptor

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for MTLRasterizationRateLayerDescriptor

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 MTLRasterizationRateLayerDescriptor

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 MTLRasterizationRateLayerDescriptor

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 MTLRasterizationRateLayerDescriptor

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

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

impl DowncastTarget for MTLRasterizationRateLayerDescriptor

impl Eq for MTLRasterizationRateLayerDescriptor