Struct SKTexture 

pub struct SKTexture { /* private fields */ }

Available on crate feature SKTexture only.

A texture to be mapped onto SKSpriteNode instances.

See also Apple’s documentation

Implementations

impl SKTexture

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

Create a texture from an image file. Behaves similar to imageNamed: in UIImage or NSImage

Parameter name: the name or path of the image to load.

pub unsafe fn textureWithRect_inTexture( rect: CGRect, texture: &SKTexture, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a texture that is a subrect of an existing texture. See textureRect property for details.

Parameter rect: the source rectangle to use in creating a logical copy of the given texture.

Parameter texture: the existing texture to reference in the copy.

pub unsafe fn textureVectorNoiseWithSmoothness_size( smoothness: CGFloat, size: CGSize, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a texture containing directional noise. The RGBA values in this texture can be used as a normal map or as direction possibly with length. XYZ are a three dimensional direction, and A is a magnitude.

Parameter size: the size of the resulting texture.

Parameter smoothness: how similar neighboring pixels are. A value of zero is like static, one is smooth.

pub unsafe fn textureNoiseWithSmoothness_size_grayscale( smoothness: CGFloat, size: CGSize, grayscale: bool, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create a texture containing colored noise. The noise texture is tileable with itself.

Parameter size: the size of the resulting texture.

Parameter smoothness: how similar neighboring pixels are. A value of zero is like static, one is smooth.

Parameter grayscale: if YES, RGB and A will all be the same. If no, RGB and A will all be different. A is not pre-multiplied, because the intent is that if you read a texel in a shader, all four values will be exactly the same value if grayscale, or four different, uncorrelated values if not grayscale.

pub unsafe fn textureWithCGImage(image: &CGImage) -> Retained<Self>

Available on crate feature objc2-core-graphics only.

Create a texture from a CGImageRef.

Parameter image: the CGImageRef to create the texture from

pub unsafe fn textureWithImage(image: &NSImage) -> Retained<Self>

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

pub unsafe fn textureWithData_size( pixel_data: &NSData, size: CGSize, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create new texture with bitmap RGBA data in unsigned bytes. Data is copied once, additional changes to the data does not affect the texture. All pixel data is assumed to be premultiplied alpha.

Parameter pixelData: the pixelData to read in creating the texture.

Parameter size: the dimensions of the pixelData given.

pub unsafe fn textureWithData_size_flipped( pixel_data: &NSData, size: CGSize, flipped: bool, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

pub unsafe fn textureWithData_size_rowLength_alignment( pixel_data: &NSData, size: CGSize, row_length: c_uint, alignment: c_uint, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create new texture with bitmap RGBA data in unsigned bytes using a custom row length and row alignment. Data is copied once, additional changes to the data does not affect the texture. All pixel data is assumed to be premultiplied alpha.

Parameter pixelData: the data to use

Parameter size: the size in texels

Parameter rowLength: the length of each row in pixels (allows byte row pitches greater than the width for aligned data)

Parameter alignment: the byte alignment of the data, provide 0 for tightly packed data.

pub unsafe fn textureByApplyingCIFilter( &self, filter: &CIFilter, ) -> Retained<Self>

Available on crate feature objc2-core-image and non-watchOS only.

Create new texture by applying a CIFilter to an existing one. Any CIFilter that requires only a single “inputImage” and produces an “outputImage” is allowed.

Parameter filter: the CI filter to apply in the copy.

pub unsafe fn textureByGeneratingNormalMap(&self) -> Retained<Self>

Create new texture by generating a normal map texture.

pub unsafe fn textureByGeneratingNormalMapWithSmoothness_contrast( &self, smoothness: CGFloat, contrast: CGFloat, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Create new texture by generating a normal map texture.

Parameter smoothness: the smooth level of the generated normal map.

Parameter contrast: the scale applied to the generated normal map.

pub unsafe fn textureRect(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

Used to choose the area of the texture you want to display. The origin and size should both be in the range 0.0 - 1.0, values outside of this range produces unpredictable results. Defaults to the entire texture {(0,0) (1,1)}.

pub unsafe fn size(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The size of the texture’s bitmap data in points.

pub unsafe fn filteringMode(&self) -> SKTextureFilteringMode

The filtering mode the texture should use when not drawn at native size. Defaults to SKTextureFilteringLinear.

pub unsafe fn setFilteringMode(&self, filtering_mode: SKTextureFilteringMode)

Setter for filteringMode.

pub unsafe fn usesMipmaps(&self) -> bool

Request that the texture have mipmaps generated if possible. Only supported for power of 2 texture sizes.

pub unsafe fn setUsesMipmaps(&self, uses_mipmaps: bool)

Setter for usesMipmaps.

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

Available on crate feature objc2-core-graphics only.

Convert the current SKTexture into a CGImageRef object

pub unsafe fn preloadTextures_withCompletionHandler( textures: &NSArray<SKTexture>, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

Start a texture preload operation on an array of textures

Parameter textures: an array of SKTextures to be preloaded

Parameter completionHandler: will be called upon the preload completion

pub unsafe fn preloadWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn()>, )

Available on crate feature block2 only.

Request that this texture be loaded into vram on the next render update, with a callback handler.

impl SKTexture

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 SKTexture

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SKTexture

fn as_ref(&self) -> &NSObject

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

impl AsRef<SKTexture> for SKMutableTexture

Available on crate feature SKMutableTexture only.

fn as_ref(&self) -> &SKTexture

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

impl AsRef<SKTexture> for SKTexture

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SKTexture

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SKTexture

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<SKTexture> for SKMutableTexture

Available on crate feature SKMutableTexture only.

fn borrow(&self) -> &SKTexture

Immutably borrows from an owned value.

impl ClassType for SKTexture

const NAME: &'static str = "SKTexture"

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

type Super = NSObject

The superclass of this class.

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

type Result = SKTexture

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

impl Debug for SKTexture

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

Formats the value using the given formatter.

impl Deref for SKTexture

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SKTexture

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 SKTexture

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for SKTexture

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSCopying for SKTexture

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 SKTexture

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 NSSecureCoding for SKTexture

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for SKTexture

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 SKTexture

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

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

impl DowncastTarget for SKTexture

impl Eq for SKTexture