Package org.lwjgl.system.windows

Class WINDOWPLACEMENT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<WINDOWPLACEMENT>

org.lwjgl.system.windows.WINDOWPLACEMENT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class WINDOWPLACEMENT
extends Struct<WINDOWPLACEMENT>
implements NativeResource

Contains information about the placement of a window on the screen.

Layout

 struct WINDOWPLACEMENT {
     UINT length();
     UINT flags();
     UINT showCmd();
     POINT ptMinPosition();
     POINT ptMaxPosition();
     RECT rcNormalPosition();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WINDOWPLACEMENT.Buffer	An array of WINDOWPLACEMENT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	LENGTH	The struct member offsets.
static final int	PTMAXPOSITION	The struct member offsets.
static final int	PTMINPOSITION	The struct member offsets.
static final int	RCNORMALPOSITION	The struct member offsets.
static final int	SHOWCMD	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
WINDOWPLACEMENT(ByteBuffer container)	Creates a WINDOWPLACEMENT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static WINDOWPLACEMENT	calloc()	Returns a new WINDOWPLACEMENT instance allocated with memCalloc.
static WINDOWPLACEMENT.Buffer	calloc(int capacity)	Returns a new WINDOWPLACEMENT.Buffer instance allocated with memCalloc.
static WINDOWPLACEMENT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new WINDOWPLACEMENT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static WINDOWPLACEMENT	calloc(MemoryStack stack)	Returns a new WINDOWPLACEMENT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static WINDOWPLACEMENT	callocStack()	Deprecated.
static WINDOWPLACEMENT.Buffer	callocStack(int capacity)	Deprecated.
static WINDOWPLACEMENT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static WINDOWPLACEMENT	callocStack(MemoryStack stack)	Deprecated.
static WINDOWPLACEMENT	create()	Returns a new WINDOWPLACEMENT instance allocated with BufferUtils.
static WINDOWPLACEMENT.Buffer	create(int capacity)	Returns a new WINDOWPLACEMENT.Buffer instance allocated with BufferUtils.
static WINDOWPLACEMENT	create(long address)	Returns a new WINDOWPLACEMENT instance for the specified memory address.
static WINDOWPLACEMENT.Buffer	create(long address, int capacity)	Create a WINDOWPLACEMENT.Buffer instance at the specified memory.
static WINDOWPLACEMENT	createSafe(long address)	Like create, but returns null if address is NULL.
static WINDOWPLACEMENT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	the flags that control the position of the minimized window and the method by which the window is restored.
WINDOWPLACEMENT	flags(int value)	Sets the specified value to the flags() field.
int	length()	the length of the structure, in bytes.
WINDOWPLACEMENT	length(int value)	Sets the specified value to the length() field.
static WINDOWPLACEMENT	malloc()	Returns a new WINDOWPLACEMENT instance allocated with memAlloc.
static WINDOWPLACEMENT.Buffer	malloc(int capacity)	Returns a new WINDOWPLACEMENT.Buffer instance allocated with memAlloc.
static WINDOWPLACEMENT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new WINDOWPLACEMENT.Buffer instance allocated on the specified MemoryStack.
static WINDOWPLACEMENT	malloc(MemoryStack stack)	Returns a new WINDOWPLACEMENT instance allocated on the specified MemoryStack.
static WINDOWPLACEMENT	mallocStack()	Deprecated.
static WINDOWPLACEMENT.Buffer	mallocStack(int capacity)	Deprecated.
static WINDOWPLACEMENT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static WINDOWPLACEMENT	mallocStack(MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static int	nlength(long struct)	Unsafe version of length().
static void	nlength(long struct, int value)	Unsafe version of length.
static POINT	nptMaxPosition(long struct)	Unsafe version of ptMaxPosition().
static void	nptMaxPosition(long struct, POINT value)	Unsafe version of ptMaxPosition.
static POINT	nptMinPosition(long struct)	Unsafe version of ptMinPosition().
static void	nptMinPosition(long struct, POINT value)	Unsafe version of ptMinPosition.
static RECT	nrcNormalPosition(long struct)	Unsafe version of rcNormalPosition().
static void	nrcNormalPosition(long struct, RECT value)	Unsafe version of rcNormalPosition.
static int	nshowCmd(long struct)	Unsafe version of showCmd().
static void	nshowCmd(long struct, int value)	Unsafe version of showCmd.
POINT	ptMaxPosition()	the coordinates of the window's upper-left corner when the window is maximized
WINDOWPLACEMENT	ptMaxPosition(Consumer<POINT> consumer)	Passes the ptMaxPosition() field to the specified Consumer.
WINDOWPLACEMENT	ptMaxPosition(POINT value)	Copies the specified POINT to the ptMaxPosition() field.
POINT	ptMinPosition()	the coordinates of the window's upper-left corner when the window is minimized
WINDOWPLACEMENT	ptMinPosition(Consumer<POINT> consumer)	Passes the ptMinPosition() field to the specified Consumer.
WINDOWPLACEMENT	ptMinPosition(POINT value)	Copies the specified POINT to the ptMinPosition() field.
RECT	rcNormalPosition()	the window's coordinates when the window is in the restored position
WINDOWPLACEMENT	rcNormalPosition(Consumer<RECT> consumer)	Passes the rcNormalPosition() field to the specified Consumer.
WINDOWPLACEMENT	rcNormalPosition(RECT value)	Copies the specified RECT to the rcNormalPosition() field.
WINDOWPLACEMENT	set(int length, int flags, int showCmd, POINT ptMinPosition, POINT ptMaxPosition, RECT rcNormalPosition)	Initializes this struct with the specified values.
WINDOWPLACEMENT	set(WINDOWPLACEMENT src)	Copies the specified struct data to this struct.
int	showCmd()	the current show state of the window
WINDOWPLACEMENT	showCmd(int value)	Sets the specified value to the showCmd() field.
int	sizeof()	Returns sizeof(struct).

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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

LENGTH

public static final int LENGTH

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

SHOWCMD

public static final int SHOWCMD

The struct member offsets.

PTMINPOSITION

public static final int PTMINPOSITION

The struct member offsets.

PTMAXPOSITION

public static final int PTMAXPOSITION

The struct member offsets.

RCNORMALPOSITION

public static final int RCNORMALPOSITION

The struct member offsets.

Constructor Details

WINDOWPLACEMENT

public WINDOWPLACEMENT(ByteBuffer container)

Creates a WINDOWPLACEMENT 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<WINDOWPLACEMENT>

length

public int length()

the length of the structure, in bytes. Before calling the User32.GetWindowPlacement(long, org.lwjgl.system.windows.WINDOWPLACEMENT) or User32.SetWindowPlacement(long, org.lwjgl.system.windows.WINDOWPLACEMENT) functions, set this member to SIZEOF.

flags

public int flags()

the flags that control the position of the minimized window and the method by which the window is restored. This member can be one or more of thefollowing values:
User32.WPF_SETMINPOSITION User32.WPF_RESTORETOMAXIMIZED User32.WPF_ASYNCWINDOWPLACEMENT

showCmd

public int showCmd()

the current show state of the window

ptMinPosition

public POINT ptMinPosition()

the coordinates of the window's upper-left corner when the window is minimized

ptMaxPosition

public POINT ptMaxPosition()

the coordinates of the window's upper-left corner when the window is maximized

rcNormalPosition

public RECT rcNormalPosition()

the window's coordinates when the window is in the restored position

length

public WINDOWPLACEMENT length(int value)

Sets the specified value to the length() field.

flags

public WINDOWPLACEMENT flags(int value)

Sets the specified value to the flags() field.

showCmd

public WINDOWPLACEMENT showCmd(int value)

Sets the specified value to the showCmd() field.

ptMinPosition

public WINDOWPLACEMENT ptMinPosition(POINT value)

Copies the specified POINT to the ptMinPosition() field.

ptMinPosition

public WINDOWPLACEMENT ptMinPosition(Consumer<POINT> consumer)

Passes the ptMinPosition() field to the specified Consumer.

ptMaxPosition

public WINDOWPLACEMENT ptMaxPosition(POINT value)

Copies the specified POINT to the ptMaxPosition() field.

ptMaxPosition

public WINDOWPLACEMENT ptMaxPosition(Consumer<POINT> consumer)

Passes the ptMaxPosition() field to the specified Consumer.

rcNormalPosition

public WINDOWPLACEMENT rcNormalPosition(RECT value)

Copies the specified RECT to the rcNormalPosition() field.

rcNormalPosition

public WINDOWPLACEMENT rcNormalPosition(Consumer<RECT> consumer)

Passes the rcNormalPosition() field to the specified Consumer.

set

public WINDOWPLACEMENT set(int length,
 int flags,
 int showCmd,
 POINT ptMinPosition,
 POINT ptMaxPosition,
 RECT rcNormalPosition)

Initializes this struct with the specified values.

set

public WINDOWPLACEMENT set(WINDOWPLACEMENT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static WINDOWPLACEMENT malloc()

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

calloc

public static WINDOWPLACEMENT calloc()

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

create

public static WINDOWPLACEMENT create()

Returns a new WINDOWPLACEMENT instance allocated with BufferUtils.

create

public static WINDOWPLACEMENT create(long address)

Returns a new WINDOWPLACEMENT instance for the specified memory address.

createSafe

@Nullable
public static WINDOWPLACEMENT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static WINDOWPLACEMENT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static WINDOWPLACEMENT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static WINDOWPLACEMENT.Buffer create(int capacity)

Returns a new WINDOWPLACEMENT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static WINDOWPLACEMENT.Buffer create(long address,
 int capacity)

Create a WINDOWPLACEMENT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static WINDOWPLACEMENT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static WINDOWPLACEMENT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static WINDOWPLACEMENT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static WINDOWPLACEMENT mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static WINDOWPLACEMENT callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static WINDOWPLACEMENT.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static WINDOWPLACEMENT.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static WINDOWPLACEMENT.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static WINDOWPLACEMENT.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static WINDOWPLACEMENT malloc(MemoryStack stack)

Returns a new WINDOWPLACEMENT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static WINDOWPLACEMENT calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static WINDOWPLACEMENT.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static WINDOWPLACEMENT.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nlength

public static int nlength(long struct)

Unsafe version of length().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nshowCmd

public static int nshowCmd(long struct)

Unsafe version of showCmd().

nptMinPosition

public static POINT nptMinPosition(long struct)

Unsafe version of ptMinPosition().

nptMaxPosition

public static POINT nptMaxPosition(long struct)

Unsafe version of ptMaxPosition().

nrcNormalPosition

public static RECT nrcNormalPosition(long struct)

Unsafe version of rcNormalPosition().

nlength

public static void nlength(long struct,
 int value)

Unsafe version of length.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

nshowCmd

public static void nshowCmd(long struct,
 int value)

Unsafe version of showCmd.

nptMinPosition

public static void nptMinPosition(long struct,
 POINT value)

Unsafe version of ptMinPosition.

nptMaxPosition

public static void nptMaxPosition(long struct,
 POINT value)

Unsafe version of ptMaxPosition.

nrcNormalPosition

public static void nrcNormalPosition(long struct,
 RECT value)

Unsafe version of rcNormalPosition.