Struct GLKEffectPropertyLight 

pub struct GLKEffectPropertyLight { /* private fields */ }

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate features GLKEffectProperty and GLKEffectPropertyLight only.

Apple’s documentation

Implementations

impl GLKEffectPropertyLight

pub unsafe fn enabled(&self) -> u8

👎Deprecated: The OpenGL API is deprecated by Apple

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

pub unsafe fn setEnabled(&self, enabled: u8)

👎Deprecated: The OpenGL API is deprecated by Apple

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

Setter for enabled.

pub unsafe fn position(&self) -> GLKVector4

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

pub unsafe fn setPosition(&self, position: GLKVector4)

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

Setter for position.

pub unsafe fn ambientColor(&self) -> GLKVector4

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

pub unsafe fn setAmbientColor(&self, ambient_color: GLKVector4)

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

Setter for ambientColor.

pub unsafe fn diffuseColor(&self) -> GLKVector4

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

pub unsafe fn setDiffuseColor(&self, diffuse_color: GLKVector4)

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

Setter for diffuseColor.

pub unsafe fn specularColor(&self) -> GLKVector4

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

pub unsafe fn setSpecularColor(&self, specular_color: GLKVector4)

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

Setter for specularColor.

pub unsafe fn spotDirection(&self) -> GLKVector3

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

pub unsafe fn setSpotDirection(&self, spot_direction: GLKVector3)

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKMathTypes only.

Setter for spotDirection.

pub unsafe fn spotExponent(&self) -> c_float

👎Deprecated: The OpenGL API is deprecated by Apple

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

pub unsafe fn setSpotExponent(&self, spot_exponent: c_float)

👎Deprecated: The OpenGL API is deprecated by Apple

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

Setter for spotExponent.

pub unsafe fn spotCutoff(&self) -> c_float

👎Deprecated: The OpenGL API is deprecated by Apple

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

pub unsafe fn setSpotCutoff(&self, spot_cutoff: c_float)

👎Deprecated: The OpenGL API is deprecated by Apple

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

Setter for spotCutoff.

pub unsafe fn constantAttenuation(&self) -> c_float

👎Deprecated: The OpenGL API is deprecated by Apple

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

pub unsafe fn setConstantAttenuation(&self, constant_attenuation: c_float)

👎Deprecated: The OpenGL API is deprecated by Apple

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

Setter for constantAttenuation.

pub unsafe fn linearAttenuation(&self) -> c_float

👎Deprecated: The OpenGL API is deprecated by Apple

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

pub unsafe fn setLinearAttenuation(&self, linear_attenuation: c_float)

👎Deprecated: The OpenGL API is deprecated by Apple

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

Setter for linearAttenuation.

pub unsafe fn quadraticAttenuation(&self) -> c_float

👎Deprecated: The OpenGL API is deprecated by Apple

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

pub unsafe fn setQuadraticAttenuation(&self, quadratic_attenuation: c_float)

👎Deprecated: The OpenGL API is deprecated by Apple

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

Setter for quadraticAttenuation.

pub unsafe fn transform(&self) -> Retained<GLKEffectPropertyTransform>

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKEffectPropertyTransform only.

pub unsafe fn setTransform(&self, transform: &GLKEffectPropertyTransform)

👎Deprecated: The OpenGL API is deprecated by Apple

Available on crate feature GLKEffectPropertyTransform only.

Setter for transform.

impl GLKEffectPropertyLight

Methods declared on superclass NSObject.

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

👎Deprecated: The OpenGL API is deprecated by Apple

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

👎Deprecated: The OpenGL API is deprecated by Apple

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 GLKEffectPropertyLight

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GLKEffectProperty> for GLKEffectPropertyLight

fn as_ref(&self) -> &GLKEffectProperty

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

impl AsRef<GLKEffectPropertyLight> for GLKEffectPropertyLight

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GLKEffectPropertyLight

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GLKEffectPropertyLight

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GLKEffectProperty> for GLKEffectPropertyLight

fn borrow(&self) -> &GLKEffectProperty

Immutably borrows from an owned value.

impl Borrow<NSObject> for GLKEffectPropertyLight

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GLKEffectPropertyLight

const NAME: &'static str = "GLKEffectPropertyLight"

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

type Super = GLKEffectProperty

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for GLKEffectPropertyLight

type Target = GLKEffectProperty

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GLKEffectPropertyLight

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 GLKEffectPropertyLight

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GLKEffectPropertyLight

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 GLKEffectPropertyLight

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 GLKEffectPropertyLight

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

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

impl DowncastTarget for GLKEffectPropertyLight

impl Eq for GLKEffectPropertyLight