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

Class SDL_HapticRamp

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

    This struct is exclusively for the SDL_HAPTIC_RAMP effect.

    The ramp effect starts at start strength and ends at end strength. It augments in linear fashion. If you use attack and fade with a ramp the effects get added to the ramp effect making the effect become quadratic instead of linear.

    See Also:
    SDL_HapticEffectType.SDL_HAPTIC_RAMP, 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

    • 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.

      • delay

        public short delay
        Delay before starting the effect.

      • button

        public short button
        Button that triggers the effect.

      • interval

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

      • start

        public short start
        Beginning strength level.

      • end

        public short end
        Ending strength level.

      • attackLength

        public short attackLength
        Duration of the attack.

      • attackLevel

        public short attackLevel
        Level at the start of the attack.

      • fadeLength

        public short fadeLength
        Duration of the fade.

      • fadeLevel

        public short fadeLevel
        Level at the end of the fade.

    • Constructor Detail

      • SDL_HapticRamp

        public SDL_HapticRamp()

      • SDL_HapticRamp

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