Package org.lwjgl.openxr

Class XrBaseOutStructure

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrBaseOutStructure>

org.lwjgl.openxr.XrBaseOutStructure

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class XrBaseOutStructure
extends Struct<XrBaseOutStructure>
implements NativeResource

 struct XrBaseOutStructure {
     XrStructureType type;
     {@link XrBaseOutStructure XrBaseOutStructure} * next;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrBaseOutStructure.Buffer	An array of XrBaseOutStructure 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	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrBaseOutStructure	calloc()	Returns a new XrBaseOutStructure instance allocated with memCalloc.
static XrBaseOutStructure.Buffer	calloc(int capacity)	Returns a new XrBaseOutStructure.Buffer instance allocated with memCalloc.
static XrBaseOutStructure.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new XrBaseOutStructure.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrBaseOutStructure	calloc(MemoryStack stack)	Returns a new XrBaseOutStructure instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrBaseOutStructure	create()	Returns a new XrBaseOutStructure instance allocated with BufferUtils.
static XrBaseOutStructure.Buffer	create(int capacity)	Returns a new XrBaseOutStructure.Buffer instance allocated with BufferUtils.
static XrBaseOutStructure	create(long address)	Returns a new XrBaseOutStructure instance for the specified memory address.
static XrBaseOutStructure.Buffer	create(long address, int capacity)	Create a XrBaseOutStructure.Buffer instance at the specified memory.
static @Nullable XrBaseOutStructure	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrBaseOutStructure.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrBaseOutStructure	malloc()	Returns a new XrBaseOutStructure instance allocated with memAlloc.
static XrBaseOutStructure.Buffer	malloc(int capacity)	Returns a new XrBaseOutStructure.Buffer instance allocated with memAlloc.
static XrBaseOutStructure.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new XrBaseOutStructure.Buffer instance allocated on the specified MemoryStack.
static XrBaseOutStructure	malloc(MemoryStack stack)	Returns a new XrBaseOutStructure instance allocated on the specified MemoryStack.
XrBaseOutStructure	next()
XrBaseOutStructure	next(XrBaseOutStructure value)	Sets the address of the specified XrBaseOutStructure to the next field.
static XrBaseOutStructure	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, XrBaseOutStructure value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrBaseOutStructure	set(int type, XrBaseOutStructure next)	Initializes this struct with the specified values.
XrBaseOutStructure	set(XrBaseOutStructure src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	type()
XrBaseOutStructure	type(int value)	Sets the specified value to the type field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, 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.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

Constructor Details

XrBaseOutStructure

public XrBaseOutStructure(ByteBuffer container)

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

type

public int type()

Returns:

the value of the type field.

next

public XrBaseOutStructure next()

Returns:

a XrBaseOutStructure view of the struct pointed to by the next field.

type

public XrBaseOutStructure type(int value)

Sets the specified value to the type field.

next

public XrBaseOutStructure next(XrBaseOutStructure value)

Sets the address of the specified XrBaseOutStructure to the next field.

set

public XrBaseOutStructure set(int type,
 XrBaseOutStructure next)

Initializes this struct with the specified values.

set

public XrBaseOutStructure set(XrBaseOutStructure src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrBaseOutStructure malloc()

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

calloc

public static XrBaseOutStructure calloc()

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

create

public static XrBaseOutStructure create()

Returns a new XrBaseOutStructure instance allocated with BufferUtils.

create

public static XrBaseOutStructure create(long address)

Returns a new XrBaseOutStructure instance for the specified memory address.

createSafe

public static @Nullable XrBaseOutStructure createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrBaseOutStructure.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrBaseOutStructure.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrBaseOutStructure.Buffer create(int capacity)

Returns a new XrBaseOutStructure.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrBaseOutStructure.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrBaseOutStructure malloc(MemoryStack stack)

Returns a new XrBaseOutStructure instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrBaseOutStructure calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static XrBaseOutStructure nnext(long struct)

Unsafe version of next().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 XrBaseOutStructure value)

Unsafe version of next.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate