Struct MDLURLTexture

Source

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

Available on crate feature MDLTexture only.

Expand description

MDLURLTexture a texture provider initialized with a URL or file path.

if any of the properties of the texture, such as data, are referenced, then the texture may be loaded, otherwise, the MDLURLTexture is merely a lightweight reference to something that could be loaded

Implementations§

Source §

impl MDLURLTexture

Source

pub unsafe fn initWithURL_name( this: Allocated<Self>, url: &NSURL, name: Option<&NSString>, ) -> Retained<Self>

Source

pub unsafe fn URL(&self) -> Retained<NSURL>

Source

pub unsafe fn setURL(&self, url: &NSURL)

Setter for URL.

Source §

impl MDLURLTexture

Methods declared on superclass MDLTexture.

Source

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

Source

pub unsafe fn textureNamed(name: &NSString) -> Option<Retained<Self>>

Creates a texture from a source in the main bundle named in a manner matching name.

Source

pub unsafe fn textureNamed_bundle( name: &NSString, bundle_or_nil: Option<&NSBundle>, ) -> Option<Retained<Self>>

Source

pub unsafe fn textureNamed_assetResolver( name: &NSString, resolver: &ProtocolObject<dyn MDLAssetResolver>, ) -> Option<Retained<Self>>

Available on crate feature MDLAssetResolver only.

Source

pub unsafe fn textureCubeWithImagesNamed( names: &NSArray<NSString>, ) -> Option<Retained<Self>>

Creates a cube texture map image using 6 faces of the same dimensions, ordered +X,-X,+Y,-Y,+Z,-Z If the data is read back the image will be compacted into a single vertical stack where dimensions.y = 6 * dimensions.x isCube will return YES

Parameter names: a collection of mosaiced images in a cross formation or column or row.

If 6 individual images are given they are assumed to be in order and will be loaded as is.
if 3 images of double height or width are given they will be treated as pairs of + and - in each axis, the order is must be x, then y, then z.
if 2 images of triple height or width are given they will be treates as a positive set and a negative set in the order +x, +y, +z, then -x, -y, -z.
if a single image is given it will be used without conversion if in column orientation and demosaiced in all other instances.

Source

pub unsafe fn textureCubeWithImagesNamed_bundle( names: &NSArray<NSString>, bundle_or_nil: Option<&NSBundle>, ) -> Option<Retained<Self>>

Source §

impl MDLURLTexture

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = MDLTexture>§

Source

pub unsafe fn writeToURL(&self, url: &NSURL) -> bool

write a texture to URL, deducing type from path extension

Source

pub unsafe fn writeToURL_level(&self, url: &NSURL, level: NSUInteger) -> bool

write a particular level of a mipped texture to URL, deducing type from path extension

Source

pub unsafe fn writeToURL_type(&self, nsurl: &NSURL, type: &CFString) -> bool

Available on crate feature objc2-core-foundation only.

write a texture to URL, using a specific UT type

Source

pub unsafe fn writeToURL_type_level( &self, nsurl: &NSURL, type: &CFString, level: NSUInteger, ) -> bool

Available on crate feature objc2-core-foundation only.

write a particular level of a mipped texture to URL, using a specific UT type

Source

pub unsafe fn imageFromTexture(&self) -> Option<Retained<CGImage>>

Available on crate feature objc2-core-graphics only.

Source

pub unsafe fn imageFromTextureAtLevel( &self, level: NSUInteger, ) -> Option<Retained<CGImage>>

Available on crate feature objc2-core-graphics only.

Source

pub unsafe fn texelDataWithTopLeftOrigin(&self) -> Option<Retained<NSData>>

Source

pub unsafe fn texelDataWithBottomLeftOrigin(&self) -> Option<Retained<NSData>>

Source

pub unsafe fn texelDataWithTopLeftOriginAtMipLevel_create( &self, level: NSInteger, create: bool, ) -> Option<Retained<NSData>>

Source

pub unsafe fn texelDataWithBottomLeftOriginAtMipLevel_create( &self, level: NSInteger, create: bool, ) -> Option<Retained<NSData>>

Source

pub unsafe fn setIsCube(&self, is_cube: bool)

Setter for isCube.

Source

pub unsafe fn hasAlphaValues(&self) -> bool

hasAlphaValues Can be overridden. If not overridden, hasAlpha will be NO if the texture does not have an alpha channel. It wil be YES if the texture has an alpha channel and there is at least one non-opaque texel in it.

Source

pub unsafe fn setHasAlphaValues(&self, has_alpha_values: bool)

Setter for hasAlphaValues.

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