Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrRect2Di

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

Rect in two dimensions.
Description

This variant is for representing discrete values such as texels. For representing physical distances, the floating-point variant must be used instead.

See Also

XrExtent2Di, XrOffset2Di, XrSwapchainSubImage

Layout


struct XrRect2Di {
    XrOffset2Di offset;
    XrExtent2Di extent;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrRect2Di.Buffer

An array of XrRect2Di structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EXTENT

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrRect2Di(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrRect2Di
calloc()

Returns a new XrRect2Di instance allocated with memCalloc.

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

Returns a new XrRect2Di.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrRect2Di
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 XrRect2Di
create()

Returns a new XrRect2Di instance allocated with BufferUtils.

public static XrRect2Di
create(long address)

Returns a new XrRect2Di instance for the specified memory address.

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

Returns a new XrRect2Di.Buffer instance allocated with BufferUtils.

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

Create a XrRect2Di.Buffer instance at the specified memory.

public static XrRect2Di
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public XrExtent2Di
extent()

the XrExtent2Di specifying the integer rectangle extent.

public XrRect2Di
extent(XrExtent2Di value)

Copies the specified XrExtent2Di to the extent field.

public XrRect2Di
extent(Consumer<XrExtent2Di> consumer)

Passes the extent field to the specified Consumer.

public static XrRect2Di
malloc()

Returns a new XrRect2Di instance allocated with memAlloc.

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

Returns a new XrRect2Di.Buffer instance allocated with memAlloc.

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

Returns a new XrRect2Di instance allocated on the specified MemoryStack.

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

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

public static XrExtent2Di
nextent(long struct)

Unsafe version of extent.

public static void
nextent(long struct, XrExtent2Di value)

Unsafe version of extent.

public static XrOffset2Di
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, XrOffset2Di value)

Unsafe version of offset.

public XrOffset2Di
offset()

the XrOffset2Di specifying the integer rectangle offset.

public XrRect2Di
offset(XrOffset2Di value)

Copies the specified XrOffset2Di to the offset field.

public XrRect2Di
offset(Consumer<XrOffset2Di> consumer)

Passes the offset field to the specified Consumer.

public XrRect2Di
set(XrOffset2Di offset, XrExtent2Di extent)

Initializes this struct with the specified values.

public XrRect2Di

Returns:

this struct
set
(XrRect2Di
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).
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.

EXTENTback to summary
public static final int EXTENT

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

XrRect2Diback to summary
protected XrRect2Di(long address, ByteBuffer container)
XrRect2Diback to summary
public XrRect2Di(ByteBuffer container)

Creates a XrRect2Di 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 XrRect2Di calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrRect2Di calloc(MemoryStack stack)

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

Returns a new XrRect2Di.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

createback to summary
protected XrRect2Di 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 XrRect2Di create()

Returns a new XrRect2Di instance allocated with BufferUtils.

createback to summary
public static XrRect2Di create(long address)

Returns a new XrRect2Di instance for the specified memory address.

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

Returns a new XrRect2Di.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrRect2Di.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrRect2Di createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
extentback to summary
public XrExtent2Di extent()

the XrExtent2Di specifying the integer rectangle extent.

extentback to summary
public XrRect2Di extent(XrExtent2Di value)

Copies the specified XrExtent2Di to the extent field.

extentback to summary
public XrRect2Di extent(Consumer<XrExtent2Di> consumer)

Passes the extent field to the specified Consumer.

mallocback to summary
public static XrRect2Di malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrRect2Di malloc(MemoryStack stack)

Returns a new XrRect2Di instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextentback to summary
public static XrExtent2Di nextent(long struct)

Unsafe version of extent.

nextentback to summary
public static void nextent(long struct, XrExtent2Di value)

Unsafe version of extent.

noffsetback to summary
public static XrOffset2Di noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, XrOffset2Di value)

Unsafe version of offset.

offsetback to summary
public XrOffset2Di offset()

the XrOffset2Di specifying the integer rectangle offset.

offsetback to summary
public XrRect2Di offset(XrOffset2Di value)

Copies the specified XrOffset2Di to the offset field.

offsetback to summary
public XrRect2Di offset(Consumer<XrOffset2Di> consumer)

Passes the offset field to the specified Consumer.

setback to summary
public XrRect2Di set(XrOffset2Di offset, XrExtent2Di extent)

Initializes this struct with the specified values.

setback to summary
public XrRect2Di set(XrRect2Di src)

Copies the specified struct data to this struct.

Parameters
src:XrRect2Di

the source struct

Returns:XrRect2Di

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
org.lwjgl.openxr back to summary

public Class XrRect2Di.Buffer

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

An array of XrRect2Di structs.

Field Summary

Modifier and TypeField and Description
private static final XrRect2Di

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrRect2Di.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 XrExtent2Di

Returns:

a XrExtent2Di view of the XrRect2Di#extent field.
extent
()

public XrRect2Di.Buffer
extent(XrExtent2Di value)

Copies the specified XrExtent2Di to the XrRect2Di#extent field.

public XrRect2Di.Buffer
extent(Consumer<XrExtent2Di> consumer)

Passes the XrRect2Di#extent field to the specified Consumer.

protected XrRect2Di
public XrOffset2Di

Returns:

a XrOffset2Di view of the XrRect2Di#offset field.
offset
()

public XrRect2Di.Buffer
offset(XrOffset2Di value)

Copies the specified XrOffset2Di to the XrRect2Di#offset field.

public XrRect2Di.Buffer
offset(Consumer<XrOffset2Di> consumer)

Passes the XrRect2Di#offset field to the specified Consumer.

protected XrRect2Di.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrRect2Di ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

extentback to summary
public XrExtent2Di extent()
Returns:XrExtent2Di

a XrExtent2Di view of the XrRect2Di#extent field.

extentback to summary
public XrRect2Di.Buffer extent(XrExtent2Di value)

Copies the specified XrExtent2Di to the XrRect2Di#extent field.

extentback to summary
public XrRect2Di.Buffer extent(Consumer<XrExtent2Di> consumer)

Passes the XrRect2Di#extent field to the specified Consumer.

getElementFactoryback to summary
protected XrRect2Di getElementFactory()

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

Annotations
@Override
offsetback to summary
public XrOffset2Di offset()
Returns:XrOffset2Di

a XrOffset2Di view of the XrRect2Di#offset field.

offsetback to summary
public XrRect2Di.Buffer offset(XrOffset2Di value)

Copies the specified XrOffset2Di to the XrRect2Di#offset field.

offsetback to summary
public XrRect2Di.Buffer offset(Consumer<XrOffset2Di> consumer)

Passes the XrRect2Di#offset field to the specified Consumer.

selfback to summary
protected XrRect2Di.Buffer self()

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

Annotations
@Override