Struct GCControllerLiveInput

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

Available on crate feature GCControllerInput only.

Apple’s documentation

Implementations

impl GCControllerLiveInput

pub unsafe fn unmappedInput(&self) -> Option<Retained<GCControllerLiveInput>>

Get a view of the controller’s input without any system-level control remapping applied.

Developers should avoid implementing their own control remapping functionality and to instead direct users to the system game controller settings to remap controls. If you choose to implement your own control remapping functionality, or if your app streams controller input to a remote device that implements control remapping functionality, you should access controller physical input through this interface.

pub unsafe fn capture(&self) -> Retained<GCControllerInputState>

pub unsafe fn nextInputState(&self) -> Option<Retained<GCControllerInputState>>

Available on crate feature GCDevicePhysicalInputStateDiff only.

impl GCControllerLiveInput

Methods declared on superclass NSObject.

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

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

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.

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.

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<AnyObject> for GCControllerLiveInput

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GCControllerInputState> for GCControllerLiveInput

fn as_ref(&self) -> &GCControllerInputState

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

impl AsRef<GCControllerLiveInput> for GCControllerLiveInput

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GCControllerLiveInput

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GCControllerLiveInput

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<GCControllerInputState> for GCControllerLiveInput

fn borrow(&self) -> &GCControllerInputState

Immutably borrows from an owned value.

impl Borrow<NSObject> for GCControllerLiveInput

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GCControllerLiveInput

const NAME: &'static str = "GCControllerLiveInput"

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

type Super = GCControllerInputState

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for GCControllerLiveInput

type Target = GCControllerInputState

The resulting type after dereferencing.

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

Dereferences the value.

impl GCDevicePhysicalInput for GCControllerLiveInput

unsafe fn device(&self) -> Option<Retained<ProtocolObject<dyn GCDevice>>>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and GCDevice only.

The device that this profile is mapping input from.

unsafe fn queue(&self) -> Option<Retained<DispatchQueue>>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and dispatch2 only.

The dispatch queue that element value change handlers and other callbacks are submitted on.

unsafe fn setQueue(&self, queue: Option<&DispatchQueue>)

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and dispatch2 only.

Setter for queue.

unsafe fn elementValueDidChangeHandler( &self, ) -> *mut DynBlock<dyn Fn(NonNull<ProtocolObject<dyn GCDevicePhysicalInput>>, NonNull<ProtocolObject<dyn GCPhysicalInputElement>>)>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and GCPhysicalInputElement and block2 only.

Set this block to be notified when a value on a element changed. If multiple elements change this block will be called for each element that changed.

unsafe fn setElementValueDidChangeHandler( &self, element_value_did_change_handler: Option<&DynBlock<dyn Fn(NonNull<ProtocolObject<dyn GCDevicePhysicalInput>>, NonNull<ProtocolObject<dyn GCPhysicalInputElement>>)>>, )

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and GCPhysicalInputElement and block2 only.

Setter for elementValueDidChangeHandler.

unsafe fn capture( &self, ) -> Retained<ProtocolObject<dyn GCDevicePhysicalInputState>>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState only.

Polls the current state vector of the physical input and saves it to a new instance.

unsafe fn inputStateAvailableHandler( &self, ) -> *mut DynBlock<dyn Fn(NonNull<ProtocolObject<dyn GCDevicePhysicalInput>>)>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and block2 only.

Set this block to be notified when a new input state is available. Your handler should repeatedly call -nextInputStateuntil it returns nilto drain the pending input states from the queue.

unsafe fn setInputStateAvailableHandler( &self, input_state_available_handler: Option<&DynBlock<dyn Fn(NonNull<ProtocolObject<dyn GCDevicePhysicalInput>>)>>, )

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and block2 only.

Setter for inputStateAvailableHandler.

unsafe fn inputStateQueueDepth(&self) -> NSInteger

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState only.

The maximum number of input states to buffer. If your application does not drain the pending input states in the queue before this limit is reached, older input states will be discarded - resulting in your application “missing” input state changes.

unsafe fn setInputStateQueueDepth(&self, input_state_queue_depth: NSInteger)

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState only.

Setter for inputStateQueueDepth.

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

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInput and GCDevicePhysicalInputState and GCDevicePhysicalInputStateDiff only.

Pop the oldest pending input state from the queue. This method returns nilwhen there are no more input states pending.

impl GCDevicePhysicalInputState for GCControllerLiveInput

unsafe fn device(&self) -> Option<Retained<ProtocolObject<dyn GCDevice>>>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInputState and GCDevice only.

The device that this profile is mapping input from.

unsafe fn lastEventTimestamp(&self) -> NSTimeInterval

where Self: Sized + Message,

Available on crate feature GCDevicePhysicalInputState only.

The internal time stamp of the last event.

unsafe fn lastEventLatency(&self) -> NSTimeInterval

where Self: Sized + Message,

Available on crate feature GCDevicePhysicalInputState only.

The interval (in seconds) between the timestamp of the last event and the current time.

unsafe fn elements( &self, ) -> Retained<GCPhysicalInputElementCollection<NSString, ProtocolObject<dyn GCPhysicalInputElement>>>

where Self: Sized + Message,

Available on crate features GCInputNames and GCPhysicalInputElement and GCDevicePhysicalInputState only.

The following properties allow for runtime lookup of any input element on a profile, when provided with a valid alias.

unsafe fn buttons( &self, ) -> Retained<GCPhysicalInputElementCollection<NSString, ProtocolObject<dyn GCButtonElement>>>

where Self: Sized + Message,

Available on crate features GCButtonElement and GCInputNames and GCPhysicalInputElement and GCDevicePhysicalInputState only.

unsafe fn axes( &self, ) -> Retained<GCPhysicalInputElementCollection<NSString, ProtocolObject<dyn GCAxisElement>>>

where Self: Sized + Message,

Available on crate features GCAxisElement and GCInputNames and GCPhysicalInputElement and GCDevicePhysicalInputState only.

unsafe fn switches( &self, ) -> Retained<GCPhysicalInputElementCollection<NSString, ProtocolObject<dyn GCSwitchElement>>>

where Self: Sized + Message,

Available on crate features GCInputNames and GCPhysicalInputElement and GCSwitchElement and GCDevicePhysicalInputState only.

unsafe fn dpads( &self, ) -> Retained<GCPhysicalInputElementCollection<NSString, ProtocolObject<dyn GCDirectionPadElement>>>

where Self: Sized + Message,

Available on crate features GCDirectionPadElement and GCInputNames and GCPhysicalInputElement and GCDevicePhysicalInputState only.

unsafe fn objectForKeyedSubscript( &self, key: &NSString, ) -> Option<Retained<ProtocolObject<dyn GCPhysicalInputElement>>>

where Self: Sized + Message,

Available on crate features GCDevicePhysicalInputState and GCPhysicalInputElement only.

Profile elements can be accessed using keyed subscript notation, with a valid alias of its inputs.

impl Hash for GCControllerLiveInput

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 GCControllerLiveInput

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for GCControllerLiveInput

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 GCControllerLiveInput

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 GCControllerLiveInput

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

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

impl DowncastTarget for GCControllerLiveInput

impl Eq for GCControllerLiveInput