Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRErrorInfo

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

Provides information about the last error.

Layout


struct ovrErrorInfo {
    ovrResult Result;
    char ErrorString[512];
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OVRErrorInfo.Buffer

An array of OVRErrorInfo structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
ERRORSTRING

The struct member offsets.

public static final int
RESULT

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
OVRErrorInfo(long address, ByteBuffer container)

public
OVRErrorInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRErrorInfo
calloc()

Returns a new OVRErrorInfo instance allocated with memCalloc.

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

Returns a new OVRErrorInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRErrorInfo
callocStack()

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

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

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

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

Returns a new OVRErrorInfo instance allocated with BufferUtils.

public static OVRErrorInfo
create(long address)

Returns a new OVRErrorInfo instance for the specified memory address.

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

Returns a new OVRErrorInfo.Buffer instance allocated with BufferUtils.

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

Create a OVRErrorInfo.Buffer instance at the specified memory.

public static OVRErrorInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
ErrorString()

a UTF8-encoded null-terminated English string describing the problem.

public String
ErrorStringString()

a UTF8-encoded null-terminated English string describing the problem.

public static OVRErrorInfo
malloc()

Returns a new OVRErrorInfo instance allocated with memAlloc.

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

Returns a new OVRErrorInfo.Buffer instance allocated with memAlloc.

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

Returns a new OVRErrorInfo instance allocated on the specified MemoryStack.

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

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

public static OVRErrorInfo
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
nErrorString(long struct)

Unsafe version of ErrorString.

public static String
nErrorStringString(long struct)

Unsafe version of ErrorStringString.

public static int
nResult(long struct)

Unsafe version of Result.

public int
Result()

the result from the last API call that generated an error ovrResult

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.

ERRORSTRINGback to summary
public static final int ERRORSTRING

The struct member offsets.

RESULTback to summary
public static final int RESULT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OVRErrorInfoback to summary
protected OVRErrorInfo(long address, ByteBuffer container)
OVRErrorInfoback to summary
public OVRErrorInfo(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRErrorInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new OVRErrorInfo instance allocated with BufferUtils.

createback to summary
public static OVRErrorInfo create(long address)

Returns a new OVRErrorInfo instance for the specified memory address.

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

Returns a new OVRErrorInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRErrorInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRErrorInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
ErrorStringback to summary
public ByteBuffer ErrorString()

a UTF8-encoded null-terminated English string describing the problem. The format of this string is subject to change in future versions

Annotations
@NativeType:char[512]
ErrorStringStringback to summary
public String ErrorStringString()

a UTF8-encoded null-terminated English string describing the problem. The format of this string is subject to change in future versions

Annotations
@NativeType:char[512]
mallocback to summary
public static OVRErrorInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRErrorInfo malloc(MemoryStack stack)

Returns a new OVRErrorInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nErrorStringback to summary
public static ByteBuffer nErrorString(long struct)

Unsafe version of ErrorString.

nErrorStringStringback to summary
public static String nErrorStringString(long struct)

Unsafe version of ErrorStringString.

nResultback to summary
public static int nResult(long struct)

Unsafe version of Result.

Resultback to summary
public int Result()

the result from the last API call that generated an error ovrResult

Annotations
@NativeType:ovrResult
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.ovr back to summary

public Class OVRErrorInfo.Buffer

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

An array of OVRErrorInfo structs.

Field Summary

Modifier and TypeField and Description
private static final OVRErrorInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRErrorInfo.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 ByteBuffer

Returns:

a ByteBuffer view of the OVRErrorInfo#ErrorString field.
ErrorString
()

public String

Returns:

the null-terminated string stored in the OVRErrorInfo#ErrorString field.
ErrorStringString
()

protected OVRErrorInfo
public int

Returns:

the value of the OVRErrorInfo#Result field.
Result
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRErrorInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

ErrorStringback to summary
public ByteBuffer ErrorString()
Returns:ByteBuffer

a ByteBuffer view of the OVRErrorInfo#ErrorString field.

Annotations
@NativeType:char[512]
ErrorStringStringback to summary
public String ErrorStringString()
Returns:String

the null-terminated string stored in the OVRErrorInfo#ErrorString field.

Annotations
@NativeType:char[512]
getElementFactoryback to summary
protected OVRErrorInfo getElementFactory()

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

Annotations
@Override
Resultback to summary
public int Result()
Returns:int

the value of the OVRErrorInfo#Result field.

Annotations
@NativeType:ovrResult
selfback to summary
protected OVRErrorInfo.Buffer self()

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

Annotations
@Override