org.lwjgl.system.windows.MSG Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.system.windows;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Contains message information from a thread's message queue.
*
* Member documentation
*
*
* - {@code hwnd} – a handle to the window whose window procedure receives the message. This member is {@code NULL} when the message is a thread message.
* - {@code message} – the message identifier. Applications can only use the low word; the high word is reserved by the system.
* - {@code wParam} – additional information about the message. The exact meaning depends on the value of the message member.
* - {@code lParam} – additional information about the message. The exact meaning depends on the value of the message member.
* - {@code time} – the time at which the message was posted
* - {@code pt} – the cursor position, in screen coordinates, when the message was posted.
*
*
* Layout
*
*
* struct MSG {
* HWND hwnd;
* UINT message;
* WPARAM wParam;
* LPARAM lParam;
* DWORD time;
* {@link POINT POINT} pt;
* }
*/
public class MSG extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
HWND,
MESSAGE,
WPARAM,
LPARAM,
TIME,
PT;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(4),
__member(POINT.SIZEOF, POINT.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
HWND = layout.offsetof(0);
MESSAGE = layout.offsetof(1);
WPARAM = layout.offsetof(2);
LPARAM = layout.offsetof(3);
TIME = layout.offsetof(4);
PT = layout.offsetof(5);
}
/**
* Creates a {@code MSG} instance at the current position of the specified {@link 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.
*/
public MSG(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code hwnd} field. */
@NativeType("HWND")
public long hwnd() { return nhwnd(address()); }
/** Returns the value of the {@code message} field. */
@NativeType("UINT")
public int message() { return nmessage(address()); }
/** Returns the value of the {@code wParam} field. */
@NativeType("WPARAM")
public long wParam() { return nwParam(address()); }
/** Returns the value of the {@code lParam} field. */
@NativeType("LPARAM")
public long lParam() { return nlParam(address()); }
/** Returns the value of the {@code time} field. */
@NativeType("DWORD")
public int time() { return ntime(address()); }
/** Returns a {@link POINT} view of the {@code pt} field. */
public POINT pt() { return npt(address()); }
/** Sets the specified value to the {@code hwnd} field. */
public MSG hwnd(@NativeType("HWND") long value) { nhwnd(address(), value); return this; }
/** Sets the specified value to the {@code message} field. */
public MSG message(@NativeType("UINT") int value) { nmessage(address(), value); return this; }
/** Sets the specified value to the {@code wParam} field. */
public MSG wParam(@NativeType("WPARAM") long value) { nwParam(address(), value); return this; }
/** Sets the specified value to the {@code lParam} field. */
public MSG lParam(@NativeType("LPARAM") long value) { nlParam(address(), value); return this; }
/** Sets the specified value to the {@code time} field. */
public MSG time(@NativeType("DWORD") int value) { ntime(address(), value); return this; }
/** Copies the specified {@link POINT} to the {@code pt} field. */
public MSG pt(POINT value) { npt(address(), value); return this; }
/** Passes the {@code pt} field to the specified {@link java.util.function.Consumer Consumer}. */
public MSG pt(java.util.function.Consumer consumer) { consumer.accept(pt()); return this; }
/** Initializes this struct with the specified values. */
public MSG set(
long hwnd,
int message,
long wParam,
long lParam,
int time,
POINT pt
) {
hwnd(hwnd);
message(message);
wParam(wParam);
lParam(lParam);
time(time);
pt(pt);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public MSG set(MSG src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code MSG} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static MSG malloc() {
return wrap(MSG.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code MSG} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static MSG calloc() {
return wrap(MSG.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code MSG} instance allocated with {@link BufferUtils}. */
public static MSG create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(MSG.class, memAddress(container), container);
}
/** Returns a new {@code MSG} instance for the specified memory address. */
public static MSG create(long address) {
return wrap(MSG.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static MSG createSafe(long address) {
return address == NULL ? null : wrap(MSG.class, address);
}
/**
* Returns a new {@link MSG.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static MSG.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link MSG.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static MSG.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link MSG.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static MSG.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link MSG.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static MSG.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static MSG.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Returns a new {@code MSG} instance allocated on the thread-local {@link MemoryStack}. */
public static MSG mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@code MSG} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static MSG callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@code MSG} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static MSG mallocStack(MemoryStack stack) {
return wrap(MSG.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code MSG} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static MSG callocStack(MemoryStack stack) {
return wrap(MSG.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link MSG.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static MSG.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link MSG.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static MSG.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link MSG.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static MSG.Buffer mallocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link MSG.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static MSG.Buffer callocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #hwnd}. */
public static long nhwnd(long struct) { return memGetAddress(struct + MSG.HWND); }
/** Unsafe version of {@link #message}. */
public static int nmessage(long struct) { return UNSAFE.getInt(null, struct + MSG.MESSAGE); }
/** Unsafe version of {@link #wParam}. */
public static long nwParam(long struct) { return memGetAddress(struct + MSG.WPARAM); }
/** Unsafe version of {@link #lParam}. */
public static long nlParam(long struct) { return memGetAddress(struct + MSG.LPARAM); }
/** Unsafe version of {@link #time}. */
public static int ntime(long struct) { return UNSAFE.getInt(null, struct + MSG.TIME); }
/** Unsafe version of {@link #pt}. */
public static POINT npt(long struct) { return POINT.create(struct + MSG.PT); }
/** Unsafe version of {@link #hwnd(long) hwnd}. */
public static void nhwnd(long struct, long value) { memPutAddress(struct + MSG.HWND, value); }
/** Unsafe version of {@link #message(int) message}. */
public static void nmessage(long struct, int value) { UNSAFE.putInt(null, struct + MSG.MESSAGE, value); }
/** Unsafe version of {@link #wParam(long) wParam}. */
public static void nwParam(long struct, long value) { memPutAddress(struct + MSG.WPARAM, value); }
/** Unsafe version of {@link #lParam(long) lParam}. */
public static void nlParam(long struct, long value) { memPutAddress(struct + MSG.LPARAM, value); }
/** Unsafe version of {@link #time(int) time}. */
public static void ntime(long struct, int value) { UNSAFE.putInt(null, struct + MSG.TIME, value); }
/** Unsafe version of {@link #pt(POINT) pt}. */
public static void npt(long struct, POINT value) { memCopy(value.address(), struct + MSG.PT, POINT.SIZEOF); }
// -----------------------------------
/** An array of {@link MSG} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final MSG ELEMENT_FACTORY = MSG.create(-1L);
/**
* Creates a new {@code MSG.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 {@link MSG#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected MSG getElementFactory() {
return ELEMENT_FACTORY;
}
/** Returns the value of the {@code hwnd} field. */
@NativeType("HWND")
public long hwnd() { return MSG.nhwnd(address()); }
/** Returns the value of the {@code message} field. */
@NativeType("UINT")
public int message() { return MSG.nmessage(address()); }
/** Returns the value of the {@code wParam} field. */
@NativeType("WPARAM")
public long wParam() { return MSG.nwParam(address()); }
/** Returns the value of the {@code lParam} field. */
@NativeType("LPARAM")
public long lParam() { return MSG.nlParam(address()); }
/** Returns the value of the {@code time} field. */
@NativeType("DWORD")
public int time() { return MSG.ntime(address()); }
/** Returns a {@link POINT} view of the {@code pt} field. */
public POINT pt() { return MSG.npt(address()); }
/** Sets the specified value to the {@code hwnd} field. */
public MSG.Buffer hwnd(@NativeType("HWND") long value) { MSG.nhwnd(address(), value); return this; }
/** Sets the specified value to the {@code message} field. */
public MSG.Buffer message(@NativeType("UINT") int value) { MSG.nmessage(address(), value); return this; }
/** Sets the specified value to the {@code wParam} field. */
public MSG.Buffer wParam(@NativeType("WPARAM") long value) { MSG.nwParam(address(), value); return this; }
/** Sets the specified value to the {@code lParam} field. */
public MSG.Buffer lParam(@NativeType("LPARAM") long value) { MSG.nlParam(address(), value); return this; }
/** Sets the specified value to the {@code time} field. */
public MSG.Buffer time(@NativeType("DWORD") int value) { MSG.ntime(address(), value); return this; }
/** Copies the specified {@link POINT} to the {@code pt} field. */
public MSG.Buffer pt(POINT value) { MSG.npt(address(), value); return this; }
/** Passes the {@code pt} field to the specified {@link java.util.function.Consumer Consumer}. */
public MSG.Buffer pt(java.util.function.Consumer consumer) { consumer.accept(pt()); return this; }
}
}