RemappingButtonCategory Enum

  • Reference

Definition

Namespace:
Windows.Gaming.Input.Preview
Edit

Types of gamepad remapping.

public enum class RemappingButtonCategory
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Gaming.Input.GamingInputPreviewContract, 131072)]
enum class RemappingButtonCategory
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Gaming.Input.GamingInputPreviewContract), 131072)]
public enum RemappingButtonCategory
var value = Windows.Gaming.Input.Preview.RemappingButtonCategory.buttonSettings
Public Enum RemappingButtonCategory
Inheritance
Enum
RemappingButtonCategory
Attributes
ContractVersionAttribute

Windows requirements

Device family
Windows Desktop Extension SDK (introduced in 10.0.23665.0)
API contract
Windows.Gaming.Input.GamingInputPreviewContract (introduced in v2.0)

Fields

AnalogSettings 1

Used to swap analog controls.
ButtonSettings 0

Used to remap buttons.
ShareDoublePress 9

Not implemented.
ShareDoublePressMetaData 10

Not implemented.
ShareDoublePressMetaDataDisplay 11

Not implemented.
ShareLongPress 6

Not implemented.
ShareLongPressMetaData 7

Not implemented.
ShareLongPressMetaDataDisplay 8

Not implemented.
ShareShortPress 3

Not implemented.
ShareShortPressMetaData 4

Not implemented.
ShareShortPressMetaDataDisplay 5

Not implemented.
VibrationSettings 2

Used to disable vibration.

Examples

void RemapButtons(IGameController controller, IGameControllerProvider controllerProvider)
{
    LegacyGipGameControllerProvider legacyGipGameControllerProvider =
        LegacyGipGameControllerProvider.FromGameControllerProvider(controllerProvider);

    // Retrieve all current remappings set for standard controllers
    IReadOnlyDictionary<RemappingButtonCategory, object> currentMappings =
        legacyGipGameControllerProvider.GetStandardControllerButtonRemapping(
            controller.User, false);

    // Swap two of the buttons
    Dictionary<RemappingButtonCategory, object> remaps =
        new Dictionary<RemappingButtonCategory, object>();

    // Duplicates are not allowed. Swap two of the buttons
    UInt64 currentButtonMappings =
       (UInt64)currentMappings[RemappingButtonCategory.ButtonSettings];

    // Isolate the buttons we want to remap
    UInt64 lastButton = (currentButtonMappings & 0xf000000000000000);
    UInt64 secondLastButton = currentButtonMappings & 0x0f00000000000000;

    // Swap their positions
    UInt64 newMapping = (lastButton >> 4) | (secondLastButton << 4);

    // Recombine with the original mappings
    UInt64 newButtonMappings = (currentButtonMappings & 0x00ffffffffffffff) | newMapping;

    // Add the new button remappings to the mapping dictionary
    remaps.Add(RemappingButtonCategory.ButtonSettings, newButtonMappings);

    // Update controller mapping
    legacyGipGameControllerProvider.SetStandardControllerButtonRemapping(
        controller.User, false, newButtonMappings);
}

Remarks

Caution

Controller mapping is system-wide and persistent for the given user. This should only be done at the user's direction.

Applies to