Package io.github.libsdl4j.api.haptic.effect

Class SDL_HapticLeftRight

  • @FieldOrder({"type","length","largeMagnitude","smallMagnitude"})
public final class SDL_HapticLeftRight
extends com.sun.jna.Structure
    A structure containing a template for a Left/Right effect.

    This struct is exclusively for the SDL_HAPTIC_LEFTRIGHT effect.

    The Left/Right effect is used to explicitly control the large and small motors, commonly found in modern game controllers. The small (right) motor is high frequency, and the large (left) motor is low frequency.

    See Also:
    SDL_HapticEffectType.SDL_HAPTIC_LEFTRIGHT, SDL_HapticEffect

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.sun.jna.Structure

        com.sun.jna.Structure.ByReference, com.sun.jna.Structure.ByValue, com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

    • Field Summary

      Fields 
      Modifier and Type Field Description
      short largeMagnitude
      Control of the large controller motor.
      int length
      Duration of the effect in milliseconds.
      short smallMagnitude
      Control of the small controller motor.
      short type
      SDL_HAPTIC_LEFTRIGHT

      • Fields inherited from class com.sun.jna.Structure

        ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

    • Method Summary

      • Methods inherited from class com.sun.jna.Structure

        allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

    • Field Detail

      • length

        public int length
        Duration of the effect in milliseconds.

      • largeMagnitude

        public short largeMagnitude
        Control of the large controller motor.

      • smallMagnitude

        public short smallMagnitude
        Control of the small controller motor.

    • Constructor Detail

      • SDL_HapticLeftRight

        public SDL_HapticLeftRight()

      • SDL_HapticLeftRight

        public SDL_HapticLeftRight​(com.sun.jna.Pointer p)