Class SDL_HapticEffect

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<SDL_HapticEffect>

org.lwjgl.sdl.SDL_HapticEffect

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class SDL_HapticEffect
extends Struct<SDL_HapticEffect>
implements NativeResource

union SDL_HapticEffect {
    Uint16 type;
    SDL_HapticConstant constant;
    SDL_HapticPeriodic periodic;
    SDL_HapticCondition condition;
    SDL_HapticRamp ramp;
    SDL_HapticLeftRight leftright;
    SDL_HapticCustom custom;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SDL_HapticEffect.Buffer	An array of SDL_HapticEffect structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CONDITION	The struct member offsets.
static final int	CONSTANT	The struct member offsets.
static final int	CUSTOM	The struct member offsets.
static final int	LEFTRIGHT	The struct member offsets.
static final int	PERIODIC	The struct member offsets.
static final int	RAMP	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
SDL_HapticEffect(ByteBuffer container)	Creates a SDL_HapticEffect instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static SDL_HapticEffect	calloc()	Returns a new SDL_HapticEffect instance allocated with memCalloc.
static SDL_HapticEffect.Buffer	calloc(int capacity)	Returns a new SDL_HapticEffect.Buffer instance allocated with memCalloc.
static SDL_HapticEffect.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new SDL_HapticEffect.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static SDL_HapticEffect	calloc(MemoryStack stack)	Returns a new SDL_HapticEffect instance allocated on the specified MemoryStack and initializes all its bits to zero.
SDL_HapticCondition	condition()
SDL_HapticEffect	condition(Consumer<SDL_HapticCondition> consumer)	Passes the condition field to the specified Consumer.
SDL_HapticEffect	condition(SDL_HapticCondition value)	Copies the specified SDL_HapticCondition to the condition field.
SDL_HapticConstant	constant()
SDL_HapticEffect	constant(Consumer<SDL_HapticConstant> consumer)	Passes the constant field to the specified Consumer.
SDL_HapticEffect	constant(SDL_HapticConstant value)	Copies the specified SDL_HapticConstant to the constant field.
static SDL_HapticEffect	create()	Returns a new SDL_HapticEffect instance allocated with BufferUtils.
static SDL_HapticEffect.Buffer	create(int capacity)	Returns a new SDL_HapticEffect.Buffer instance allocated with BufferUtils.
static SDL_HapticEffect	create(long address)	Returns a new SDL_HapticEffect instance for the specified memory address.
static SDL_HapticEffect.Buffer	create(long address, int capacity)	Create a SDL_HapticEffect.Buffer instance at the specified memory.
static @Nullable SDL_HapticEffect	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable SDL_HapticEffect.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
SDL_HapticCustom	custom()
SDL_HapticEffect	custom(Consumer<SDL_HapticCustom> consumer)	Passes the custom field to the specified Consumer.
SDL_HapticEffect	custom(SDL_HapticCustom value)	Copies the specified SDL_HapticCustom to the custom field.
SDL_HapticLeftRight	leftright()
SDL_HapticEffect	leftright(Consumer<SDL_HapticLeftRight> consumer)	Passes the leftright field to the specified Consumer.
SDL_HapticEffect	leftright(SDL_HapticLeftRight value)	Copies the specified SDL_HapticLeftRight to the leftright field.
static SDL_HapticEffect	malloc()	Returns a new SDL_HapticEffect instance allocated with memAlloc.
static SDL_HapticEffect.Buffer	malloc(int capacity)	Returns a new SDL_HapticEffect.Buffer instance allocated with memAlloc.
static SDL_HapticEffect.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new SDL_HapticEffect.Buffer instance allocated on the specified MemoryStack.
static SDL_HapticEffect	malloc(MemoryStack stack)	Returns a new SDL_HapticEffect instance allocated on the specified MemoryStack.
static SDL_HapticCondition	ncondition(long struct)	Unsafe version of condition().
static void	ncondition(long struct, SDL_HapticCondition value)	Unsafe version of condition.
static SDL_HapticConstant	nconstant(long struct)	Unsafe version of constant().
static void	nconstant(long struct, SDL_HapticConstant value)	Unsafe version of constant.
static SDL_HapticCustom	ncustom(long struct)	Unsafe version of custom().
static void	ncustom(long struct, SDL_HapticCustom value)	Unsafe version of custom.
static SDL_HapticLeftRight	nleftright(long struct)	Unsafe version of leftright().
static void	nleftright(long struct, SDL_HapticLeftRight value)	Unsafe version of leftright.
static SDL_HapticPeriodic	nperiodic(long struct)	Unsafe version of periodic().
static void	nperiodic(long struct, SDL_HapticPeriodic value)	Unsafe version of periodic.
static SDL_HapticRamp	nramp(long struct)	Unsafe version of ramp().
static void	nramp(long struct, SDL_HapticRamp value)	Unsafe version of ramp.
static short	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, short value)	Unsafe version of type.
SDL_HapticPeriodic	periodic()
SDL_HapticEffect	periodic(Consumer<SDL_HapticPeriodic> consumer)	Passes the periodic field to the specified Consumer.
SDL_HapticEffect	periodic(SDL_HapticPeriodic value)	Copies the specified SDL_HapticPeriodic to the periodic field.
SDL_HapticRamp	ramp()
SDL_HapticEffect	ramp(Consumer<SDL_HapticRamp> consumer)	Passes the ramp field to the specified Consumer.
SDL_HapticEffect	ramp(SDL_HapticRamp value)	Copies the specified SDL_HapticRamp to the ramp field.
SDL_HapticEffect	set(SDL_HapticEffect src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
short	type()
SDL_HapticEffect	type(short value)	Sets the specified value to the type field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

CONSTANT

public static final int CONSTANT

The struct member offsets.

PERIODIC

public static final int PERIODIC

The struct member offsets.

CONDITION

public static final int CONDITION

The struct member offsets.

RAMP

public static final int RAMP

The struct member offsets.

LEFTRIGHT

public static final int LEFTRIGHT

The struct member offsets.

CUSTOM

public static final int CUSTOM

The struct member offsets.

Constructor Details

SDL_HapticEffect

public SDL_HapticEffect(ByteBuffer container)

Creates a SDL_HapticEffect instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<SDL_HapticEffect>

type

@NativeType("Uint16")
public short type()

Returns:

the value of the type field.

constant

public SDL_HapticConstant constant()

Returns:

a SDL_HapticConstant view of the constant field.

periodic

public SDL_HapticPeriodic periodic()

Returns:

a SDL_HapticPeriodic view of the periodic field.

condition

public SDL_HapticCondition condition()

Returns:

a SDL_HapticCondition view of the condition field.

ramp

public SDL_HapticRamp ramp()

Returns:

a SDL_HapticRamp view of the ramp field.

leftright

public SDL_HapticLeftRight leftright()

Returns:

a SDL_HapticLeftRight view of the leftright field.

custom

public SDL_HapticCustom custom()

Returns:

a SDL_HapticCustom view of the custom field.

type

public SDL_HapticEffect type(@NativeType("Uint16")
 short value)

Sets the specified value to the type field.

constant

public SDL_HapticEffect constant(SDL_HapticConstant value)

Copies the specified SDL_HapticConstant to the constant field.

constant

public SDL_HapticEffect constant(Consumer<SDL_HapticConstant> consumer)

Passes the constant field to the specified Consumer.

periodic

public SDL_HapticEffect periodic(SDL_HapticPeriodic value)

Copies the specified SDL_HapticPeriodic to the periodic field.

periodic

public SDL_HapticEffect periodic(Consumer<SDL_HapticPeriodic> consumer)

Passes the periodic field to the specified Consumer.

condition

public SDL_HapticEffect condition(SDL_HapticCondition value)

Copies the specified SDL_HapticCondition to the condition field.

condition

public SDL_HapticEffect condition(Consumer<SDL_HapticCondition> consumer)

Passes the condition field to the specified Consumer.

ramp

public SDL_HapticEffect ramp(SDL_HapticRamp value)

Copies the specified SDL_HapticRamp to the ramp field.

ramp

public SDL_HapticEffect ramp(Consumer<SDL_HapticRamp> consumer)

Passes the ramp field to the specified Consumer.

leftright

public SDL_HapticEffect leftright(SDL_HapticLeftRight value)

Copies the specified SDL_HapticLeftRight to the leftright field.

leftright

public SDL_HapticEffect leftright(Consumer<SDL_HapticLeftRight> consumer)

Passes the leftright field to the specified Consumer.

custom

public SDL_HapticEffect custom(SDL_HapticCustom value)

Copies the specified SDL_HapticCustom to the custom field.

custom

public SDL_HapticEffect custom(Consumer<SDL_HapticCustom> consumer)

Passes the custom field to the specified Consumer.

set

public SDL_HapticEffect set(SDL_HapticEffect src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static SDL_HapticEffect malloc()

Returns a new SDL_HapticEffect instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static SDL_HapticEffect calloc()

Returns a new SDL_HapticEffect instance allocated with memCalloc. The instance must be explicitly freed.

create

public static SDL_HapticEffect create()

Returns a new SDL_HapticEffect instance allocated with BufferUtils.

create

public static SDL_HapticEffect create(long address)

Returns a new SDL_HapticEffect instance for the specified memory address.

createSafe

public static @Nullable SDL_HapticEffect createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static SDL_HapticEffect.Buffer malloc(int capacity)

Returns a new SDL_HapticEffect.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static SDL_HapticEffect.Buffer calloc(int capacity)

Returns a new SDL_HapticEffect.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static SDL_HapticEffect.Buffer create(int capacity)

Returns a new SDL_HapticEffect.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static SDL_HapticEffect.Buffer create(long address,
 int capacity)

Create a SDL_HapticEffect.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable SDL_HapticEffect.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static SDL_HapticEffect malloc(MemoryStack stack)

Returns a new SDL_HapticEffect instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static SDL_HapticEffect calloc(MemoryStack stack)

Returns a new SDL_HapticEffect instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static SDL_HapticEffect.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new SDL_HapticEffect.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static SDL_HapticEffect.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new SDL_HapticEffect.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static short ntype(long struct)

Unsafe version of type().

nconstant

public static SDL_HapticConstant nconstant(long struct)

Unsafe version of constant().

nperiodic

public static SDL_HapticPeriodic nperiodic(long struct)

Unsafe version of periodic().

ncondition

public static SDL_HapticCondition ncondition(long struct)

Unsafe version of condition().

nramp

public static SDL_HapticRamp nramp(long struct)

Unsafe version of ramp().

nleftright

public static SDL_HapticLeftRight nleftright(long struct)

Unsafe version of leftright().

ncustom

public static SDL_HapticCustom ncustom(long struct)

Unsafe version of custom().

ntype

public static void ntype(long struct,
 short value)

Unsafe version of type.

nconstant

public static void nconstant(long struct,
 SDL_HapticConstant value)

Unsafe version of constant.

nperiodic

public static void nperiodic(long struct,
 SDL_HapticPeriodic value)

Unsafe version of periodic.

ncondition

public static void ncondition(long struct,
 SDL_HapticCondition value)

Unsafe version of condition.

nramp

public static void nramp(long struct,
 SDL_HapticRamp value)

Unsafe version of ramp.

nleftright

public static void nleftright(long struct,
 SDL_HapticLeftRight value)

Unsafe version of leftright.

ncustom

public static void ncustom(long struct,
 SDL_HapticCustom value)

Unsafe version of custom.