Class MOUSEINPUT
- All Implemented Interfaces:
AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
Layout
struct MOUSEINPUT {
LONG dx()
;
LONG dy()
;
DWORD mouseData()
;
DWORD dwFlags()
;
DWORD time()
;
ULONG_PTR dwExtraInfo()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionMOUSEINPUT
(ByteBuffer container) Creates aMOUSEINPUT
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic MOUSEINPUT
calloc()
Returns a newMOUSEINPUT
instance allocated withmemCalloc
.static MOUSEINPUT.Buffer
calloc
(int capacity) Returns a newMOUSEINPUT.Buffer
instance allocated withmemCalloc
.static MOUSEINPUT.Buffer
calloc
(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newMOUSEINPUT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static MOUSEINPUT
calloc
(org.lwjgl.system.MemoryStack stack) Returns a newMOUSEINPUT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static MOUSEINPUT
Deprecated.static MOUSEINPUT.Buffer
callocStack
(int capacity) Deprecated.static MOUSEINPUT.Buffer
callocStack
(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static MOUSEINPUT
callocStack
(org.lwjgl.system.MemoryStack stack) Deprecated.static MOUSEINPUT
create()
Returns a newMOUSEINPUT
instance allocated withBufferUtils
.static MOUSEINPUT.Buffer
create
(int capacity) Returns a newMOUSEINPUT.Buffer
instance allocated withBufferUtils
.static MOUSEINPUT
create
(long address) Returns a newMOUSEINPUT
instance for the specified memory address.static MOUSEINPUT.Buffer
create
(long address, int capacity) Create aMOUSEINPUT.Buffer
instance at the specified memory.static MOUSEINPUT
createSafe
(long address) static MOUSEINPUT.Buffer
createSafe
(long address, int capacity) long
an additional value associated with the mouse event.dwExtraInfo
(long value) Sets the specified value to thedwExtraInfo()
field.int
dwFlags()
A set of bit flags that specify various aspects of mouse motion and button clicks.dwFlags
(int value) Sets the specified value to thedwFlags()
field.int
dx()
the absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the value of thedwFlags
member.dx
(int value) Sets the specified value to thedx()
field.int
dy()
the absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the value of thedwFlags
member.dy
(int value) Sets the specified value to thedy()
field.static MOUSEINPUT
malloc()
Returns a newMOUSEINPUT
instance allocated withmemAlloc
.static MOUSEINPUT.Buffer
malloc
(int capacity) Returns a newMOUSEINPUT.Buffer
instance allocated withmemAlloc
.static MOUSEINPUT.Buffer
malloc
(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newMOUSEINPUT.Buffer
instance allocated on the specifiedMemoryStack
.static MOUSEINPUT
malloc
(org.lwjgl.system.MemoryStack stack) Returns a newMOUSEINPUT
instance allocated on the specifiedMemoryStack
.static MOUSEINPUT
Deprecated.static MOUSEINPUT.Buffer
mallocStack
(int capacity) Deprecated.static MOUSEINPUT.Buffer
mallocStack
(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static MOUSEINPUT
mallocStack
(org.lwjgl.system.MemoryStack stack) Deprecated.int
IfdwFlags
containsUser32.MOUSEEVENTF_WHEEL
, thenmouseData
specifies the amount of wheel movement.mouseData
(int value) Sets the specified value to themouseData()
field.static long
ndwExtraInfo
(long struct) Unsafe version ofdwExtraInfo()
.static void
ndwExtraInfo
(long struct, long value) Unsafe version ofdwExtraInfo
.static int
ndwFlags
(long struct) Unsafe version ofdwFlags()
.static void
ndwFlags
(long struct, int value) Unsafe version ofdwFlags
.static int
ndx
(long struct) Unsafe version ofdx()
.static void
ndx
(long struct, int value) Unsafe version ofdx
.static int
ndy
(long struct) Unsafe version ofdy()
.static void
ndy
(long struct, int value) Unsafe version ofdy
.static int
nmouseData
(long struct) Unsafe version ofmouseData()
.static void
nmouseData
(long struct, int value) Unsafe version ofmouseData
.static int
ntime
(long struct) Unsafe version oftime()
.static void
ntime
(long struct, int value) Unsafe version oftime
.set
(int dx, int dy, int mouseData, int dwFlags, int time, long dwExtraInfo) Initializes this struct with the specified values.set
(MOUSEINPUT src) Copies the specified struct data to this struct.int
sizeof()
int
time()
the time stamp for the event, in milliseconds.time
(int value) Sets the specified value to thetime()
field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
DX
public static final int DXThe struct member offsets. -
DY
public static final int DYThe struct member offsets. -
MOUSEDATA
public static final int MOUSEDATAThe struct member offsets. -
DWFLAGS
public static final int DWFLAGSThe struct member offsets. -
TIME
public static final int TIMEThe struct member offsets. -
DWEXTRAINFO
public static final int DWEXTRAINFOThe struct member offsets.
-
-
Constructor Details
-
MOUSEINPUT
Creates aMOUSEINPUT
instance at the current position of the specifiedByteBuffer
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()- Specified by:
sizeof
in classorg.lwjgl.system.Struct<MOUSEINPUT>
-
dx
public int dx()the absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the value of thedwFlags
member.Absolute data is specified as the x coordinate of the mouse; relative data is specified as the number of pixels moved.
-
dy
public int dy()the absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the value of thedwFlags
member.Absolute data is specified as the y coordinate of the mouse; relative data is specified as the number of pixels moved.
-
mouseData
public int mouseData()IfdwFlags
containsUser32.MOUSEEVENTF_WHEEL
, thenmouseData
specifies the amount of wheel movement. A positive value indicates that the wheel was rotated forward, away from the user; a negative value indicates that the wheel was rotated backward, toward the user. One wheel click is defined asUser32.WHEEL_DELTA
, which is 120.Windows Vista: If
dwFlags
containsUser32.MOUSEEVENTF_HWHEEL
, thendwData
specifies the amount of wheel movement. A positive value indicates that the wheel was rotated to the right; a negative value indicates that the wheel was rotated to the left. One wheel click is defined asWHEEL_DELTA
, which is 120.If
dwFlags
does not containUser32.MOUSEEVENTF_WHEEL
,User32.MOUSEEVENTF_XDOWN
, orUser32.MOUSEEVENTF_XUP
, thenmouseData
should be zero.If
dwFlags
containsUser32.MOUSEEVENTF_XDOWN
orUser32.MOUSEEVENTF_XUP
, thenmouseData
specifies which X buttons were pressed or released. This value may be any combination of the following flags:User32.XBUTTON1
,User32.XBUTTON2
. One of:User32.XBUTTON1
User32.XBUTTON2
-
dwFlags
public int dwFlags()A set of bit flags that specify various aspects of mouse motion and button clicks.The bit flags that specify mouse button status are set to indicate changes in status, not ongoing conditions. For example, if the left mouse button is pressed and held down,
User32.MOUSEEVENTF_LEFTDOWN
is set when the left button is first pressed, but not for subsequent motions. Similarly,User32.MOUSEEVENTF_LEFTUP
is set only when the button is first released.You cannot specify both the
User32.MOUSEEVENTF_WHEEL
flag and eitherUser32.MOUSEEVENTF_XDOWN
orUser32.MOUSEEVENTF_XUP
flags simultaneously in thedwFlags
parameter, because they both require use of themouseData
field. One of: -
time
public int time()the time stamp for the event, in milliseconds. If this parameter is 0, the system will provide its own time stamp. -
dwExtraInfo
public long dwExtraInfo()an additional value associated with the mouse event. An application callsUser32.GetMessageExtraInfo()
to obtain this extra information. -
dx
Sets the specified value to thedx()
field. -
dy
Sets the specified value to thedy()
field. -
mouseData
Sets the specified value to themouseData()
field. -
dwFlags
Sets the specified value to thedwFlags()
field. -
time
Sets the specified value to thetime()
field. -
dwExtraInfo
Sets the specified value to thedwExtraInfo()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newMOUSEINPUT
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newMOUSEINPUT
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newMOUSEINPUT
instance allocated withBufferUtils
. -
create
Returns a newMOUSEINPUT
instance for the specified memory address. -
createSafe
-
malloc
Returns a newMOUSEINPUT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newMOUSEINPUT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newMOUSEINPUT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aMOUSEINPUT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static MOUSEINPUT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static MOUSEINPUT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newMOUSEINPUT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newMOUSEINPUT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newMOUSEINPUT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newMOUSEINPUT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
ndx
public static int ndx(long struct) Unsafe version ofdx()
. -
ndy
public static int ndy(long struct) Unsafe version ofdy()
. -
nmouseData
public static int nmouseData(long struct) Unsafe version ofmouseData()
. -
ndwFlags
public static int ndwFlags(long struct) Unsafe version ofdwFlags()
. -
ntime
public static int ntime(long struct) Unsafe version oftime()
. -
ndwExtraInfo
public static long ndwExtraInfo(long struct) Unsafe version ofdwExtraInfo()
. -
ndx
public static void ndx(long struct, int value) Unsafe version ofdx
. -
ndy
public static void ndy(long struct, int value) Unsafe version ofdy
. -
nmouseData
public static void nmouseData(long struct, int value) Unsafe version ofmouseData
. -
ndwFlags
public static void ndwFlags(long struct, int value) Unsafe version ofdwFlags
. -
ntime
public static void ntime(long struct, int value) Unsafe version oftime
. -
ndwExtraInfo
public static void ndwExtraInfo(long struct, long value) Unsafe version ofdwExtraInfo
.
-