Struct MTKView

Source

pub struct MTKView { /* private fields */ }

Available on crate feature MTKView and crate feature objc2-app-kit and macOS only.

Expand description

View for rendering metal content

Implementations§

Source §

impl MTKView

Source

pub fn initWithFrame_device( this: Allocated<Self>, frame_rect: CGRect, device: Option<&ProtocolObject<dyn MTLDevice>>, ) -> Retained<Self>

Available on crate feature objc2-core-foundation only.

Initalize the view with a frame and device

Parameter frameRect: The frame rectangle for the created view object.

Parameter device: The MTLDevice to be used by the view to create Metal objects

Source

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

Returns a view initalized from data in a given unarchiver

Parameter coder: An unarchiver object

§Safety

coder possibly has further requirements.

Source

Setter for device.

Source

pub fn currentDrawable( &self, ) -> Option<Retained<ProtocolObject<dyn CAMetalDrawable>>>

Available on crate feature objc2-quartz-core only.

The drawable to be used for the current frame.

pub fn setDrawableSize(&self, drawable_size: CGSize)

Available on crate feature objc2-core-foundation only.

Setter for drawableSize.

Source

pub fn preferredDrawableSize(&self) -> CGSize

Available on crate feature objc2-core-foundation only.

The preferred drawable size reported by the backing NSView to match a NSView’s native resolution.

this value can be observed via key-value observation to determine if the current native drawable size has changed.

Source

pub fn preferredDevice(&self) -> Option<Retained<ProtocolObject<dyn MTLDevice>>>

The preferred device is updated per-frame by the system in order to identify the most efficient GPU for presentation (e.g. the one being used for compositing).

This value is determined by the underlying CAMetalLayer and this property is a convenience accessor for it.

Source

pub fn isPaused(&self) -> bool

Controls whether the draw methods should countinue at preferredFramesPerSecond

If true, the delegate will receive drawInMTKView: messages or the subclass will receive drawRect: messages at a rate of preferredFramesPerSecond based on an internal timer. The default value is false.

Source

pub fn setPaused(&self, paused: bool)

Setter for isPaused.

Source

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

Available on crate feature objc2-core-graphics only.

The colorspace of the rendered frames. ’

If nil, no colormatching occurs. If non-nil, the rendered content will be colormatched to the colorspace of the context containing this layer (typically the display’s colorspace). This property aliases the olorspace property or the view’s CAMetalLayer

Source

pub fn setColorspace(&self, colorspace: Option<&CGColorSpace>)

Available on crate feature objc2-core-graphics only.

Setter for colorspace.

Source

pub fn draw(&self)

Manually ask the view to draw new contents. This causes the view to call either the drawInMTKView (delegate) or drawRect (subclass) method.

Manually ask the view to draw new contents. This causes the view to call either the drawInMTKView (delegate) or drawRect (subclass) method. This should be used when the view’s paused proprety is set to true and enableSetNeedsDisplay is set to false.

Methods from Deref<Target = NSView>§

Source

pub unsafe fn superview(&self) -> Option<Retained<NSView>>

§Safety

This is not retained internally, you must ensure the object is still alive.

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Source

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub fn canDraw(&self) -> bool

👎Deprecated: If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Source

pub fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub fn needsDisplay(&self) -> bool

Source

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

Source

pub fn layoutSubtreeIfNeeded(&self)

Source

Setter for toolTip.

This is copied when set.

Source

pub unsafe fn addToolTipRect_owner_userData( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, ) -> isize

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Setter for preparedContentRect.

Source

pub fn allowsVibrancy(&self) -> bool

Source

pub fn viewDidChangeEffectiveAppearance(&self)

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Setter for nextKeyView.

Source

pub fn setKeyboardFocusRingNeedsDisplayInRect(&self, rect: CGRect)

Source

pub fn focusRingType(&self) -> NSFocusRingType

Source

pub fn setFocusRingType(&self, focus_ring_type: NSFocusRingType)

Setter for focusRingType.

§Safety

sender should be of the correct type.

Source

pub unsafe fn knowsPageRange(&self, range: *mut NSRange) -> bool

§Safety

range must be a valid pointer.

§Safety

options generic should be of the correct type.

Setter for additionalSafeAreaInsets.

Source

pub fn safeAreaRect(&self) -> CGRect

Source

pub fn prefersCompactControlSizeMetrics(&self) -> bool

When this property is true, any NSControls in the view or its descendants will be sized with compact metrics compatible with macOS 15 and earlier. Defaults to false

Source

pub fn setPrefersCompactControlSizeMetrics( &self, prefers_compact_control_size_metrics: bool, )

Setter for prefersCompactControlSizeMetrics.

Source

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

Source

pub fn becomeFirstResponder(&self) -> bool

Source

pub fn resignFirstResponder(&self) -> bool

Source

pub fn flushBufferedKeyEvents(&self)

Source

pub unsafe fn showContextHelp(&self, sender: Option<&AnyObject>)

§Safety

sender should be of the correct type.

Source

pub unsafe fn supplementalTargetForAction_sender( &self, action: Sel, sender: Option<&AnyObject>, ) -> Option<Retained<AnyObject>>

§Safety

action must be a valid selector.
sender should be of the correct type.

Source

pub fn undoManager(&self) -> Option<Retained<NSUndoManager>>

Source

pub fn presentError(&self, error: &NSError) -> bool

Source

pub fn willPresentError(&self, error: &NSError) -> Retained<NSError>

Source

pub fn performMnemonic(&self, string: &NSString) -> bool

👎Deprecated: This has always returned NO and had no effect on macOS

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

type Super = NSView

The superclass of this class. Read more

Source §

type ThreadKind = dyn MainThreadOnly

Whether the type can be used from any thread, or from only the main thread. Read more

Source §

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more

Dereferences the value.

Source §

impl Hash for MTKView

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for MTKView

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Source §

Safety Read more

fn animationForKey(&self, key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + Message,

Source §

fn defaultAnimationForKey(key: &NSString) -> Option<Retained<AnyObject>>
where Self: Sized + ClassType,

Source §

impl NSAppearanceCustomization for MTKView

Source §

Check whether the object is equal to an arbitrary other object. Read more

Source §

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more

Source §

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. Read more

Source §

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

Source §

fn identifier(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

Source §

fn setIdentifier(&self, identifier: Option<&NSString>)
where Self: Sized + Message,

Setter for identifier. Read more

Source §

impl PartialEq for MTKView

Source §

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct MTKView Copy item path

Implementations§

impl MTKView

pub fn initWithFrame_device( this: Allocated<Self>, frame_rect: CGRect, device: Option<&ProtocolObject<dyn MTLDevice>>, ) -> Retained<Self>

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

§Safety

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

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

pub fn device(&self) -> Option<Retained<ProtocolObject<dyn MTLDevice>>>

pub fn setDevice(&self, device: Option<&ProtocolObject<dyn MTLDevice>>)

pub fn currentDrawable( &self, ) -> Option<Retained<ProtocolObject<dyn CAMetalDrawable>>>

pub fn framebufferOnly(&self) -> bool

pub fn setFramebufferOnly(&self, framebuffer_only: bool)

pub fn depthStencilAttachmentTextureUsage(&self) -> MTLTextureUsage

pub fn setDepthStencilAttachmentTextureUsage( &self, depth_stencil_attachment_texture_usage: MTLTextureUsage, )

pub fn multisampleColorAttachmentTextureUsage(&self) -> MTLTextureUsage

pub fn setMultisampleColorAttachmentTextureUsage( &self, multisample_color_attachment_texture_usage: MTLTextureUsage, )

pub fn presentsWithTransaction(&self) -> bool

pub fn setPresentsWithTransaction(&self, presents_with_transaction: bool)

pub fn colorPixelFormat(&self) -> MTLPixelFormat

pub fn setColorPixelFormat(&self, color_pixel_format: MTLPixelFormat)

pub fn depthStencilPixelFormat(&self) -> MTLPixelFormat

pub fn setDepthStencilPixelFormat( &self, depth_stencil_pixel_format: MTLPixelFormat, )

pub fn depthStencilStorageMode(&self) -> MTLStorageMode

pub fn setDepthStencilStorageMode( &self, depth_stencil_storage_mode: MTLStorageMode, )

pub fn sampleCount(&self) -> NSUInteger

pub fn setSampleCount(&self, sample_count: NSUInteger)

pub fn clearColor(&self) -> MTLClearColor

pub fn setClearColor(&self, clear_color: MTLClearColor)

pub fn clearDepth(&self) -> c_double

pub fn setClearDepth(&self, clear_depth: c_double)

pub fn clearStencil(&self) -> u32

pub fn setClearStencil(&self, clear_stencil: u32)

pub fn depthStencilTexture( &self, ) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>

pub fn multisampleColorTexture( &self, ) -> Option<Retained<ProtocolObject<dyn MTLTexture>>>

pub fn releaseDrawables(&self)

pub fn currentRenderPassDescriptor( &self, ) -> Option<Retained<MTLRenderPassDescriptor>>

pub fn currentMTL4RenderPassDescriptor( &self, ) -> Option<Retained<MTL4RenderPassDescriptor>>

pub fn preferredFramesPerSecond(&self) -> NSInteger

pub fn setPreferredFramesPerSecond( &self, preferred_frames_per_second: NSInteger, )

pub fn enableSetNeedsDisplay(&self) -> bool

pub fn setEnableSetNeedsDisplay(&self, enable_set_needs_display: bool)

pub fn autoResizeDrawable(&self) -> bool

pub fn setAutoResizeDrawable(&self, auto_resize_drawable: bool)

pub fn drawableSize(&self) -> CGSize

pub fn setDrawableSize(&self, drawable_size: CGSize)

pub fn preferredDrawableSize(&self) -> CGSize

pub fn preferredDevice(&self) -> Option<Retained<ProtocolObject<dyn MTLDevice>>>

pub fn isPaused(&self) -> bool

pub fn setPaused(&self, paused: bool)

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

pub fn setColorspace(&self, colorspace: Option<&CGColorSpace>)

pub fn draw(&self)

impl MTKView

pub fn initWithFrame( this: Allocated<Self>, frame_rect: NSRect, ) -> Retained<Self>

impl MTKView

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

impl MTKView

pub fn new(mtm: MainThreadMarker) -> Retained<Self>

Methods from Deref<Target = NSView>§

pub unsafe fn superview(&self) -> Option<Retained<NSView>>

§Safety

pub fn subviews(&self) -> Retained<NSArray<NSView>>

pub fn setSubviews(&self, subviews: &NSArray<NSView>)

pub fn isDescendantOf(&self, view: &NSView) -> bool

pub fn ancestorSharedWithView(&self, view: &NSView) -> Option<Retained<NSView>>

pub unsafe fn opaqueAncestor(&self) -> Option<Retained<NSView>>

§Safety

pub fn isHidden(&self) -> bool

pub fn setHidden(&self, hidden: bool)

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

pub unsafe fn getRectsBeingDrawn_count( &self, rects: *mut *const CGRect, count: *mut isize, )

§Safety

pub fn needsToDrawRect(&self, rect: CGRect) -> bool

pub fn wantsDefaultClipping(&self) -> bool

pub fn viewDidHide(&self)

pub fn viewDidUnhide(&self)

pub fn addSubview(&self, view: &NSView)

pub fn addSubview_positioned_relativeTo( &self, view: &NSView, place: NSWindowOrderingMode, other_view: Option<&NSView>, )

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, *mut c_void) -> NSComparisonResult, context: *mut c_void, )

Struct MTKView

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )