Struct CIRenderDestination

Source

pub struct CIRenderDestination { /* private fields */ }

Available on crate feature CIRenderDestination only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CIRenderDestination

Source

pub unsafe fn initWithPixelBuffer( this: Allocated<Self>, pixel_buffer: &CVPixelBuffer, ) -> Retained<Self>

Available on crate feature objc2-core-video only.

Source

pub unsafe fn initWithIOSurface( this: Allocated<Self>, surface: &IOSurface, ) -> Retained<Self>

Available on crate feature objc2-io-surface only.

Source

pub unsafe fn initWithMTLTexture_commandBuffer( this: Allocated<Self>, texture: &ProtocolObject<dyn MTLTexture>, command_buffer: Option<&ProtocolObject<dyn MTLCommandBuffer>>, ) -> Retained<Self>

Available on crate feature objc2-metal only.

§Safety

texture may need to be synchronized.
texture may be unretained, you must ensure it is kept alive while in use.

Source

pub unsafe fn initWithWidth_height_pixelFormat_commandBuffer_mtlTextureProvider( this: Allocated<Self>, width: NSUInteger, height: NSUInteger, pixel_format: MTLPixelFormat, command_buffer: Option<&ProtocolObject<dyn MTLCommandBuffer>>, block: Option<&DynBlock<dyn Fn() -> NonNull<ProtocolObject<dyn MTLTexture>>>>, ) -> Retained<Self>

Available on crate features block2 and objc2-metal only.

§Safety

block block’s return must be a valid pointer.

Source

pub unsafe fn initWithGLTexture_target_width_height( this: Allocated<Self>, texture: c_uint, target: c_uint, width: NSUInteger, height: NSUInteger, ) -> Retained<Self>

Source

pub unsafe fn initWithBitmapData_width_height_bytesPerRow_format( this: Allocated<Self>, data: NonNull<c_void>, width: NSUInteger, height: NSUInteger, bytes_per_row: NSUInteger, format: CIFormat, ) -> Retained<Self>

Available on crate feature CIImage only.

§Safety

data must be a valid pointer.

Source

pub unsafe fn setAlphaMode(&self, alpha_mode: CIRenderDestinationAlphaMode)

Setter for alphaMode.

Source

pub unsafe fn isFlipped(&self) -> bool

Source

pub unsafe fn setFlipped(&self, flipped: bool)

Setter for isFlipped.

Source

pub unsafe fn isDithered(&self) -> bool

Source

pub unsafe fn setDithered(&self, dithered: bool)

Setter for isDithered.

Source

pub unsafe fn isClamped(&self) -> bool

Source

pub unsafe fn setClamped(&self, clamped: bool)

Setter for isClamped.

Source

pub unsafe fn colorSpace(&self) -> Option<Retained<CGColorSpace>>

Available on crate feature objc2-core-graphics only.

Source

pub unsafe fn setColorSpace(&self, color_space: Option<&CGColorSpace>)

Available on crate feature objc2-core-graphics only.

Setter for colorSpace.

Source

pub unsafe fn blendKernel(&self) -> Option<Retained<CIBlendKernel>>

Available on crate feature CIKernel only.

Source

pub unsafe fn setBlendKernel(&self, blend_kernel: Option<&CIBlendKernel>)

Available on crate feature CIKernel only.

Setter for blendKernel.

Source

pub unsafe fn blendsInDestinationColorSpace(&self) -> bool

Source

pub unsafe fn setBlendsInDestinationColorSpace( &self, blends_in_destination_color_space: bool, )

Setter for blendsInDestinationColorSpace.

Source

pub unsafe fn captureTraceURL(&self) -> Option<Retained<NSURL>>

Tell the next render using this destination to capture a Metal trace.

If this property is set to a file-based URL, then the next render using this destination will capture a Metal trace, deleting any existing file if present. This property is nil by default.

Source

pub unsafe fn setCaptureTraceURL(&self, capture_trace_url: Option<&NSURL>)

Setter for captureTraceURL.

Source §

impl CIRenderDestination

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}