org.lwjgl.system.windows.DISPLAY_DEVICE 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.*;
/**
* Receives information about the display device specified by the {@code iDevNum} parameter of the {@link User32#EnumDisplayDevices} function.
*
* The four string members are set based on the parameters passed to {@code EnumDisplayDevices}. If the {@code lpDevice} param is {@code NULL}, then
* {@code DISPLAY_DEVICE} is filled in with information about the display adapter(s). If it is a valid device name, then it is filled in with information
* about the monitor(s) for that device.
*
* Member documentation
*
*
* - {@code cb} – size, in bytes, of the {@code DISPLAY_DEVICE} structure. This must be initialized prior to calling {@link User32#EnumDisplayDevices}.
* - {@code DeviceName} – an array of characters identifying the device name. This is either the adapter device or the monitor device.
* - {@code DeviceString} – an array of characters containing the device context string. This is either a description of the display adapter or of the display monitor.
* - {@code StateFlags} – device state flags
* - {@code DeviceID} – not used
* - {@code DeviceKey} – reserved
*
*
* Layout
*
*
* struct DISPLAY_DEVICE {
* DWORD cb;
* TCHAR DeviceName[32];
* TCHAR DeviceString[128];
* DWORD StateFlags;
* TCHAR DeviceID[128];
* TCHAR DeviceKey[128];
* }The created instance holds a strong reference to the container object.
*/
public DISPLAY_DEVICE(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code cb} field. */
@NativeType("DWORD")
public int cb() { return ncb(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceName} field. */
@NativeType("TCHAR[32]")
public ByteBuffer DeviceName() { return nDeviceName(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceName} field. */
@NativeType("TCHAR[32]")
public String DeviceNameString() { return nDeviceNameString(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceString} field. */
@NativeType("TCHAR[128]")
public ByteBuffer DeviceString() { return nDeviceString(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceString} field. */
@NativeType("TCHAR[128]")
public String DeviceStringString() { return nDeviceStringString(address()); }
/** Returns the value of the {@code StateFlags} field. */
@NativeType("DWORD")
public int StateFlags() { return nStateFlags(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceID} field. */
@NativeType("TCHAR[128]")
public ByteBuffer DeviceID() { return nDeviceID(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceID} field. */
@NativeType("TCHAR[128]")
public String DeviceIDString() { return nDeviceIDString(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceKey} field. */
@NativeType("TCHAR[128]")
public ByteBuffer DeviceKey() { return nDeviceKey(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceKey} field. */
@NativeType("TCHAR[128]")
public String DeviceKeyString() { return nDeviceKeyString(address()); }
/** Sets the specified value to the {@code cb} field. */
public DISPLAY_DEVICE cb(@NativeType("DWORD") int value) { ncb(address(), value); return this; }
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public DISPLAY_DEVICE set(DISPLAY_DEVICE src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link DISPLAY_DEVICE} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static DISPLAY_DEVICE malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link DISPLAY_DEVICE} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static DISPLAY_DEVICE calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link DISPLAY_DEVICE} instance allocated with {@link BufferUtils}. */
public static DISPLAY_DEVICE create() {
return new DISPLAY_DEVICE(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link DISPLAY_DEVICE} instance for the specified memory address. */
public static DISPLAY_DEVICE create(long address) {
return new DISPLAY_DEVICE(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static DISPLAY_DEVICE createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link DISPLAY_DEVICE.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link DISPLAY_DEVICE.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link DISPLAY_DEVICE.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link DISPLAY_DEVICE.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static DISPLAY_DEVICE.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link DISPLAY_DEVICE} instance allocated on the thread-local {@link MemoryStack}. */
public static DISPLAY_DEVICE mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link DISPLAY_DEVICE} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static DISPLAY_DEVICE callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link DISPLAY_DEVICE} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static DISPLAY_DEVICE mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link DISPLAY_DEVICE} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static DISPLAY_DEVICE callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link DISPLAY_DEVICE.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link DISPLAY_DEVICE.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link DISPLAY_DEVICE.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static DISPLAY_DEVICE.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link DISPLAY_DEVICE.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 DISPLAY_DEVICE.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #cb}. */
public static int ncb(long struct) { return memGetInt(struct + DISPLAY_DEVICE.CB); }
/** Unsafe version of {@link #DeviceName}. */
public static ByteBuffer nDeviceName(long struct) { return memByteBuffer(struct + DISPLAY_DEVICE.DEVICENAME, 32 * 2); }
/** Unsafe version of {@link #DeviceNameString}. */
public static String nDeviceNameString(long struct) { return memUTF16(struct + DISPLAY_DEVICE.DEVICENAME); }
/** Unsafe version of {@link #DeviceString}. */
public static ByteBuffer nDeviceString(long struct) { return memByteBuffer(struct + DISPLAY_DEVICE.DEVICESTRING, 128 * 2); }
/** Unsafe version of {@link #DeviceStringString}. */
public static String nDeviceStringString(long struct) { return memUTF16(struct + DISPLAY_DEVICE.DEVICESTRING); }
/** Unsafe version of {@link #StateFlags}. */
public static int nStateFlags(long struct) { return memGetInt(struct + DISPLAY_DEVICE.STATEFLAGS); }
/** Unsafe version of {@link #DeviceID}. */
public static ByteBuffer nDeviceID(long struct) { return memByteBuffer(struct + DISPLAY_DEVICE.DEVICEID, 128 * 2); }
/** Unsafe version of {@link #DeviceIDString}. */
public static String nDeviceIDString(long struct) { return memUTF16(struct + DISPLAY_DEVICE.DEVICEID); }
/** Unsafe version of {@link #DeviceKey}. */
public static ByteBuffer nDeviceKey(long struct) { return memByteBuffer(struct + DISPLAY_DEVICE.DEVICEKEY, 128 * 2); }
/** Unsafe version of {@link #DeviceKeyString}. */
public static String nDeviceKeyString(long struct) { return memUTF16(struct + DISPLAY_DEVICE.DEVICEKEY); }
/** Unsafe version of {@link #cb(int) cb}. */
public static void ncb(long struct, int value) { memPutInt(struct + DISPLAY_DEVICE.CB, value); }
// -----------------------------------
/** An array of {@link DISPLAY_DEVICE} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link DISPLAY_DEVICE.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 DISPLAY_DEVICE#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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected DISPLAY_DEVICE newInstance(long address) {
return new DISPLAY_DEVICE(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code cb} field. */
@NativeType("DWORD")
public int cb() { return DISPLAY_DEVICE.ncb(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceName} field. */
@NativeType("TCHAR[32]")
public ByteBuffer DeviceName() { return DISPLAY_DEVICE.nDeviceName(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceName} field. */
@NativeType("TCHAR[32]")
public String DeviceNameString() { return DISPLAY_DEVICE.nDeviceNameString(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceString} field. */
@NativeType("TCHAR[128]")
public ByteBuffer DeviceString() { return DISPLAY_DEVICE.nDeviceString(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceString} field. */
@NativeType("TCHAR[128]")
public String DeviceStringString() { return DISPLAY_DEVICE.nDeviceStringString(address()); }
/** Returns the value of the {@code StateFlags} field. */
@NativeType("DWORD")
public int StateFlags() { return DISPLAY_DEVICE.nStateFlags(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceID} field. */
@NativeType("TCHAR[128]")
public ByteBuffer DeviceID() { return DISPLAY_DEVICE.nDeviceID(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceID} field. */
@NativeType("TCHAR[128]")
public String DeviceIDString() { return DISPLAY_DEVICE.nDeviceIDString(address()); }
/** Returns a {@link ByteBuffer} view of the {@code DeviceKey} field. */
@NativeType("TCHAR[128]")
public ByteBuffer DeviceKey() { return DISPLAY_DEVICE.nDeviceKey(address()); }
/** Decodes the null-terminated string stored in the {@code DeviceKey} field. */
@NativeType("TCHAR[128]")
public String DeviceKeyString() { return DISPLAY_DEVICE.nDeviceKeyString(address()); }
/** Sets the specified value to the {@code cb} field. */
public DISPLAY_DEVICE.Buffer cb(@NativeType("DWORD") int value) { DISPLAY_DEVICE.ncb(address(), value); return this; }
}
}