Top Description Inners Fields Constructors Methods
org.lwjgl.system.windows

public Class RECT

extends Struct<RECT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Defines the coordinates of the upper-left and lower-right corners of a rectangle.

Layout


struct RECT {
    LONG left;
    LONG top;
    LONG right;
    LONG bottom;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
RECT.Buffer

An array of RECT structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BOTTOM

The struct member offsets.

public static final int
LEFT

The struct member offsets.

public static final int
RIGHT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TOP

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
RECT(long address, ByteBuffer container)

public
RECT(ByteBuffer container)

Creates a RECT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
bottom()

the y-coordinate of the lower-right corner of the rectangle

public RECT
bottom(int value)

Sets the specified value to the bottom field.

public static RECT
calloc()

Returns a new RECT instance allocated with memCalloc.

public static RECT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new RECT.Buffer instance allocated with memCalloc.

public static RECT
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static RECT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static RECT
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static RECT
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static RECT.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static RECT.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected RECT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static RECT
create()

Returns a new RECT instance allocated with BufferUtils.

public static RECT
create(long address)

Returns a new RECT instance for the specified memory address.

public static RECT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new RECT.Buffer instance allocated with BufferUtils.

public static RECT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a RECT.Buffer instance at the specified memory.

public static RECT
createSafe(long address)

Like create, but returns null if address is NULL.

public static RECT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
left()

the x-coordinate of the upper-left corner of the rectangle

public RECT
left(int value)

Sets the specified value to the left field.

public static RECT
malloc()

Returns a new RECT instance allocated with memAlloc.

public static RECT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new RECT.Buffer instance allocated with memAlloc.

public static RECT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new RECT instance allocated on the specified MemoryStack.

public static RECT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static RECT
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static RECT
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static RECT.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static RECT.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nbottom(long struct)

Unsafe version of bottom.

public static void
nbottom(long struct, int value)

Unsafe version of bottom.

public static int
nleft(long struct)

Unsafe version of left.

public static void
nleft(long struct, int value)

Unsafe version of left.

public static int
nright(long struct)

Unsafe version of right.

public static void
nright(long struct, int value)

Unsafe version of right.

public static int
ntop(long struct)

Unsafe version of top.

public static void
ntop(long struct, int value)

Unsafe version of top.

public int
right()

the x-coordinate of the lower-right corner of the rectangle

public RECT
right(int value)

Sets the specified value to the right field.

public RECT
set(int left, int top, int right, int bottom)

Initializes this struct with the specified values.

public RECT

Returns:

this struct
set
(RECT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
top()

the y-coordinate of the upper-left corner of the rectangle

public RECT
top(int value)

Sets the specified value to the top field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BOTTOMback to summary
public static final int BOTTOM

The struct member offsets.

LEFTback to summary
public static final int LEFT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TOPback to summary
public static final int TOP

The struct member offsets.

Constructor Detail

RECTback to summary
protected RECT(long address, ByteBuffer container)
RECTback to summary
public RECT(ByteBuffer container)

Creates a RECT 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

bottomback to summary
public int bottom()

the y-coordinate of the lower-right corner of the rectangle

Annotations
@NativeType:LONG
bottomback to summary
public RECT bottom(int value)

Sets the specified value to the bottom field.

callocback to summary
public static RECT calloc()

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

callocback to summary
public static RECT.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static RECT calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static RECT.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static RECT callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static RECT callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static RECT.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static RECT.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected RECT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static RECT create()

Returns a new RECT instance allocated with BufferUtils.

createback to summary
public static RECT create(long address)

Returns a new RECT instance for the specified memory address.

createback to summary
public static RECT.Buffer create(int capacity)

Returns a new RECT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static RECT.Buffer create(long address, int capacity)

Create a RECT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static RECT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static RECT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
leftback to summary
public int left()

the x-coordinate of the upper-left corner of the rectangle

Annotations
@NativeType:LONG
leftback to summary
public RECT left(int value)

Sets the specified value to the left field.

mallocback to summary
public static RECT malloc()

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

mallocback to summary
public static RECT.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static RECT malloc(MemoryStack stack)

Returns a new RECT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static RECT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static RECT mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static RECT mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static RECT.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static RECT.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nbottomback to summary
public static int nbottom(long struct)

Unsafe version of bottom.

nbottomback to summary
public static void nbottom(long struct, int value)

Unsafe version of bottom.

nleftback to summary
public static int nleft(long struct)

Unsafe version of left.

nleftback to summary
public static void nleft(long struct, int value)

Unsafe version of left.

nrightback to summary
public static int nright(long struct)

Unsafe version of right.

nrightback to summary
public static void nright(long struct, int value)

Unsafe version of right.

ntopback to summary
public static int ntop(long struct)

Unsafe version of top.

ntopback to summary
public static void ntop(long struct, int value)

Unsafe version of top.

rightback to summary
public int right()

the x-coordinate of the lower-right corner of the rectangle

Annotations
@NativeType:LONG
rightback to summary
public RECT right(int value)

Sets the specified value to the right field.

setback to summary
public RECT set(int left, int top, int right, int bottom)

Initializes this struct with the specified values.

setback to summary
public RECT set(RECT src)

Copies the specified struct data to this struct.

Parameters
src:RECT

the source struct

Returns:RECT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
topback to summary
public int top()

the y-coordinate of the upper-left corner of the rectangle

Annotations
@NativeType:LONG
topback to summary
public RECT top(int value)

Sets the specified value to the top field.

org.lwjgl.system.windows back to summary

public Class RECT.Buffer

extends StructBuffer<RECT, RECT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of RECT structs.

Field Summary

Modifier and TypeField and Description
private static final RECT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new RECT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the RECT#bottom field.
bottom
()

public RECT.Buffer
bottom(int value)

Sets the specified value to the RECT#bottom field.

protected RECT
public int

Returns:

the value of the RECT#left field.
left
()

public RECT.Buffer
left(int value)

Sets the specified value to the RECT#left field.

public int

Returns:

the value of the RECT#right field.
right
()

public RECT.Buffer
right(int value)

Sets the specified value to the RECT#right field.

protected RECT.Buffer
public int

Returns:

the value of the RECT#top field.
top
()

public RECT.Buffer
top(int value)

Sets the specified value to the RECT#top field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final RECT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new RECT.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 RECT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bottomback to summary
public int bottom()
Returns:int

the value of the RECT#bottom field.

Annotations
@NativeType:LONG
bottomback to summary
public RECT.Buffer bottom(int value)

Sets the specified value to the RECT#bottom field.

getElementFactoryback to summary
protected RECT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
leftback to summary
public int left()
Returns:int

the value of the RECT#left field.

Annotations
@NativeType:LONG
leftback to summary
public RECT.Buffer left(int value)

Sets the specified value to the RECT#left field.

rightback to summary
public int right()
Returns:int

the value of the RECT#right field.

Annotations
@NativeType:LONG
rightback to summary
public RECT.Buffer right(int value)

Sets the specified value to the RECT#right field.

selfback to summary
protected RECT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
topback to summary
public int top()
Returns:int

the value of the RECT#top field.

Annotations
@NativeType:LONG
topback to summary
public RECT.Buffer top(int value)

Sets the specified value to the RECT#top field.