Struct MTKTextureLoader

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

Available on crate feature MTKTextureLoader only.

Load Metal textures from files with the device specified at initialization

See also Apple’s documentation

Implementations

impl MTKTextureLoader

pub unsafe fn device(&self) -> Retained<ProtocolObject<dyn MTLDevice>>

Metal device with which to create Metal textures

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

pub unsafe fn initWithDevice( this: Allocated<Self>, device: &ProtocolObject<dyn MTLDevice>, ) -> Retained<Self>

Initialize the loader

Parameter device: Metal device with which to create Metal textures

pub unsafe fn newTextureWithContentsOfURL_options_completionHandler( &self, url: &NSURL, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderCallback, )

Available on crate feature block2 only.

Asynchronously create a Metal texture and load image data from the file at URL

Parameter URL: Location of image file from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter completionHandler: Block called when the texture has been loaded and fully initialized

pub unsafe fn newTextureWithName_scaleFactor_bundle_options_completionHandler( &self, name: &NSString, scale_factor: CGFloat, bundle: Option<&NSBundle>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderCallback, )

Available on crate features block2 and objc2-core-foundation only.

Asynchronously create a Metal texture and load image data from a given texture or image asset name

Parameter name: A texture or image asset name

Parameter scaleFactor: scale factor of the texture to retrieve from the asset catalog. Typically the value retrieved from -[UIView contentScale] or -[NSWindow backingScaleFactor].

Parameter bundle: Resource bundle in which the asset is located. Main bundle used if nil.

Parameter options: Dictonary of MTKTextureLoaderOptions. The following options are ignormed when used to load a texture asset but can be used when creating a texture from an image asset: MTKTextureLoaderOptionGenerateMipmaps MTKTextureLoaderOptionSRGB MTKTextureLoaderOptionCubeFromVerticalTexture MTKTextureLoaderOptionOrigin

Parameter completionHandler: Block called when texture has been loaded and fully initialized

Uses texture data from version of the texture from the texture set in the asset catalog which mathces the device’s traits. This method attempts to load a texture asset with thw name iven. If a texture asset with the name given does not exist, it will attempt to create a texture from an image asset with the given name

pub unsafe fn newTextureWithName_scaleFactor_displayGamut_bundle_options_completionHandler( &self, name: &NSString, scale_factor: CGFloat, display_gamut: NSDisplayGamut, bundle: Option<&NSBundle>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderCallback, )

Available on crate feature block2 and crate feature objc2-app-kit and crate feature objc2-core-foundation and macOS only.

Asynchronously create a Metal texture and load image data from a given texture or image asset name

Parameter name: A texture or image asset name

Parameter scaleFactor: Scale factor of the texture to retrieve from the asset catalog. Typically the value retrieved from -[NSWindow backingScaleFactor].

Parameter displayGamut: Version of the texture based upon the “Gamut” trait in Xcode. You’d typically check -[NSWindow canRepresentDisplayGamut:] with the widest NSDisplayGamut value and pass that value here if it returns YES.

Parameter bundle: Resource bundle in which the asset is located. Main bundle used if nil.

Parameter options: Dictonary of MTKTextureLoaderOptions. The following options are ignormed when used to load a texture asset but can be used when creating a texture from an image asset: MTKTextureLoaderOptionGenerateMipmaps MTKTextureLoaderOptionSRGB MTKTextureLoaderOptionCubeFromVerticalTexture MTKTextureLoaderOptionOrigin

Parameter completionHandler: Block called when texture has been loaded and fully initialized

Uses texture data from version of the texture from the texture set in the asset catalog which mathces the device’s traits. This method attempts to load a texture asset with the name given. If a texture asset with the name given does not exist, it will attempt to create a texture from an image asset with the given name. This method can be used on macOS to choose between sRGB and P3 versions of a texture asset depending on the gamut of the display rendered to.

pub unsafe fn newTexturesWithContentsOfURLs_options_completionHandler( &self, ur_ls: &NSArray<NSURL>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderArrayCallback, )

Available on crate feature block2 only.

Asynchronously create an array of Metal textures and load image data from the files at URLs

Parameter URLs: Locations of image files from which to create the textures

Parameter options: Dictonary of MTKTextureLoaderOptions, which will be used for every texture loaded

Parameter completionHandler: Block called when all of the textures have been loaded and fully initialized. The array of MTLTextures will be the same length and in the same order as the requested array of paths. If an error occurs while loading a texture, the corresponding array index will contain NSNull. The NSError will be null if all of the textures are loaded successfully, or will correspond to one of the textures which failed to load.

pub unsafe fn newTexturesWithNames_scaleFactor_bundle_options_completionHandler( &self, names: &NSArray<NSString>, scale_factor: CGFloat, bundle: Option<&NSBundle>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderArrayCallback, )

Available on crate features block2 and objc2-core-foundation only.

Asynchronously create Metal textures and load image data from a given texture or image asset names

Parameter names: An array texture or image asset names. If an error occurs while loading a texture, the corresponding index in the returned array contain [NSNull null]

Parameter scaleFactor: scale factor of the texture to retrieve from the asset catalog. Typically the value retrieved from -[UIView contentScale] or -[NSWindow backingScaleFactor].

Parameter bundle: Resource bundle in which the assets are located. Main bundle used if nil.

Parameter options: Dictonary of MTKTextureLoaderOptions. The following options are ignormed when used to load a texture asset but can be used when creating a texture from an image asset MTKTextureLoaderOptionGenerateMipmaps MTKTextureLoaderOptionSRGB MTKTextureLoaderOptionCubeFromVerticalTexture MTKTextureLoaderOptionOrigin

Parameter completionHandler: Block called when all of the textures have been loaded and fully initialized. The NSError will be null if all of the textures are loaded successfully, or will correspond to one of the textures which failed to load.

Uses texture data from version of the texture from the texture set in the asset catalog which mathces the device’s traits. This method attempts to load a texture asset with each name iven. If a texture asset with the name given does not exist, it will attempt to create a texture from an image asset with the given name.

pub unsafe fn newTexturesWithNames_scaleFactor_displayGamut_bundle_options_completionHandler( &self, names: &NSArray<NSString>, scale_factor: CGFloat, display_gamut: NSDisplayGamut, bundle: Option<&NSBundle>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderArrayCallback, )

Available on crate feature block2 and crate feature objc2-app-kit and crate feature objc2-core-foundation and macOS only.

Asynchronously create Metal textures and load image data from given texture or image asset names

Parameter names: An array texture or image asset names. If an error occurs while loading a texture, the corresponding index in the returned array contain [NSNull null]

Parameter scaleFactor: Scale factor of the texture to retrieve from the asset catalog. Typically the value retrieved from -[UIView contentScale] or -[NSWindow backingScaleFactor]

Parameter displayGamut: Version of the texture based upon the “Gamut” trait in Xcode. You’d typically check -[NSWindow canRepresentDisplayGamut:] with the widest NSDisplayGamut value and pass that value here if it returns YES.

Parameter bundle: Resource bundle in which the assets are located

Parameter options: Dictonary of MTKTextureLoaderOptions. The following options are ignormed when used to load a texture asset but can be used when creating a texture from an image asset MTKTextureLoaderOptionGenerateMipmaps MTKTextureLoaderOptionSRGB MTKTextureLoaderOptionCubeFromVerticalTexture MTKTextureLoaderOptionOrigin

Parameter completionHandler: Block called when all of the textures have been loaded and fully initialized. The NSError will be nif if all of the textures are loaded successfully, or will correspond to one of the textures which failed to load.

Uses texture data from version of the texture from the texture sets in the asset catalog which mathces the device’s traits. This method attempts to load a texture asset with each name given. If a texture asset with the name given does not exist, it will attempt to create a texture from an image asset with the given name. This method can be used on macOS to choose between sRGB and P3 versions of a texture asset depending on the gamut of the display rendered to, If a texture with a name fails to load, the correposding index in the returned array will be set to [NSNull null]. An error will also be set. Thus, if there is a failure to load a texture with a name, other names may succesfully be loaded. Also, a set error does not necessarily mean all textures in the names array have failed to load.

pub unsafe fn newTextureWithData_options_completionHandler( &self, data: &NSData, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderCallback, )

Available on crate feature block2 only.

Asynchronously create a Metal texture and load image data from the NSData object provided

Parameter data: NSData object containing image file data from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter completionHandler: Block called when texture has been loaded and fully initialized

pub unsafe fn newTextureWithCGImage_options_completionHandler( &self, cg_image: &CGImage, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderCallback, )

Available on crate features block2 and objc2-core-graphics only.

Asynchronously create a Metal texture and load image data from the given CGImageRef

Parameter cgImage: CGImageRef containing image data from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter completionHandler: Block called when texture has been loaded and fully initialized

pub unsafe fn newTextureWithMDLTexture_options_completionHandler( &self, texture: &MDLTexture, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, completion_handler: MTKTextureLoaderCallback, )

Available on crate features block2 and objc2-model-io only.

Asynchronously create a Metal texture and load image data from the given MDLTexture

Parameter texture: MDLTexture containing image data from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter completionHandler: Block called when texture has been loaded and fully initialized

pub unsafe fn newTextureWithContentsOfURL_options_error( &self, url: &NSURL, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, ) -> Result<Retained<ProtocolObject<dyn MTLTexture>>, Retained<NSError>>

Synchronously create a Metal texture and load image data from the file at URL

Returns: The Metal texture. nil if an error occured

Parameter URL: Location of image file from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter error: Pointer to an autoreleased NSError object which will be set if an error occurred

pub unsafe fn newTextureWithData_options_error( &self, data: &NSData, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, ) -> Result<Retained<ProtocolObject<dyn MTLTexture>>, Retained<NSError>>

Synchronously create a Metal texture and load image data from the NSData object provided

Returns: The Metal texture. nil if an error occured

Parameter data: NSData object containing image file data from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter error: Pointer to an autoreleased NSError object which will be set if an error occurred

pub unsafe fn newTextureWithCGImage_options_error( &self, cg_image: &CGImage, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, ) -> Result<Retained<ProtocolObject<dyn MTLTexture>>, Retained<NSError>>

Available on crate feature objc2-core-graphics only.

Synchronously create a Metal texture and load image data from the given CGImageRef

Returns: The Metal texture. nil if an error occured

Parameter cgImage: CGImageRef containing image data from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter error: Pointer to an autoreleased NSError object which will be set if an error occurred

pub unsafe fn newTextureWithMDLTexture_options_error( &self, texture: &MDLTexture, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, ) -> Result<Retained<ProtocolObject<dyn MTLTexture>>, Retained<NSError>>

Available on crate feature objc2-model-io only.

Synchronously create a Metal texture and load image data from the given MDLTexture

Returns: The Metal texture. nil if an error occured

Parameter texture: MDLTexture containing image data from which to create the texture

Parameter options: Dictonary of MTKTextureLoaderOptions

Parameter error: Pointer to an autoreleased NSError object which will be set if an error occurred

pub unsafe fn newTextureWithName_scaleFactor_bundle_options_error( &self, name: &NSString, scale_factor: CGFloat, bundle: Option<&NSBundle>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, ) -> Result<Retained<ProtocolObject<dyn MTLTexture>>, Retained<NSError>>

Available on crate feature objc2-core-foundation only.

Synchronously create a Metal texture with texture data from a given texture or image asset name

Returns: The Metal texture. nil if an error occured

Parameter names: An array of texture asset names

Parameter scaleFactor: scale factor of the texture to retrieve from the asset catalog. Typically the value retrieved from -[UIView contentScale] or -[NSWindow backingScaleFactor].

Parameter bundle: Resource bundle in which the asset is located. Main bundle used if nil.

Parameter options: Dictonary of MTKTextureLoaderOptions. The following options are ignormed when used to load a texture asset but can be used when creating a texture from an image asset MTKTextureLoaderOptionGenerateMipmaps MTKTextureLoaderOptionSRGB MTKTextureLoaderOptionCubeFromVerticalTexture MTKTextureLoaderOptionOrigins

Uses texture data from version of the texture from the texture set in the asset catalog which mathces the device’s traits. This method attempts to load a texture asset with the name given. If a texture asset with the name given does not exist, it will attempt to create a texture from an image asset with the given name.

pub unsafe fn newTextureWithName_scaleFactor_displayGamut_bundle_options_error( &self, name: &NSString, scale_factor: CGFloat, display_gamut: NSDisplayGamut, bundle: Option<&NSBundle>, options: Option<&NSDictionary<MTKTextureLoaderOption, AnyObject>>, ) -> Result<Retained<ProtocolObject<dyn MTLTexture>>, Retained<NSError>>

Available on crate feature objc2-app-kit and crate feature objc2-core-foundation and macOS only.

Synchronously create a Metal texture with texture data from a given texture or image asset name

Returns: The Metal texture. nil if an error occured

Parameter names: An array of texture asset names

Parameter scaleFactor: Scale factor of the texture to retrieve from the asset catalog. Typically the value retrieved from -[UIView contentScale] or -[NSWindow backingScaleFactor].

Parameter displayGamut: Version of the texture based upon the “Gamut” trait in Xcode. You’d typically check -[NSWindow canRepresentDisplayGamut:] with the widest NSDisplayGamut value and pass that value here if it returns YES.

Parameter bundle: Resource bundle in which the assets are located

Parameter bundle: Resource bundle in which the asset is located. Main bundle used if nil.

Parameter options: Dictonary of MTKTextureLoaderOptions. The following options are ignormed when used to load a texture asset but can be used when creating a texture from an image asset MTKTextureLoaderOptionGenerateMipmaps MTKTextureLoaderOptionSRGB MTKTextureLoaderOptionCubeFromVerticalTexture MTKTextureLoaderOptionOrigin

Uses texture data from version of the texture from the texture set in the asset catalog which mathces the device’s traits. This method attempts to load a texture asset with the name given. If a texture asset with the name given does not exist, it will attempt to create a texture from an image asset with the given name. This method can be used on macOS to choose between sRGB and P3 versions of a texture asset depending on the gamut of the display rendered to.

impl MTKTextureLoader

Methods declared on superclass NSObject.

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.

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 MTKTextureLoader

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MTKTextureLoader> for MTKTextureLoader

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for MTKTextureLoader

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MTKTextureLoader

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for MTKTextureLoader

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MTKTextureLoader

const NAME: &'static str = "MTKTextureLoader"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MTKTextureLoader

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MTKTextureLoader

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 MTKTextureLoader

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MTKTextureLoader

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 MTKTextureLoader

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 MTKTextureLoader

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

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

impl DowncastTarget for MTKTextureLoader

impl Eq for MTKTextureLoader