Top Description Inners Fields Constructors Methods
org.lwjgl.system.windows

public Class HARDWAREINPUT

extends Struct<HARDWAREINPUT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Contains information about a simulated message generated by an input device other than a keyboard or mouse.

Layout


struct HARDWAREINPUT {
    DWORD uMsg;
    WORD wParamL;
    WORD wParamH;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
HARDWAREINPUT.Buffer

An array of HARDWAREINPUT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SIZEOF

The struct size in bytes.

public static final int
UMSG

The struct member offsets.

public static final int
WPARAMH

The struct member offsets.

public static final int
WPARAML

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
HARDWAREINPUT(long address, ByteBuffer container)

public
HARDWAREINPUT(ByteBuffer container)

Creates a HARDWAREINPUT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static HARDWAREINPUT
calloc()

Returns a new HARDWAREINPUT instance allocated with memCalloc.

public static HARDWAREINPUT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new HARDWAREINPUT.Buffer instance allocated with memCalloc.

public static HARDWAREINPUT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static HARDWAREINPUT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static HARDWAREINPUT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static HARDWAREINPUT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static HARDWAREINPUT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static HARDWAREINPUT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected HARDWAREINPUT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static HARDWAREINPUT
create()

Returns a new HARDWAREINPUT instance allocated with BufferUtils.

public static HARDWAREINPUT
create(long address)

Returns a new HARDWAREINPUT instance for the specified memory address.

public static HARDWAREINPUT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new HARDWAREINPUT.Buffer instance allocated with BufferUtils.

public static HARDWAREINPUT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a HARDWAREINPUT.Buffer instance at the specified memory.

public static HARDWAREINPUT
createSafe(long address)

Like create, but returns null if address is NULL.

public static HARDWAREINPUT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static HARDWAREINPUT
malloc()

Returns a new HARDWAREINPUT instance allocated with memAlloc.

public static HARDWAREINPUT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new HARDWAREINPUT.Buffer instance allocated with memAlloc.

public static HARDWAREINPUT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new HARDWAREINPUT instance allocated on the specified MemoryStack.

public static HARDWAREINPUT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static HARDWAREINPUT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static HARDWAREINPUT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static HARDWAREINPUT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static HARDWAREINPUT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nuMsg(long struct)

Unsafe version of uMsg.

public static void
nuMsg(long struct, int value)

Unsafe version of uMsg.

public static short
nwParamH(long struct)

Unsafe version of wParamH.

public static void
nwParamH(long struct, short value)

Unsafe version of wParamH.

public static short
nwParamL(long struct)

Unsafe version of wParamL.

public static void
nwParamL(long struct, short value)

Unsafe version of wParamL.

public HARDWAREINPUT
set(int uMsg, short wParamL, short wParamH)

Initializes this struct with the specified values.

public HARDWAREINPUT

Returns:

this struct
set
(HARDWAREINPUT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
uMsg()

the message generated by the input hardware

public HARDWAREINPUT
uMsg(int value)

Sets the specified value to the uMsg field.

public short
wParamH()

the high-order word of the lParam parameter for uMsg

public HARDWAREINPUT
wParamH(short value)

Sets the specified value to the wParamH field.

public short
wParamL()

the low-order word of the lParam parameter for uMsg

public HARDWAREINPUT
wParamL(short value)

Sets the specified value to the wParamL field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

UMSGback to summary
public static final int UMSG

The struct member offsets.

WPARAMHback to summary
public static final int WPARAMH

The struct member offsets.

WPARAMLback to summary
public static final int WPARAML

The struct member offsets.

Constructor Detail

HARDWAREINPUTback to summary
protected HARDWAREINPUT(long address, ByteBuffer container)
HARDWAREINPUTback to summary
public HARDWAREINPUT(ByteBuffer container)

Creates a HARDWAREINPUT 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 Detail

callocback to summary
public static HARDWAREINPUT calloc()

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

callocback to summary
public static HARDWAREINPUT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static HARDWAREINPUT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static HARDWAREINPUT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static HARDWAREINPUT callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static HARDWAREINPUT callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static HARDWAREINPUT.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static HARDWAREINPUT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected HARDWAREINPUT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static HARDWAREINPUT create()

Returns a new HARDWAREINPUT instance allocated with BufferUtils.

createback to summary
public static HARDWAREINPUT create(long address)

Returns a new HARDWAREINPUT instance for the specified memory address.

createback to summary
public static HARDWAREINPUT.Buffer create(int capacity)

Returns a new HARDWAREINPUT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static HARDWAREINPUT.Buffer create(long address, int capacity)

Create a HARDWAREINPUT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static HARDWAREINPUT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static HARDWAREINPUT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static HARDWAREINPUT malloc()

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

mallocback to summary
public static HARDWAREINPUT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static HARDWAREINPUT malloc(MemoryStack stack)

Returns a new HARDWAREINPUT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static HARDWAREINPUT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static HARDWAREINPUT mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static HARDWAREINPUT mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static HARDWAREINPUT.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static HARDWAREINPUT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nuMsgback to summary
public static int nuMsg(long struct)

Unsafe version of uMsg.

nuMsgback to summary
public static void nuMsg(long struct, int value)

Unsafe version of uMsg.

nwParamHback to summary
public static short nwParamH(long struct)

Unsafe version of wParamH.

nwParamHback to summary
public static void nwParamH(long struct, short value)

Unsafe version of wParamH.

nwParamLback to summary
public static short nwParamL(long struct)

Unsafe version of wParamL.

nwParamLback to summary
public static void nwParamL(long struct, short value)

Unsafe version of wParamL.

setback to summary
public HARDWAREINPUT set(int uMsg, short wParamL, short wParamH)

Initializes this struct with the specified values.

setback to summary
public HARDWAREINPUT set(HARDWAREINPUT src)

Copies the specified struct data to this struct.

Parameters
src:HARDWAREINPUT

the source struct

Returns:HARDWAREINPUT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
uMsgback to summary
public int uMsg()

the message generated by the input hardware

Annotations
@NativeType:DWORD
uMsgback to summary
public HARDWAREINPUT uMsg(int value)

Sets the specified value to the uMsg field.

wParamHback to summary
public short wParamH()

the high-order word of the lParam parameter for uMsg

Annotations
@NativeType:WORD
wParamHback to summary
public HARDWAREINPUT wParamH(short value)

Sets the specified value to the wParamH field.

wParamLback to summary
public short wParamL()

the low-order word of the lParam parameter for uMsg

Annotations
@NativeType:WORD
wParamLback to summary
public HARDWAREINPUT wParamL(short value)

Sets the specified value to the wParamL field.

org.lwjgl.system.windows back to summary

public Class HARDWAREINPUT.Buffer

extends StructBuffer<HARDWAREINPUT, HARDWAREINPUT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of HARDWAREINPUT structs.

Field Summary

Modifier and TypeField and Description
private static final HARDWAREINPUT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new HARDWAREINPUT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected HARDWAREINPUT
protected HARDWAREINPUT.Buffer
public int

Returns:

the value of the HARDWAREINPUT#uMsg field.
uMsg
()

public HARDWAREINPUT.Buffer
uMsg(int value)

Sets the specified value to the HARDWAREINPUT#uMsg field.

public short

Returns:

the value of the HARDWAREINPUT#wParamH field.
wParamH
()

public HARDWAREINPUT.Buffer
wParamH(short value)

Sets the specified value to the HARDWAREINPUT#wParamH field.

public short

Returns:

the value of the HARDWAREINPUT#wParamL field.
wParamL
()

public HARDWAREINPUT.Buffer
wParamL(short value)

Sets the specified value to the HARDWAREINPUT#wParamL field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final HARDWAREINPUT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new HARDWAREINPUT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by HARDWAREINPUT#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected HARDWAREINPUT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected HARDWAREINPUT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
uMsgback to summary
public int uMsg()
Returns:int

the value of the HARDWAREINPUT#uMsg field.

Annotations
@NativeType:DWORD
uMsgback to summary
public HARDWAREINPUT.Buffer uMsg(int value)

Sets the specified value to the HARDWAREINPUT#uMsg field.

wParamHback to summary
public short wParamH()
Returns:short

the value of the HARDWAREINPUT#wParamH field.

Annotations
@NativeType:WORD
wParamHback to summary
public HARDWAREINPUT.Buffer wParamH(short value)

Sets the specified value to the HARDWAREINPUT#wParamH field.

wParamLback to summary
public short wParamL()
Returns:short

the value of the HARDWAREINPUT#wParamL field.

Annotations
@NativeType:WORD
wParamLback to summary
public HARDWAREINPUT.Buffer wParamL(short value)

Sets the specified value to the HARDWAREINPUT#wParamL field.