Struct CNRenderingSession

Source

pub struct CNRenderingSession { /* private fields */ }

Available on crate feature CNRenderingSession only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CNRenderingSession

Source

pub unsafe fn initWithCommandQueue_sessionAttributes_preferredTransform_quality( this: Allocated<Self>, command_queue: &ProtocolObject<dyn MTLCommandQueue>, session_attributes: &CNRenderingSessionAttributes, preferred_transform: CGAffineTransform, quality: CNRenderingQuality, ) -> Retained<Self>

Available on crate features objc2-core-foundation and objc2-metal only.

Source

pub unsafe fn commandQueue( &self, ) -> Retained<ProtocolObject<dyn MTLCommandQueue>>

Available on crate feature objc2-metal only.

Source

pub unsafe fn sessionAttributes(&self) -> Retained<CNRenderingSessionAttributes>

Source

pub unsafe fn preferredTransform(&self) -> CGAffineTransform

Available on crate feature objc2-core-foundation only.

Source

pub unsafe fn quality(&self) -> CNRenderingQuality

Source

pub unsafe fn encodeRenderToCommandBuffer_frameAttributes_sourceImage_sourceDisparity_destinationImage( &self, command_buffer: &ProtocolObject<dyn MTLCommandBuffer>, frame_attributes: &CNRenderingSessionFrameAttributes, source_image: &CVPixelBuffer, source_disparity: &CVPixelBuffer, destination_image: &CVPixelBuffer, ) -> bool

Available on crate features objc2-core-video and objc2-metal only.

Encode a command to render a shallow depth of field (SDoF) image to a pixel buffer.

Parameters:
commandBuffer: the metal command buffer on which to encode the command
frameAttributes: controls the focus distance and aperture of the rendering
sourceImage: a pixel buffer read from the cinematicVideoTrack
sourceDisparity: a pixel buffer read from the cinematicDisparityTrack
destinationImage: the pixel buffer to which the SDoF image is rendered
Returns: whether encoding the render command was successful

Source

pub unsafe fn encodeRenderToCommandBuffer_frameAttributes_sourceImage_sourceDisparity_destinationRGBA( &self, command_buffer: &ProtocolObject<dyn MTLCommandBuffer>, frame_attributes: &CNRenderingSessionFrameAttributes, source_image: &CVPixelBuffer, source_disparity: &CVPixelBuffer, destination_rgba: &ProtocolObject<dyn MTLTexture>, ) -> bool

Available on crate features objc2-core-video and objc2-metal only.

Encode a command to render a shallow depth of field (SDoF) image to a metal texture as RGBA.

Parameters:
commandBuffer: the metal command buffer on which to encode the command
frameAttributes: controls the focus distance and aperture of the rendering
sourceImage: a pixel buffer read from the cinematicVideoTrack
sourceDisparity: a pixel buffer read from the cinematicDisparityTrack
destinationRGBA: a metal texture to which the SDoF image is rendered in RGBA format
Returns: whether encoding the render command was successful

§Safety

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

Source

pub unsafe fn encodeRenderToCommandBuffer_frameAttributes_sourceImage_sourceDisparity_destinationLuma_destinationChroma( &self, command_buffer: &ProtocolObject<dyn MTLCommandBuffer>, frame_attributes: &CNRenderingSessionFrameAttributes, source_image: &CVPixelBuffer, source_disparity: &CVPixelBuffer, destination_luma: &ProtocolObject<dyn MTLTexture>, destination_chroma: &ProtocolObject<dyn MTLTexture>, ) -> bool

Available on crate features objc2-core-video and objc2-metal only.

Encode a command to render a shallow depth of field (SDoF) image to two metal textures as luma and chroma.

Parameters:
commandBuffer: the metal command buffer on which to encode the command
frameAttributes: controls the focus distance and aperture of the rendering
sourceImage: a pixel buffer read from the cinematicVideoTrack
sourceDisparity: a pixel buffer read from the cinematicDisparityTrack
destinationLuma: a metal texture to which the luma of the SDoF image is rendered
destinationChroma: a metal texture to which the chroma of the SDoF image is rendered
Returns: whether encoding the render command was successful

§Safety

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

Source

pub unsafe fn sourcePixelFormatTypes() -> Retained<NSArray<NSNumber>>

The pixel format types supported for the input source.

Use with kCVPixelBufferPixelFormatTypeKey in the video compositor’s sourcePixelBufferAttributes dictionary when implementing AVVideoCompositing.

Source

pub unsafe fn destinationPixelFormatTypes() -> Retained<NSArray<NSNumber>>

The pixel format types supported for the output destination.

Use with kCVPixelBufferPixelFormatTypeKey in the video compositor’s requiredPixelBufferAttributesForRenderContext dictionary when implementing AVVideoCompositing.

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