MOUSEINPUT (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.system.windows.MOUSEINPUT

All Implemented Interfaces:: java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class MOUSEINPUT
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource

Contains information about a simulated mouse event.

Member documentation

dx – the absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the value of the dwFlags member.
Absolute data is specified as the x coordinate of the mouse; relative data is specified as the number of pixels moved.
dy – the absolute position of the mouse, or the amount of motion since the last mouse event was generated, depending on the value of the dwFlags member.
Absolute data is specified as the y coordinate of the mouse; relative data is specified as the number of pixels moved.
mouseData – If dwFlags contains User32.MOUSEEVENTF_WHEEL, then mouseData 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 as User32.WHEEL_DELTA, which is 120.
Windows Vista: If dwFlags contains User32.MOUSEEVENTF_HWHEEL, then dwData 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 as WHEEL_DELTA, which is 120.

If dwFlags does not contain User32.MOUSEEVENTF_WHEEL, User32.MOUSEEVENTF_XDOWN, or User32.MOUSEEVENTF_XUP, then mouseData should be zero.

If dwFlags contains User32.MOUSEEVENTF_XDOWN or User32.MOUSEEVENTF_XUP, then mouseData 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 – 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 either User32.MOUSEEVENTF_XDOWN or User32.MOUSEEVENTF_XUP flags simultaneously in the dwFlags parameter, because they both require use of the mouseData field. One of:

`User32.MOUSEEVENTF_ABSOLUTE`	`User32.MOUSEEVENTF_HWHEEL`	`User32.MOUSEEVENTF_MOVE`	`User32.MOUSEEVENTF_MOVE_NOCOALESCE`
`User32.MOUSEEVENTF_LEFTDOWN`	`User32.MOUSEEVENTF_LEFTUP`	`User32.MOUSEEVENTF_RIGHTDOWN`	`User32.MOUSEEVENTF_RIGHTUP`
`User32.MOUSEEVENTF_MIDDLEDOWN`	`User32.MOUSEEVENTF_MIDDLEUP`	`User32.MOUSEEVENTF_VIRTUALDESK`	`User32.MOUSEEVENTF_WHEEL`
`User32.MOUSEEVENTF_XDOWN`	`User32.MOUSEEVENTF_XUP`

time – the time stamp for the event, in milliseconds. If this parameter is 0, the system will provide its own time stamp.
dwExtraInfo – an additional value associated with the mouse event. An application calls User32.GetMessageExtraInfo() to obtain this extra information.

Layout


 struct MOUSEINPUT {
     LONG dx;
     LONG dy;
     DWORD mouseData;
     DWORD dwFlags;
     DWORD time;
     ULONG_PTR dwExtraInfo;
 }

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MOUSEINPUT.Buffer
An array of MOUSEINPUT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`MOUSEINPUT.Buffer` An array of `MOUSEINPUT` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DWEXTRAINFO` The struct member offsets.
`static int`	`DWFLAGS` The struct member offsets.
`static int`	`DX` The struct member offsets.
`static int`	`DY` The struct member offsets.
`static int`	`MOUSEDATA` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`TIME` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

MOUSEINPUT(java.nio.ByteBuffer container)
Creates a MOUSEINPUT instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`MOUSEINPUT(java.nio.ByteBuffer container)` Creates a `MOUSEINPUT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MOUSEINPUT`	`calloc()` Returns a new `MOUSEINPUT` instance allocated with `memCalloc`.
`static MOUSEINPUT.Buffer`	`calloc(int capacity)` Returns a new `MOUSEINPUT.Buffer` instance allocated with `memCalloc`.
`static MOUSEINPUT`	`callocStack()` Returns a new `MOUSEINPUT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static MOUSEINPUT.Buffer`	`callocStack(int capacity)` Returns a new `MOUSEINPUT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static MOUSEINPUT.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `MOUSEINPUT.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static MOUSEINPUT`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `MOUSEINPUT` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static MOUSEINPUT`	`create()` Returns a new `MOUSEINPUT` instance allocated with `BufferUtils`.
`static MOUSEINPUT.Buffer`	`create(int capacity)` Returns a new `MOUSEINPUT.Buffer` instance allocated with `BufferUtils`.
`static MOUSEINPUT`	`create(long address)` Returns a new `MOUSEINPUT` instance for the specified memory address.
`static MOUSEINPUT.Buffer`	`create(long address, int capacity)` Create a `MOUSEINPUT.Buffer` instance at the specified memory.
`static MOUSEINPUT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static MOUSEINPUT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`dwExtraInfo()` Returns the value of the `dwExtraInfo` field.
`MOUSEINPUT`	`dwExtraInfo(long value)` Sets the specified value to the `dwExtraInfo` field.
`int`	`dwFlags()` Returns the value of the `dwFlags` field.
`MOUSEINPUT`	`dwFlags(int value)` Sets the specified value to the `dwFlags` field.
`int`	`dx()` Returns the value of the `dx` field.
`MOUSEINPUT`	`dx(int value)` Sets the specified value to the `dx` field.
`int`	`dy()` Returns the value of the `dy` field.
`MOUSEINPUT`	`dy(int value)` Sets the specified value to the `dy` field.
`static MOUSEINPUT`	`malloc()` Returns a new `MOUSEINPUT` instance allocated with `memAlloc`.
`static MOUSEINPUT.Buffer`	`malloc(int capacity)` Returns a new `MOUSEINPUT.Buffer` instance allocated with `memAlloc`.
`static MOUSEINPUT`	`mallocStack()` Returns a new `MOUSEINPUT` instance allocated on the thread-local `MemoryStack`.
`static MOUSEINPUT.Buffer`	`mallocStack(int capacity)` Returns a new `MOUSEINPUT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static MOUSEINPUT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `MOUSEINPUT.Buffer` instance allocated on the specified `MemoryStack`.
`static MOUSEINPUT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `MOUSEINPUT` instance allocated on the specified `MemoryStack`.
`int`	`mouseData()` Returns the value of the `mouseData` field.
`MOUSEINPUT`	`mouseData(int value)` Sets the specified value to the `mouseData` field.
`static long`	`ndwExtraInfo(long struct)` Unsafe version of `dwExtraInfo()`.
`static void`	`ndwExtraInfo(long struct, long value)` Unsafe version of `dwExtraInfo`.
`static int`	`ndwFlags(long struct)` Unsafe version of `dwFlags()`.
`static void`	`ndwFlags(long struct, int value)` Unsafe version of `dwFlags`.
`static int`	`ndx(long struct)` Unsafe version of `dx()`.
`static void`	`ndx(long struct, int value)` Unsafe version of `dx`.
`static int`	`ndy(long struct)` Unsafe version of `dy()`.
`static void`	`ndy(long struct, int value)` Unsafe version of `dy`.
`static int`	`nmouseData(long struct)` Unsafe version of `mouseData()`.
`static void`	`nmouseData(long struct, int value)` Unsafe version of `mouseData`.
`static int`	`ntime(long struct)` Unsafe version of `time()`.
`static void`	`ntime(long struct, int value)` Unsafe version of `time`.
`MOUSEINPUT`	`set(int dx, int dy, int mouseData, int dwFlags, int time, long dwExtraInfo)` Initializes this struct with the specified values.
`MOUSEINPUT`	`set(MOUSEINPUT src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`time()` Returns the value of the `time` field.
`MOUSEINPUT`	`time(int value)` Sets the specified value to the `time` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - DX
```
public static final int DX
```
    The struct member offsets.
  - DY
```
public static final int DY
```
    The struct member offsets.
  - MOUSEDATA
```
public static final int MOUSEDATA
```
    The struct member offsets.
  - DWFLAGS
```
public static final int DWFLAGS
```
    The struct member offsets.
  - TIME
```
public static final int TIME
```
    The struct member offsets.
  - DWEXTRAINFO
```
public static final int DWEXTRAINFO
```
    The struct member offsets.
- Constructor Detail
  - MOUSEINPUT
```
public MOUSEINPUT(java.nio.ByteBuffer container)
```
    Creates a MOUSEINPUT 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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - dx
```
public int dx()
```
    Returns the value of the dx field.
  - dy
```
public int dy()
```
    Returns the value of the dy field.
  - mouseData
```
public int mouseData()
```
    Returns the value of the mouseData field.
  - dwFlags
```
public int dwFlags()
```
    Returns the value of the dwFlags field.
  - time
```
public int time()
```
    Returns the value of the time field.
  - dwExtraInfo
```
public long dwExtraInfo()
```
    Returns the value of the dwExtraInfo field.
  - dx
```
public MOUSEINPUT dx(int value)
```
    Sets the specified value to the dx field.
  - dy
```
public MOUSEINPUT dy(int value)
```
    Sets the specified value to the dy field.
  - mouseData
```
public MOUSEINPUT mouseData(int value)
```
    Sets the specified value to the mouseData field.
  - dwFlags
```
public MOUSEINPUT dwFlags(int value)
```
    Sets the specified value to the dwFlags field.
  - time
```
public MOUSEINPUT time(int value)
```
    Sets the specified value to the time field.
  - dwExtraInfo
```
public MOUSEINPUT dwExtraInfo(long value)
```
    Sets the specified value to the dwExtraInfo field.
  - set
```
public MOUSEINPUT set(int dx,
                      int dy,
                      int mouseData,
                      int dwFlags,
                      int time,
                      long dwExtraInfo)
```
    Initializes this struct with the specified values.
  - set
```
public MOUSEINPUT set(MOUSEINPUT src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static MOUSEINPUT malloc()
```
    Returns a new MOUSEINPUT instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static MOUSEINPUT calloc()
```
    Returns a new MOUSEINPUT instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static MOUSEINPUT create()
```
    Returns a new MOUSEINPUT instance allocated with BufferUtils.
  - create
```
public static MOUSEINPUT create(long address)
```
    Returns a new MOUSEINPUT instance for the specified memory address.
  - createSafe
```
@Nullable
public static MOUSEINPUT createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static MOUSEINPUT.Buffer malloc(int capacity)
```
    Returns a new MOUSEINPUT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static MOUSEINPUT.Buffer calloc(int capacity)
```
    Returns a new MOUSEINPUT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static MOUSEINPUT.Buffer create(int capacity)
```
    Returns a new MOUSEINPUT.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static MOUSEINPUT.Buffer create(long address,
                                       int capacity)
```
    Create a MOUSEINPUT.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static MOUSEINPUT.Buffer createSafe(long address,
                                                     int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static MOUSEINPUT mallocStack()
```
    Returns a new MOUSEINPUT instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static MOUSEINPUT callocStack()
```
    Returns a new MOUSEINPUT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static MOUSEINPUT mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new MOUSEINPUT instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static MOUSEINPUT callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new MOUSEINPUT instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static MOUSEINPUT.Buffer mallocStack(int capacity)
```
    Returns a new MOUSEINPUT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static MOUSEINPUT.Buffer callocStack(int capacity)
```
    Returns a new MOUSEINPUT.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static MOUSEINPUT.Buffer mallocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new MOUSEINPUT.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static MOUSEINPUT.Buffer callocStack(int capacity,
                                            org.lwjgl.system.MemoryStack stack)
```
    Returns a new MOUSEINPUT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - ndx
```
public static int ndx(long struct)
```
    Unsafe version of dx().
  - ndy
```
public static int ndy(long struct)
```
    Unsafe version of dy().
  - nmouseData
```
public static int nmouseData(long struct)
```
    Unsafe version of mouseData().
  - ndwFlags
```
public static int ndwFlags(long struct)
```
    Unsafe version of dwFlags().
  - ntime
```
public static int ntime(long struct)
```
    Unsafe version of time().
  - ndwExtraInfo
```
public static long ndwExtraInfo(long struct)
```
    Unsafe version of dwExtraInfo().
  - ndx
```
public static void ndx(long struct,
                       int value)
```
    Unsafe version of dx.
  - ndy
```
public static void ndy(long struct,
                       int value)
```
    Unsafe version of dy.
  - nmouseData
```
public static void nmouseData(long struct,
                              int value)
```
    Unsafe version of mouseData.
  - ndwFlags
```
public static void ndwFlags(long struct,
                            int value)
```
    Unsafe version of dwFlags.
  - ntime
```
public static void ntime(long struct,
                         int value)
```
    Unsafe version of time.
  - ndwExtraInfo
```
public static void ndwExtraInfo(long struct,
                                long value)
```
    Unsafe version of dwExtraInfo.

Class MOUSEINPUT

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

DX

DY

MOUSEDATA

DWFLAGS

TIME

DWEXTRAINFO

Constructor Detail

MOUSEINPUT

Method Detail

sizeof

dx

dy

mouseData

dwFlags

time

dwExtraInfo

dx

dy

mouseData

dwFlags

time

dwExtraInfo

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndx

ndy

nmouseData

ndwFlags

ntime

ndwExtraInfo

ndx

ndy

nmouseData

ndwFlags

ntime

ndwExtraInfo