Struct NSOpenGLContext 

pub struct NSOpenGLContext { /* private fields */ }

👎Deprecated: Please use Metal or MetalKit.

Available on crate feature NSOpenGL only.

Apple’s documentation

Implementations

impl NSOpenGLContext

pub fn initWithFormat_shareContext( this: Allocated<Self>, format: &NSOpenGLPixelFormat, share: Option<&NSOpenGLContext>, ) -> Option<Retained<Self>>

pub unsafe fn initWithCGLContextObj( this: Allocated<Self>, context: CGLContextObj, ) -> Option<Retained<NSOpenGLContext>>

Available on crate feature objc2-open-gl and Apple only.

Safety

context must be a valid pointer.

pub fn pixelFormat(&self) -> Retained<NSOpenGLPixelFormat>

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

👎Deprecated

Available on crate features NSResponder and NSView only.

pub fn setView(&self, view: Option<&NSView>, mtm: MainThreadMarker)

👎Deprecated

Available on crate features NSResponder and NSView only.

Setter for view.

This is a weak property.

pub fn setFullScreen(&self)

👎Deprecated: Use a fullscreen NSOpenGLView instead

pub unsafe fn setOffScreen_width_height_rowbytes( &self, baseaddr: NonNull<c_void>, width: i32, height: i32, rowbytes: i32, )

👎Deprecated

Available on crate feature objc2-open-gl and Apple only.

Safety

baseaddr must be a valid pointer.

pub fn clearDrawable(&self)

pub fn update(&self, mtm: MainThreadMarker)

pub fn flushBuffer(&self)

pub fn makeCurrentContext(&self)

pub fn clearCurrentContext()

pub fn currentContext() -> Option<Retained<NSOpenGLContext>>

pub fn copyAttributesFromContext_withMask( &self, context: &NSOpenGLContext, mask: u32, )

👎Deprecated

Available on crate feature objc2-open-gl and Apple only.

pub unsafe fn setValues_forParameter( &self, vals: NonNull<i32>, param: NSOpenGLContextParameter, )

Available on crate feature objc2-open-gl and Apple only.

Safety

vals must be a valid pointer.

pub unsafe fn getValues_forParameter( &self, vals: NonNull<i32>, param: NSOpenGLContextParameter, )

Available on crate feature objc2-open-gl and Apple only.

Safety

vals must be a valid pointer.

pub fn currentVirtualScreen(&self) -> i32

Available on crate feature objc2-open-gl and Apple only.

pub fn setCurrentVirtualScreen(&self, current_virtual_screen: i32)

Available on crate feature objc2-open-gl and Apple only.

Setter for currentVirtualScreen.

pub fn createTexture_fromView_internalFormat( &self, target: u32, view: &NSView, format: u32, )

👎Deprecated

Available on crate feature NSResponder and crate feature NSView and crate feature objc2-open-gl and Apple only.

pub fn CGLContextObj(&self) -> CGLContextObj

Available on crate feature objc2-open-gl and Apple only.

impl NSOpenGLContext

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

impl NSOpenGLContext

NSOpenGLPixelBuffer.

pub fn setPixelBuffer_cubeMapFace_mipMapLevel_currentVirtualScreen( &self, pixel_buffer: &NSOpenGLPixelBuffer, face: u32, level: i32, screen: i32, )

👎Deprecated

Available on crate feature objc2-open-gl and Apple only.

pub fn pixelBuffer(&self) -> Option<Retained<NSOpenGLPixelBuffer>>

👎Deprecated

pub fn pixelBufferCubeMapFace(&self) -> u32

👎Deprecated

Available on crate feature objc2-open-gl and Apple only.

pub fn pixelBufferMipMapLevel(&self) -> i32

👎Deprecated

Available on crate feature objc2-open-gl and Apple only.

pub fn setTextureImageToPixelBuffer_colorBuffer( &self, pixel_buffer: &NSOpenGLPixelBuffer, source: u32, )

👎Deprecated

Available on crate feature objc2-open-gl and Apple only.

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

Available on crate feature NSAccessibilityConstants only.

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.

Available on crate feature NSAccessibilityConstants only.

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,

Available on crate feature NSAccessibilityConstants only.

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 NSOpenGLContext

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSOpenGLContext

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSOpenGLContext> for NSOpenGLContext

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSOpenGLContext

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSOpenGLContext

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSOpenGLContext

const NAME: &'static str = "NSOpenGLContext"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl DefaultRetained for NSOpenGLContext

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSOpenGLContext

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSOpenGLContext

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 NSOpenGLContext

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSLocking for NSOpenGLContext

unsafe fn lock(&self)

where Self: Sized + Message,

unsafe fn unlock(&self)

where Self: Sized + Message,

impl NSObjectProtocol for NSOpenGLContext

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 NSOpenGLContext

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 NSOpenGLContext

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

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

impl DowncastTarget for NSOpenGLContext

impl Eq for NSOpenGLContext