Struct GCExtendedGamepad

Source

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

Available on crate features GCExtendedGamepad and GCPhysicalInputProfile only.

Expand description

Apple’s documentation

Implementations§

Source §

impl GCExtendedGamepad

Source

pub unsafe fn controller(&self) -> Option<Retained<GCController>>

Available on crate feature GCController only.

A profile keeps a reference to the controller that this profile is mapping input from.

Source

pub unsafe fn valueChangedHandler(&self) -> GCExtendedGamepadValueChangedHandler

Available on crate features GCControllerElement and block2 only.

Source

pub unsafe fn setValueChangedHandler( &self, value_changed_handler: GCExtendedGamepadValueChangedHandler, )

Available on crate features GCControllerElement and block2 only.

Setter for valueChangedHandler.

Source

pub unsafe fn saveSnapshot(&self) -> Retained<GCExtendedGamepadSnapshot>

👎Deprecated: Use the -[GCController capture] method instead

Available on crate feature GCExtendedGamepadSnapshot only.

Polls the state vector of the controller and saves it to a snapshot. The snapshot is stored in a device independent format that can be serialized and used at a later date. This is useful for features such as quality assurance, save game or replay functionality among many.

If your application is heavily multithreaded this may also be useful to guarantee atomicity of input handling as a snapshot will not change based on user input once it is taken.

Source

pub unsafe fn dpad(&self) -> Retained<GCControllerDirectionPad>

Available on crate features GCControllerDirectionPad and GCControllerElement only.

Required to be analog in the Extended profile. All the elements of this directional input are thus analog.

Source

pub unsafe fn buttonA(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

All face buttons are required to be analog in the Extended profile. These must be arranged in the diamond pattern given below:

Y /
X B
/ A

Source

pub unsafe fn buttonB(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn buttonX(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn buttonY(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn buttonMenu(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Button menu is the primary menu button, and should be used to enter the main menu and pause the game.

Source

pub unsafe fn buttonOptions(&self) -> Option<Retained<GCControllerButtonInput>>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Button options is the secondary menu button. It should be used to enter a secondary menu, such as graphics and sound configuration, and pause the game.

Source

pub unsafe fn buttonHome(&self) -> Option<Retained<GCControllerButtonInput>>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Button home is a special menu button. If the system does not consume button home events, they will be passed to your application and should be used to enter a secondary menu, and pause the game.

Source

pub unsafe fn leftThumbstick(&self) -> Retained<GCControllerDirectionPad>

Available on crate features GCControllerDirectionPad and GCControllerElement only.

A thumbstick is a 2-axis control that is physically required to be analog. All the elements of this directional input are thus analog.

Source

pub unsafe fn rightThumbstick(&self) -> Retained<GCControllerDirectionPad>

Available on crate features GCControllerDirectionPad and GCControllerElement only.

A thumbstick is a 2-axis control that is physically required to be analog. All the elements of this directional input are thus analog.

Source

pub unsafe fn leftShoulder(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Shoulder buttons are required to be analog inputs.

Source

pub unsafe fn rightShoulder(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Shoulder buttons are required to be analog inputs.

Source

pub unsafe fn leftTrigger(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Triggers are required to be analog inputs. Common uses would be acceleration and decelleration in a driving game for example.

Source

pub unsafe fn rightTrigger(&self) -> Retained<GCControllerButtonInput>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn leftThumbstickButton( &self, ) -> Option<Retained<GCControllerButtonInput>>

Available on crate features GCControllerButtonInput and GCControllerElement only.

A thumbstick may also have a clickable component, which is treated as a non-analog button.

Source

pub unsafe fn rightThumbstickButton( &self, ) -> Option<Retained<GCControllerButtonInput>>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn setStateFromExtendedGamepad( &self, extended_gamepad: &GCExtendedGamepad, )

Sets the state vector of the extended gamepad to a copy of the input extended gamepad’s state vector.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: GCController.snapshot

Source §

impl GCExtendedGamepad

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 = GCPhysicalInputProfile>§

Source

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

Available on crate feature GCDevice only.

A profile keeps a reference to the device that this profile is mapping input from

Source

pub unsafe fn lastEventTimestamp(&self) -> NSTimeInterval

The last time elements of this profile were updated.

Source

pub unsafe fn hasRemappedElements(&self) -> bool

Whether the user has remapped their physical input controls for this profile at the system level.

On iOS and tvOS, users can remap their game controller inputs in Settings.

Source

pub unsafe fn valueDidChangeHandler( &self, ) -> *mut DynBlock<dyn Fn(NonNull<GCPhysicalInputProfile>, NonNull<GCControllerElement>)>

Available on crate features GCControllerElement and block2 only.

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

Parameter profile: this profile that is being used to map the raw input data into logical values on controller elements such as the dpad or the buttons.

Parameter element: the element that has been modified.

Source

pub unsafe fn setValueDidChangeHandler( &self, value_did_change_handler: Option<&DynBlock<dyn Fn(NonNull<GCPhysicalInputProfile>, NonNull<GCControllerElement>)>>, )

Available on crate features GCControllerElement and block2 only.

Setter for valueDidChangeHandler.

Source

pub unsafe fn elements( &self, ) -> Retained<NSDictionary<NSString, GCControllerElement>>

Available on crate feature GCControllerElement only.

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

Source

pub unsafe fn buttons( &self, ) -> Retained<NSDictionary<NSString, GCControllerButtonInput>>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn axes( &self, ) -> Retained<NSDictionary<NSString, GCControllerAxisInput>>

Available on crate features GCControllerAxisInput and GCControllerElement only.

Source

pub unsafe fn dpads( &self, ) -> Retained<NSDictionary<NSString, GCControllerDirectionPad>>

Available on crate features GCControllerDirectionPad and GCControllerElement only.

Source

pub unsafe fn touchpads( &self, ) -> Retained<NSDictionary<NSString, GCControllerTouchpad>>

Available on crate features GCControllerElement and GCControllerTouchpad only.

Source

pub unsafe fn allElements(&self) -> Retained<NSSet<GCControllerElement>>

Available on crate feature GCControllerElement only.

The following properties allow for dynamic querying of the input elements available on a profile.

Source

pub unsafe fn allButtons(&self) -> Retained<NSSet<GCControllerButtonInput>>

Available on crate features GCControllerButtonInput and GCControllerElement only.

Source

pub unsafe fn allAxes(&self) -> Retained<NSSet<GCControllerAxisInput>>

Available on crate features GCControllerAxisInput and GCControllerElement only.

Source

pub unsafe fn allDpads(&self) -> Retained<NSSet<GCControllerDirectionPad>>

Available on crate features GCControllerDirectionPad and GCControllerElement only.

Source

pub unsafe fn allTouchpads(&self) -> Retained<NSSet<GCControllerTouchpad>>

Available on crate features GCControllerElement and GCControllerTouchpad only.

Source

pub unsafe fn objectForKeyedSubscript( &self, key: &NSString, ) -> Option<Retained<GCControllerElement>>

Available on crate feature GCControllerElement only.

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

Note: Equivalent to -elements

Source

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

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

If your application is heavily multithreaded this may also be useful to guarantee atomicity of input handling as a snapshot will not change based on user input once it is taken.

See: snapshot

Returns: A new physical input profile with the duplicated state vector of the current physical input

Source

pub unsafe fn setStateFromPhysicalInput( &self, physical_input: &GCPhysicalInputProfile, )

Sets the state vector of the physical input profile to a copy of the passed in physical input profile’s state vector.

Note: If the controller’s snapshot flag is set to NO, this method has no effect.

See: GCController.snapshot

Source

pub unsafe fn mappedElementAliasForPhysicalInputName( &self, input_name: &NSString, ) -> Retained<NSString>

Returns the primary alias of the GCControllerElement that a given physical input maps to.

If the user were to map a physical press of the A button of their game controller to the B button, then -[GCPhysicalInputProfile mappedElementAliasForPhysicalInputName: GCInputButtonA] would return GCInputButtonB. Note that mappings can change anytime your app is backgrounded, so make sure you update any relevant visuals when returning to foreground.

Parameter inputName: A GCInput string corresponding to the physical button you want the mapped element alias for.

Returns: A GCInput string corresponding to the primary alias of the GCControllerElement that a given physical button maps to, or nil if there is no mapping.

Source

pub unsafe fn mappedPhysicalInputNamesForElementAlias( &self, element_alias: &NSString, ) -> Retained<NSSet<NSString>>

Returns a set of GCInput strings corresponding to physical inputs that are mapped to a given GCControllerElement.

If the user mapped the physical press of the A button, the B button, and the X button to the B button, then -[GCPhysicalInputProfile mappedPhysicalInputNamesForElementAlias: GCInputButtonB] would return [GCInputButtonA, GCInputButtonB, GCInputButtonX]. Note that mappings can change anytime your app is backgrounded, so make sure you update any relevant visuals when returning to foreground.

Parameter elementAlias: A GCInput string corresponding to an alias of the GCControllerElement you want the physical buttons for.

Returns: A set of GCInput strings corresponding to physical inputs that are mapped to a given GCControllerElement, or an empty set if there are no mappings.

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