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

Class SDL_HapticConstant

  • @FieldOrder({"type","direction","length","delay","button","interval","level","attackLength","attackLevel","fadeLength","fadeLevel"})
public final class SDL_HapticConstant
extends com.sun.jna.Structure
    A structure containing a template for a Constant effect.

    This struct is exclusively for the SDL_HAPTIC_CONSTANT effect.

    A constant effect applies a constant force in the specified direction to the joystick.

    See Also:
    SDL_HapticEffectType.SDL_HAPTIC_CONSTANT, 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 attackLength
      Envelope - Duration of the attack.
      short attackLevel
      Envelope - Level at the start of the attack.
      short button
      Trigger - Button that triggers the effect.
      short delay
      Replay - Delay before starting the effect.
      SDL_HapticDirection direction
      Direction of the effect.
      short fadeLength
      Envelope - Duration of the fade.
      short fadeLevel
      Envelope - Level at the end of the fade.
      short interval
      Trigger - How soon it can be triggered again after button.
      int length
      Replay - Duration of the effect.
      short level
      Constant - Strength of the constant effect.
      short type
      SDL_HAPTIC_CONSTANT

      • 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
        Replay - Duration of the effect.

      • delay

        public short delay
        Replay - Delay before starting the effect.

      • button

        public short button
        Trigger - Button that triggers the effect.

      • interval

        public short interval
        Trigger - How soon it can be triggered again after button.

      • level

        public short level
        Constant - Strength of the constant effect.

      • attackLength

        public short attackLength
        Envelope - Duration of the attack.

      • attackLevel

        public short attackLevel
        Envelope - Level at the start of the attack.

      • fadeLength

        public short fadeLength
        Envelope - Duration of the fade.

      • fadeLevel

        public short fadeLevel
        Envelope - Level at the end of the fade.

    • Constructor Detail

      • SDL_HapticConstant

        public SDL_HapticConstant()

      • SDL_HapticConstant

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