Top Description Inners Fields Constructors Methods
org.lwjgl.stb

public Class STBRPRect

extends Struct<STBRPRect>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct stbrp_rect
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

A packed rectangle.

Layout


struct stbrp_rect {
    int id;
    stbrp_coord w;
    stbrp_coord h;
    stbrp_coord x;
    stbrp_coord y;
    int was_packed;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
STBRPRect.Buffer

An array of STBRPRect structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
H

The struct member offsets.

public static final int
ID

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
W

The struct member offsets.

public static final int
WAS_PACKED

The struct member offsets.

public static final int
X

The struct member offsets.

public static final int
Y

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
STBRPRect(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static STBRPRect
calloc()

Returns a new STBRPRect instance allocated with memCalloc.

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

Returns a new STBRPRect.Buffer instance allocated with memCalloc.

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

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

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

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

public static STBRPRect
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected STBRPRect
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 STBRPRect
create()

Returns a new STBRPRect instance allocated with BufferUtils.

public static STBRPRect
create(long address)

Returns a new STBRPRect instance for the specified memory address.

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

Returns a new STBRPRect.Buffer instance allocated with BufferUtils.

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

Create a STBRPRect.Buffer instance at the specified memory.

public static STBRPRect
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
h()

input height

public STBRPRect
h(int value)

Sets the specified value to the h field.

public int
id()

reserved for your use

public STBRPRect
id(int value)

Sets the specified value to the id field.

public static STBRPRect
malloc()

Returns a new STBRPRect instance allocated with memAlloc.

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

Returns a new STBRPRect.Buffer instance allocated with memAlloc.

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

Returns a new STBRPRect instance allocated on the specified MemoryStack.

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

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

public static STBRPRect
mallocStack()

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

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

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

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

Unsafe version of h.

public static void
nh(long struct, int value)

Unsafe version of h.

public static int
nid(long struct)

Unsafe version of id.

public static void
nid(long struct, int value)

Unsafe version of id.

public static int
nw(long struct)

Unsafe version of w.

public static void
nw(long struct, int value)

Unsafe version of w.

public static int
nwas_packed(long struct)

Unsafe version of was_packed.

public static void
nwas_packed(long struct, int value)

Unsafe version of was_packed.

public static int
nx(long struct)

Unsafe version of x.

public static void
nx(long struct, int value)

Unsafe version of x.

public static int
ny(long struct)

Unsafe version of y.

public static void
ny(long struct, int value)

Unsafe version of y.

public STBRPRect
set(int id, int w, int h, int x, int y, boolean was_packed)

Initializes this struct with the specified values.

public STBRPRect

Returns:

this struct
set
(STBRPRect
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
w()

input width

public STBRPRect
w(int value)

Sets the specified value to the w field.

public boolean
was_packed()

non-zero if valid packing

public STBRPRect
was_packed(boolean value)

Sets the specified value to the was_packed field.

public int
x()

output x coordinate

public STBRPRect
x(int value)

Sets the specified value to the x field.

public int
y()

output y coordinate

public STBRPRect
y(int value)

Sets the specified value to the y 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.

Hback to summary
public static final int H

The struct member offsets.

IDback to summary
public static final int ID

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Wback to summary
public static final int W

The struct member offsets.

WAS_PACKEDback to summary
public static final int WAS_PACKED

The struct member offsets.

Xback to summary
public static final int X

The struct member offsets.

Yback to summary
public static final int Y

The struct member offsets.

Constructor Detail

STBRPRectback to summary
protected STBRPRect(long address, ByteBuffer container)
STBRPRectback to summary
public STBRPRect(ByteBuffer container)

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

callocback to summary
public static STBRPRect calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static STBRPRect calloc(MemoryStack stack)

Returns a new STBRPRect 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 STBRPRect.Buffer calloc(int capacity, MemoryStack stack)

Returns a new STBRPRect.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 STBRPRect callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static STBRPRect.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 STBRPRect 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 STBRPRect create()

Returns a new STBRPRect instance allocated with BufferUtils.

createback to summary
public static STBRPRect create(long address)

Returns a new STBRPRect instance for the specified memory address.

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

Returns a new STBRPRect.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a STBRPRect.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static STBRPRect createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
hback to summary
public int h()

input height

Annotations
@NativeType:stbrp_coord
hback to summary
public STBRPRect h(int value)

Sets the specified value to the h field.

idback to summary
public int id()

reserved for your use

idback to summary
public STBRPRect id(int value)

Sets the specified value to the id field.

mallocback to summary
public static STBRPRect malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static STBRPRect malloc(MemoryStack stack)

Returns a new STBRPRect instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new STBRPRect.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 STBRPRect mallocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nhback to summary
public static int nh(long struct)

Unsafe version of h.

nhback to summary
public static void nh(long struct, int value)

Unsafe version of h.

nidback to summary
public static int nid(long struct)

Unsafe version of id.

nidback to summary
public static void nid(long struct, int value)

Unsafe version of id.

nwback to summary
public static int nw(long struct)

Unsafe version of w.

nwback to summary
public static void nw(long struct, int value)

Unsafe version of w.

nwas_packedback to summary
public static int nwas_packed(long struct)

Unsafe version of was_packed.

nwas_packedback to summary
public static void nwas_packed(long struct, int value)

Unsafe version of was_packed.

nxback to summary
public static int nx(long struct)

Unsafe version of x.

nxback to summary
public static void nx(long struct, int value)

Unsafe version of x.

nyback to summary
public static int ny(long struct)

Unsafe version of y.

nyback to summary
public static void ny(long struct, int value)

Unsafe version of y.

setback to summary
public STBRPRect set(int id, int w, int h, int x, int y, boolean was_packed)

Initializes this struct with the specified values.

setback to summary
public STBRPRect set(STBRPRect src)

Copies the specified struct data to this struct.

Parameters
src:STBRPRect

the source struct

Returns:STBRPRect

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
wback to summary
public int w()

input width

Annotations
@NativeType:stbrp_coord
wback to summary
public STBRPRect w(int value)

Sets the specified value to the w field.

was_packedback to summary
public boolean was_packed()

non-zero if valid packing

Annotations
@NativeType:int
was_packedback to summary
public STBRPRect was_packed(boolean value)

Sets the specified value to the was_packed field.

xback to summary
public int x()

output x coordinate

Annotations
@NativeType:stbrp_coord
xback to summary
public STBRPRect x(int value)

Sets the specified value to the x field.

yback to summary
public int y()

output y coordinate

Annotations
@NativeType:stbrp_coord
yback to summary
public STBRPRect y(int value)

Sets the specified value to the y field.

org.lwjgl.stb back to summary

public Class STBRPRect.Buffer

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

An array of STBRPRect structs.

Field Summary

Modifier and TypeField and Description
private static final STBRPRect

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new STBRPRect.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
protected STBRPRect
public int

Returns:

the value of the STBRPRect#h field.
h
()

public STBRPRect.Buffer
h(int value)

Sets the specified value to the STBRPRect#h field.

public int

Returns:

the value of the STBRPRect#id field.
id
()

public STBRPRect.Buffer
id(int value)

Sets the specified value to the STBRPRect#id field.

protected STBRPRect.Buffer
public int

Returns:

the value of the STBRPRect#w field.
w
()

public STBRPRect.Buffer
w(int value)

Sets the specified value to the STBRPRect#w field.

public boolean

Returns:

the value of the STBRPRect#was_packed field.
was_packed
()

public STBRPRect.Buffer
was_packed(boolean value)

Sets the specified value to the STBRPRect#was_packed field.

public int

Returns:

the value of the STBRPRect#x field.
x
()

public STBRPRect.Buffer
x(int value)

Sets the specified value to the STBRPRect#x field.

public int

Returns:

the value of the STBRPRect#y field.
y
()

public STBRPRect.Buffer
y(int value)

Sets the specified value to the STBRPRect#y field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final STBRPRect ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new STBRPRect.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 STBRPRect#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

getElementFactoryback to summary
protected STBRPRect getElementFactory()

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

Annotations
@Override
hback to summary
public int h()
Returns:int

the value of the STBRPRect#h field.

Annotations
@NativeType:stbrp_coord
hback to summary
public STBRPRect.Buffer h(int value)

Sets the specified value to the STBRPRect#h field.

idback to summary
public int id()
Returns:int

the value of the STBRPRect#id field.

idback to summary
public STBRPRect.Buffer id(int value)

Sets the specified value to the STBRPRect#id field.

selfback to summary
protected STBRPRect.Buffer self()

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

Annotations
@Override
wback to summary
public int w()
Returns:int

the value of the STBRPRect#w field.

Annotations
@NativeType:stbrp_coord
wback to summary
public STBRPRect.Buffer w(int value)

Sets the specified value to the STBRPRect#w field.

was_packedback to summary
public boolean was_packed()
Returns:boolean

the value of the STBRPRect#was_packed field.

Annotations
@NativeType:int
was_packedback to summary
public STBRPRect.Buffer was_packed(boolean value)

Sets the specified value to the STBRPRect#was_packed field.

xback to summary
public int x()
Returns:int

the value of the STBRPRect#x field.

Annotations
@NativeType:stbrp_coord
xback to summary
public STBRPRect.Buffer x(int value)

Sets the specified value to the STBRPRect#x field.

yback to summary
public int y()
Returns:int

the value of the STBRPRect#y field.

Annotations
@NativeType:stbrp_coord
yback to summary
public STBRPRect.Buffer y(int value)

Sets the specified value to the STBRPRect#y field.