Struct AVSynchronizedLayer

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

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

Apple’s documentation

Implementations

impl AVSynchronizedLayer

pub unsafe fn synchronizedLayerWithPlayerItem( player_item: &AVPlayerItem, ) -> Retained<AVSynchronizedLayer>

Available on crate feature AVPlayerItem only.

Returns an instance of AVSynchronizedLayer with timing synchronized with the specified AVPlayerItem.

Returns: An instance of AVSynchronizedLayer.

pub unsafe fn playerItem( &self, mtm: MainThreadMarker, ) -> Option<Retained<AVPlayerItem>>

Available on crate feature AVPlayerItem only.

Indicates the instance of AVPlayerItem to which the timing of the AVSynchronizedLayer is synchronized.

Before macOS 13, iOS 16, tvOS 16, and watchOS 9, this property must be accessed on the main thread/queue.

pub unsafe fn setPlayerItem( &self, player_item: Option<&AVPlayerItem>, mtm: MainThreadMarker, )

Available on crate feature AVPlayerItem only.

Setter for playerItem.

impl AVSynchronizedLayer

Methods declared on superclass CALayer.

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

Layer creation and initialization. *

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

pub unsafe fn initWithLayer( this: Allocated<Self>, layer: &AnyObject, ) -> Retained<Self>

impl AVSynchronizedLayer

Methods declared on superclass NSObject.

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

Methods from Deref<Target = CALayer>

pub unsafe fn presentationLayer(&self) -> Option<Retained<CALayer>>

pub unsafe fn modelLayer(&self) -> Retained<CALayer>

pub unsafe fn shouldArchiveValueForKey(&self, key: &NSString) -> bool

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

pub fn isDoubleSided(&self) -> bool

pub fn setDoubleSided(&self, double_sided: bool)

Setter for isDoubleSided.

pub fn isGeometryFlipped(&self) -> bool

pub fn setGeometryFlipped(&self, geometry_flipped: bool)

Setter for isGeometryFlipped.

pub fn contentsAreFlipped(&self) -> bool

pub fn superlayer(&self) -> Option<Retained<CALayer>>

pub fn removeFromSuperlayer(&self)

pub unsafe fn sublayers(&self) -> Option<Retained<NSArray<CALayer>>>

pub unsafe fn setSublayers(&self, sublayers: Option<&NSArray<CALayer>>)

Setter for sublayers.

pub fn addSublayer(&self, layer: &CALayer)

pub fn insertSublayer_atIndex(&self, layer: &CALayer, idx: u32)

pub fn insertSublayer_below(&self, layer: &CALayer, sibling: Option<&CALayer>)

pub fn insertSublayer_above(&self, layer: &CALayer, sibling: Option<&CALayer>)

pub unsafe fn replaceSublayer_with( &self, old_layer: &CALayer, new_layer: &CALayer, )

pub fn mask(&self) -> Option<Retained<CALayer>>

pub unsafe fn setMask(&self, mask: Option<&CALayer>)

Setter for mask.

pub fn masksToBounds(&self) -> bool

pub fn setMasksToBounds(&self, masks_to_bounds: bool)

Setter for masksToBounds.

pub unsafe fn contents(&self) -> Option<Retained<AnyObject>>

Layer content properties and methods. *

pub unsafe fn setContents(&self, contents: Option<&AnyObject>)

Setter for contents.

pub fn contentsGravity(&self) -> Retained<NSString>

pub fn setContentsGravity(&self, contents_gravity: &NSString)

Setter for contentsGravity.

pub fn contentsFormat(&self) -> Retained<NSString>

pub fn setContentsFormat(&self, contents_format: &NSString)

Setter for contentsFormat.

pub unsafe fn wantsExtendedDynamicRangeContent(&self) -> bool

pub unsafe fn setWantsExtendedDynamicRangeContent( &self, wants_extended_dynamic_range_content: bool, )

Setter for wantsExtendedDynamicRangeContent.

pub unsafe fn toneMapMode(&self) -> Retained<NSString>

pub unsafe fn setToneMapMode(&self, tone_map_mode: &NSString)

Setter for toneMapMode.

pub unsafe fn wantsDynamicContentScaling(&self) -> bool

pub unsafe fn setWantsDynamicContentScaling( &self, wants_dynamic_content_scaling: bool, )

Setter for wantsDynamicContentScaling.

pub fn minificationFilter(&self) -> Retained<NSString>

pub fn setMinificationFilter(&self, minification_filter: &NSString)

Setter for minificationFilter.

pub fn magnificationFilter(&self) -> Retained<NSString>

pub fn setMagnificationFilter(&self, magnification_filter: &NSString)

Setter for magnificationFilter.

pub fn minificationFilterBias(&self) -> f32

pub fn setMinificationFilterBias(&self, minification_filter_bias: f32)

Setter for minificationFilterBias.

pub fn isOpaque(&self) -> bool

pub fn setOpaque(&self, opaque: bool)

Setter for isOpaque.

pub fn display(&self)

pub fn setNeedsDisplay(&self)

pub fn needsDisplay(&self) -> bool

pub fn displayIfNeeded(&self)

pub fn needsDisplayOnBoundsChange(&self) -> bool

pub fn setNeedsDisplayOnBoundsChange( &self, needs_display_on_bounds_change: bool, )

Setter for needsDisplayOnBoundsChange.

pub fn drawsAsynchronously(&self) -> bool

pub fn setDrawsAsynchronously(&self, draws_asynchronously: bool)

Setter for drawsAsynchronously.

pub fn edgeAntialiasingMask(&self) -> CAEdgeAntialiasingMask

pub fn setEdgeAntialiasingMask( &self, edge_antialiasing_mask: CAEdgeAntialiasingMask, )

Setter for edgeAntialiasingMask.

pub fn allowsEdgeAntialiasing(&self) -> bool

pub fn setAllowsEdgeAntialiasing(&self, allows_edge_antialiasing: bool)

Setter for allowsEdgeAntialiasing.

pub fn maskedCorners(&self) -> CACornerMask

pub fn setMaskedCorners(&self, masked_corners: CACornerMask)

Setter for maskedCorners.

pub fn cornerCurve(&self) -> Retained<NSString>

pub fn setCornerCurve(&self, corner_curve: &NSString)

Setter for cornerCurve.

pub fn opacity(&self) -> f32

pub fn setOpacity(&self, opacity: f32)

Setter for opacity.

pub fn allowsGroupOpacity(&self) -> bool

pub fn setAllowsGroupOpacity(&self, allows_group_opacity: bool)

Setter for allowsGroupOpacity.

pub unsafe fn compositingFilter(&self) -> Option<Retained<AnyObject>>

pub unsafe fn setCompositingFilter( &self, compositing_filter: Option<&AnyObject>, )

Setter for compositingFilter.

pub unsafe fn filters(&self) -> Option<Retained<NSArray>>

pub unsafe fn setFilters(&self, filters: Option<&NSArray>)

Setter for filters.

pub unsafe fn backgroundFilters(&self) -> Option<Retained<NSArray>>

pub unsafe fn setBackgroundFilters(&self, background_filters: Option<&NSArray>)

Setter for backgroundFilters.

pub fn shouldRasterize(&self) -> bool

pub fn setShouldRasterize(&self, should_rasterize: bool)

Setter for shouldRasterize.

pub fn shadowOpacity(&self) -> f32

pub fn setShadowOpacity(&self, shadow_opacity: f32)

Setter for shadowOpacity.

pub fn autoresizingMask(&self) -> CAAutoresizingMask

Layout methods. *

pub fn setAutoresizingMask(&self, autoresizing_mask: CAAutoresizingMask)

Setter for autoresizingMask.

pub fn layoutManager( &self, ) -> Option<Retained<ProtocolObject<dyn CALayoutManager>>>

pub fn setLayoutManager( &self, layout_manager: Option<&ProtocolObject<dyn CALayoutManager>>, )

Setter for layoutManager.

pub fn setNeedsLayout(&self)

pub fn needsLayout(&self) -> bool

pub fn layoutIfNeeded(&self)

pub fn layoutSublayers(&self)

pub fn actionForKey( &self, event: &NSString, ) -> Option<Retained<ProtocolObject<dyn CAAction>>>

pub fn actions( &self, ) -> Option<Retained<NSDictionary<NSString, ProtocolObject<dyn CAAction>>>>

pub fn setActions( &self, actions: Option<&NSDictionary<NSString, ProtocolObject<dyn CAAction>>>, )

Setter for actions.

pub fn removeAllAnimations(&self)

pub fn removeAnimationForKey(&self, key: &NSString)

pub fn animationKeys(&self) -> Option<Retained<NSArray<NSString>>>

pub fn name(&self) -> Option<Retained<NSString>>

Miscellaneous properties. *

pub fn setName(&self, name: Option<&NSString>)

Setter for name.

pub fn delegate(&self) -> Option<Retained<ProtocolObject<dyn CALayerDelegate>>>

pub fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn CALayerDelegate>>, )

This is a weak property. Setter for delegate.

pub unsafe fn style(&self) -> Option<Retained<NSDictionary>>

pub unsafe fn setStyle(&self, style: Option<&NSDictionary>)

Setter for style.

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<AVSynchronizedLayer> for AVSynchronizedLayer

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVSynchronizedLayer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CALayer> for AVSynchronizedLayer

fn as_ref(&self) -> &CALayer

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

impl AsRef<NSObject> for AVSynchronizedLayer

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for AVSynchronizedLayer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CALayer> for AVSynchronizedLayer

fn borrow(&self) -> &CALayer

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVSynchronizedLayer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl CAMediaTiming for AVSynchronizedLayer

unsafe fn speed(&self) -> f32

where Self: Sized + Message,

unsafe fn setSpeed(&self, speed: f32)

where Self: Sized + Message,

Setter for speed.

unsafe fn repeatCount(&self) -> f32

where Self: Sized + Message,

unsafe fn setRepeatCount(&self, repeat_count: f32)

where Self: Sized + Message,

Setter for repeatCount.

unsafe fn autoreverses(&self) -> bool

where Self: Sized + Message,

unsafe fn setAutoreverses(&self, autoreverses: bool)

where Self: Sized + Message,

Setter for autoreverses.

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

where Self: Sized + Message,

unsafe fn setFillMode(&self, fill_mode: &NSString)

where Self: Sized + Message,

Setter for fillMode.

impl ClassType for AVSynchronizedLayer

const NAME: &'static str = "AVSynchronizedLayer"

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

type Super = CALayer

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for AVSynchronizedLayer

type Target = CALayer

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVSynchronizedLayer

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 AVSynchronizedLayer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for AVSynchronizedLayer

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSObjectProtocol for AVSynchronizedLayer

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 AVSynchronizedLayer

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for AVSynchronizedLayer

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 AVSynchronizedLayer

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

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

impl DowncastTarget for AVSynchronizedLayer

impl Eq for AVSynchronizedLayer