Struct GLKMeshBuffer

Source

pub struct GLKMeshBuffer { /* private fields */ }

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKModel only.

Expand description

Mesh buffers created when needs to allocate memory to back vertex or index data

Memory backing these buffer are OpenGL buffers. Model I/O will load index and vertex data from from a model asset directly in to the OpenGL buffer object.

Implementations§

Source §

impl GLKMeshBuffer

Source

pub unsafe fn length(&self) -> NSUInteger

👎Deprecated: The OpenGL API is deprecated by Apple

Size in bytes of the buffer allocation

Source

pub unsafe fn allocator(&self) -> Retained<GLKMeshBufferAllocator>

👎Deprecated: The OpenGL API is deprecated by Apple

Allocator object used to create this buffer.

This allcoator used for copy and relayout operations (such as when a new vertex descriptor is applied to a vertex buffer)

Source

pub unsafe fn glBufferName(&self) -> u32

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature objc2-open-gl and macOS only.

glBufferName for buffer object backing vertex/index data

Many GLKMeshBuffers may reference the same OpenGL buffer object, but each with its own offset. (i.e. Many GLKMeshBuffers may be suballocated from a single OpenGL buffer object)

Source

pub unsafe fn offset(&self) -> NSUInteger

👎Deprecated: The OpenGL API is deprecated by Apple

Byte offset of the data within the OpenGL buffer

Source

pub unsafe fn zone( &self, ) -> Option<Retained<ProtocolObject<dyn MDLMeshBufferZone>>>

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature objc2-model-io only.

Zone from which this buffer was created (if it was created witha zone)

A single GL buffer is allocated for each zone. Each zone could have many GLKMeshBuffers, each with it’s own offset. If a GLKMeshBufferAllocator is used, Model I/O will attempt to load all vertex and indexData of a single model into a single zone. So although there maybe many GLKMeshBuffers for a model they will be backed with the same contigous GL buffer.

Source

pub unsafe fn type(&self) -> MDLMeshBufferType

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature objc2-model-io only.

the intended type of the buffer

Source §

impl GLKMeshBuffer

Methods declared on superclass NSObject.

Source

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

👎Deprecated: The OpenGL API is deprecated by Apple

Source

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

👎Deprecated: The OpenGL API is deprecated by Apple

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}