//  
//  GCDirectionalGamepad.h
//  GameController
//
//  Copyright © 2020 Apple Inc. All rights reserved.
//

#import <GameController/GCMicroGamepad.h>

NS_ASSUME_NONNULL_BEGIN

/**
 The primary directional input surface for the directional gamepad
 
 @note Equivalent to microgamepad.dpad
 
 @note For the 2021 2nd generation Siri Remote, this represents touching anywhere on the entire touch surface - including the inner and outer rings.
*/
GAMECONTROLLER_EXPORT NSString *const GCInputDirectionalDpad API_AVAILABLE(macos(11.3), ios(14.5), tvos(14.5));

/**
 The button corresponding to pressing anywhere on the primary directional input surface for the directional gamepad
 
 @note Equivalent to microgamepad.buttonA
 
 @note For the 2021 2nd generation Siri Remote, this represents pressing anywhere the entire touch surface - including the inner and outer rings.
*/
GAMECONTROLLER_EXPORT NSString *const GCInputDirectionalTouchSurfaceButton API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0));

/**
 An optional secondary directional input surface for the directional gamepad. This input is guaranteed to be an 8-way digital dpad with physical Up, Down, Left, Right butttons.
 
 @note For the 2021 2nd generation Siri Remote, this represents pressing on the outer ring of the touch surface.
*/
GAMECONTROLLER_EXPORT NSString *const GCInputDirectionalCardinalDpad API_AVAILABLE(macos(11.3), ios(14.5), tvos(14.5));

/**
 An optional button for the directional gamepad. This input represents the center button of the cardinal dpad.
 
 @note For the 2021 2nd generation Siri Remote, this represents pressing anywhere on the inner ring of the touch surface.
*/
GAMECONTROLLER_EXPORT NSString *const GCInputDirectionalCenterButton API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0));

/**
 Directional Gamepad profile.
 
 All controller profiles provide a base level of information about the controller they belong to. A directional gamepad
 features a subset of the possible inputs on a micro gamepad. It guarantees:
    - The gamepad does not support motion, meaning
        - -[GCController motion] is always nil
        - -[GCDirectionalGamepad allowsRotation] is always NO
 
 Additionally, the gamepad may have a digital or analog dpad.
        - -[GCDirectionalGamepad dpad].analog may be YES or NO
        - If -[GCDirectionalGamepad dpad].analog is NO, then -[GCDirectionalGamepad reportsAbsoluteDpadValues] is always YES
 
 A profile maps the hardware notion of a controller into a logical controller. One that a developer can design for
 and depend on, no matter the underlying hardware. If your game supports GCMicroGamepad, but does not need
 the motion and analog dpad functionality of GCMicroGamepad, be sure to add Directional Gamepad to your project's
 supported Game Controller capabilities.
 
 @see GCMicroGamepad
 
 @note If you want to use the additional functionality of GCDirectionalGamepad, you should set GCSupportsMultipleMicroGamepads to YES and handle microgamepad connections separately.
 
 @note This profile represents the 2021 2nd generation Siri Remote. Make sure you set GCSupportsMultipleMicroGamepads to YES to properly support the remote.
 */
API_AVAILABLE(macos(11.1), ios(14.3), tvos(14.3))
@interface GCDirectionalGamepad : GCMicroGamepad

@end

NS_ASSUME_NONNULL_END
