Struct MDLSkyCubeTexture 

pub struct MDLSkyCubeTexture { /* private fields */ }

Available on crate feature MDLTexture only.

MDLSkyCubeTexture A physically realistic sky as a cube texture

1.0 is at the nadir. Use in conjunction with turbidity to give a dawn, dusk, or noon look.

will impart very little color to the sky. A value of one simulates a great deal of dust and moisture in the sky, and will cause the sun’s color to spread across the atmosphere.

a value of one will give noon-ish saturated colors.

the sky from the ground. A value of zero will yield a clear sky, a value of one will reduce the contrast of the sky, making it a bit foggy.

by a color, horizonElevation is angle, in radians, below which the replacement should occur. Negative values are below the horizon.

the color below the horizonElevation value blended with the w factor up to Pi/2.0 past the horizon. (e.g. w = 0.0 groundColor is applied immediatly on the horizon with no blend w = Pi/2 groundColor is linearly applied all the way to the south pole) NOTE: To maintain default behavior a simple length(groundColor) != 0 is used to determine if we want to set the ground color (e.g. black and blended immediatly on the horizon use (0.0, 0.0, 0.0, 0.0000001)) 4 component treats the first 3 components as color and w as blend factor 3 component treats the first 3 components as color and 0 as blend factor 2 component treats the first component as greyscale color and y as blend factor 1 component treats the scalar component as greyscale color and 0 as blend factor

tone mapping.

are not compressed during tone mapping. Values between the x component and y component are compressed to the maximum brightness value during tone mapping. Values above the limit are clamped.

the texture will be created if data is referenced, otherwise, this object is merely a description. All parameters have legal values between zero and one.

See also Apple’s documentation

Implementations

impl MDLSkyCubeTexture

pub unsafe fn updateTexture(&self)

Call updateTexture if parameters have been changed and a new sky is required.

pub unsafe fn turbidity(&self) -> c_float

pub unsafe fn setTurbidity(&self, turbidity: c_float)

Setter for turbidity.

pub unsafe fn sunElevation(&self) -> c_float

pub unsafe fn setSunElevation(&self, sun_elevation: c_float)

Setter for sunElevation.

pub unsafe fn sunAzimuth(&self) -> c_float

pub unsafe fn setSunAzimuth(&self, sun_azimuth: c_float)

Setter for sunAzimuth.

pub unsafe fn upperAtmosphereScattering(&self) -> c_float

pub unsafe fn setUpperAtmosphereScattering( &self, upper_atmosphere_scattering: c_float, )

Setter for upperAtmosphereScattering.

pub unsafe fn groundAlbedo(&self) -> c_float

pub unsafe fn setGroundAlbedo(&self, ground_albedo: c_float)

Setter for groundAlbedo.

pub unsafe fn horizonElevation(&self) -> c_float

pub unsafe fn setHorizonElevation(&self, horizon_elevation: c_float)

Setter for horizonElevation.

pub unsafe fn groundColor(&self) -> Option<Retained<CGColor>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn setGroundColor(&self, ground_color: Option<&CGColor>)

Available on crate feature objc2-core-graphics only.

Setter for groundColor.

pub unsafe fn gamma(&self) -> c_float

pub unsafe fn setGamma(&self, gamma: c_float)

Setter for gamma.

pub unsafe fn exposure(&self) -> c_float

pub unsafe fn setExposure(&self, exposure: c_float)

Setter for exposure.

pub unsafe fn brightness(&self) -> c_float

pub unsafe fn setBrightness(&self, brightness: c_float)

Setter for brightness.

pub unsafe fn contrast(&self) -> c_float

pub unsafe fn setContrast(&self, contrast: c_float)

Setter for contrast.

pub unsafe fn saturation(&self) -> c_float

pub unsafe fn setSaturation(&self, saturation: c_float)

Setter for saturation.

impl MDLSkyCubeTexture

Methods declared on superclass MDLTexture.

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

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.

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

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

Available on crate feature MDLAssetResolver only.

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.

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

impl MDLSkyCubeTexture

Methods declared on superclass NSObject.

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

Methods from Deref<Target = MDLTexture>

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

write a texture to URL, deducing type from path extension

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

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

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

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

Available on crate feature objc2-core-graphics only.

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

Available on crate feature objc2-core-graphics only.

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

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

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

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

pub unsafe fn rowStride(&self) -> NSInteger

pub unsafe fn channelCount(&self) -> NSUInteger

pub unsafe fn mipLevelCount(&self) -> NSUInteger

pub unsafe fn channelEncoding(&self) -> MDLTextureChannelEncoding

pub unsafe fn isCube(&self) -> bool

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

Setter for isCube.

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.

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

Setter for hasAlphaValues.

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 MDLSkyCubeTexture

fn as_ref(&self) -> &AnyObject

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

impl AsRef<MDLSkyCubeTexture> for MDLSkyCubeTexture

fn as_ref(&self) -> &Self

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

impl AsRef<MDLTexture> for MDLSkyCubeTexture

fn as_ref(&self) -> &MDLTexture

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

impl AsRef<NSObject> for MDLSkyCubeTexture

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for MDLSkyCubeTexture

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<MDLTexture> for MDLSkyCubeTexture

fn borrow(&self) -> &MDLTexture

Immutably borrows from an owned value.

impl Borrow<NSObject> for MDLSkyCubeTexture

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for MDLSkyCubeTexture

const NAME: &'static str = "MDLSkyCubeTexture"

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

type Super = MDLTexture

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for MDLSkyCubeTexture

type Target = MDLTexture

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MDLSkyCubeTexture

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 MDLNamed for MDLSkyCubeTexture

unsafe fn name(&self) -> Retained<NSString>

where Self: Sized + Message,

Available on crate feature MDLTypes only.

unsafe fn setName(&self, name: &NSString)

where Self: Sized + Message,

Available on crate feature MDLTypes only.

Setter for name.

impl Message for MDLSkyCubeTexture

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for MDLSkyCubeTexture

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 MDLSkyCubeTexture

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 MDLSkyCubeTexture

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

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

impl DowncastTarget for MDLSkyCubeTexture

impl Eq for MDLSkyCubeTexture