Struct MDLSubmesh

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

Available on crate feature MDLSubmesh only.

A drawable subset of an MDLMesh, with its own material

See also Apple’s documentation

Implementations

impl MDLSubmesh

pub unsafe fn initWithName_indexBuffer_indexCount_indexType_geometryType_material( this: Allocated<Self>, name: &NSString, index_buffer: &ProtocolObject<dyn MDLMeshBuffer>, index_count: NSUInteger, index_type: MDLIndexBitDepth, geometry_type: MDLGeometryType, material: Option<&MDLMaterial>, ) -> Retained<Self>

Available on crate features MDLMaterial and MDLMeshBuffer and MDLTypes only.

Initialize submesh with all data necessary to make properties valid

pub unsafe fn initWithIndexBuffer_indexCount_indexType_geometryType_material( this: Allocated<Self>, index_buffer: &ProtocolObject<dyn MDLMeshBuffer>, index_count: NSUInteger, index_type: MDLIndexBitDepth, geometry_type: MDLGeometryType, material: Option<&MDLMaterial>, ) -> Retained<Self>

Available on crate features MDLMaterial and MDLMeshBuffer and MDLTypes only.

Initialize submesh with all data necessary to make properties valid

pub unsafe fn initWithName_indexBuffer_indexCount_indexType_geometryType_material_topology( this: Allocated<Self>, name: &NSString, index_buffer: &ProtocolObject<dyn MDLMeshBuffer>, index_count: NSUInteger, index_type: MDLIndexBitDepth, geometry_type: MDLGeometryType, material: Option<&MDLMaterial>, topology: Option<&MDLSubmeshTopology>, ) -> Retained<Self>

Available on crate features MDLMaterial and MDLMeshBuffer and MDLTypes only.

Initialize submesh with all data necessary to make properties valid

The geometry type will typically be MDLGeometryTypeVariableTopology, if other types are used the faceTopologyBuffer contents should reflect that.

pub unsafe fn initWithMDLSubmesh_indexType_geometryType( this: Allocated<Self>, submesh: &MDLSubmesh, index_type: MDLIndexBitDepth, geometry_type: MDLGeometryType, ) -> Option<Retained<Self>>

Available on crate feature MDLTypes only.

Initialize submesh using another submesh as input.

the resulting submesh will have a new index type if necessary. If a conversion from the source submesh’s geometry type to the requested geometry type is possible, conversion will be performed. Otherwise nil will be returned.

pub unsafe fn indexBuffer(&self) -> Retained<ProtocolObject<dyn MDLMeshBuffer>>

Available on crate feature MDLMeshBuffer only.

Index data referencing vertex data in parent mesh

pub unsafe fn indexBufferAsIndexType( &self, index_type: MDLIndexBitDepth, ) -> Retained<ProtocolObject<dyn MDLMeshBuffer>>

Available on crate features MDLMeshBuffer and MDLTypes only.

pub unsafe fn indexCount(&self) -> NSUInteger

Number of indices in the indexBuffer

pub unsafe fn indexType(&self) -> MDLIndexBitDepth

Available on crate feature MDLTypes only.

Data type of indices in indexBuffer

Support 8, 16, and 32 bit unsigned integer values

pub unsafe fn geometryType(&self) -> MDLGeometryType

Available on crate feature MDLTypes only.

Type of primitive that vertices referenced by the indexBuffer are assembled into

pub unsafe fn material(&self) -> Option<Retained<MDLMaterial>>

Available on crate feature MDLMaterial only.

Material to apply when rendering this object

pub unsafe fn setMaterial(&self, material: Option<&MDLMaterial>)

Available on crate feature MDLMaterial only.

Setter for material.

pub unsafe fn topology(&self) -> Option<Retained<MDLSubmeshTopology>>

Topology data structure for use with MDLGeometryTypeVariableTopology

ignored for geometry types other than MDLGeometryTypeVariableTopology. A submesh of type MDLGeometryTypeVariableTopology with no topology data is an empty submesh.

pub unsafe fn setTopology(&self, topology: Option<&MDLSubmeshTopology>)

Setter for topology.

pub unsafe fn name(&self) -> Retained<NSString>

Identifying name for this object

pub unsafe fn setName(&self, name: &NSString)

Setter for name.

impl MDLSubmesh

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 MDLSubmesh

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MDLSubmesh> for MDLSubmesh

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MDLSubmesh

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MDLSubmesh

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MDLSubmesh

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MDLSubmesh

const NAME: &'static str = "MDLSubmesh"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MDLSubmesh

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MDLSubmesh

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 MDLNamed for MDLSubmesh

unsafe fn name(&self) -> Retained<NSString>

where Self: Sized + Message,

Available on crate feature MDLTypes only.

unsafe fn setName(&self, name: &NSString)

where Self: Sized + Message,

Available on crate feature MDLTypes only.

Setter for name.

impl Message for MDLSubmesh

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MDLSubmesh

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 MDLSubmesh

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 MDLSubmesh

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

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

impl DowncastTarget for MDLSubmesh

impl Eq for MDLSubmesh