Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRBoundaryTestResult

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

Provides boundary test information.

Layout


struct ovrBoundaryTestResult {
    ovrBool IsTriggering;
    float ClosestDistance;
    ovrVector3f ClosestPoint;
    ovrVector3f ClosestPointNormal;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CLOSESTDISTANCE

The struct member offsets.

public static final int
CLOSESTPOINT

The struct member offsets.

public static final int
CLOSESTPOINTNORMAL

The struct member offsets.

public static final int
ISTRIGGERING

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

public
OVRBoundaryTestResult(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRBoundaryTestResult
calloc()

Returns a new OVRBoundaryTestResult instance allocated with memCalloc.

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

Returns a new OVRBoundaryTestResult.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRBoundaryTestResult
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public float
ClosestDistance()

Distance to the closest play area or outer boundary surface

public OVRVector3f
ClosestPoint()

Closest point on the boundary surface

public OVRVector3f
ClosestPointNormal()

Unit surface normal of the closest boundary surface

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

Returns a new OVRBoundaryTestResult instance allocated with BufferUtils.

public static OVRBoundaryTestResult
create(long address)

Returns a new OVRBoundaryTestResult instance for the specified memory address.

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

Returns a new OVRBoundaryTestResult.Buffer instance allocated with BufferUtils.

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

Create a OVRBoundaryTestResult.Buffer instance at the specified memory.

public static OVRBoundaryTestResult
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
IsTriggering()

True if the boundary system is being triggered.

public static OVRBoundaryTestResult
malloc()

Returns a new OVRBoundaryTestResult instance allocated with memAlloc.

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

Returns a new OVRBoundaryTestResult.Buffer instance allocated with memAlloc.

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

Returns a new OVRBoundaryTestResult instance allocated on the specified MemoryStack.

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

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

public static OVRBoundaryTestResult
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static float
nClosestDistance(long struct)

Unsafe version of ClosestDistance.

public static OVRVector3f
nClosestPoint(long struct)

Unsafe version of ClosestPoint.

public static OVRVector3f
nClosestPointNormal(long struct)

Unsafe version of ClosestPointNormal.

public static boolean
nIsTriggering(long struct)

Unsafe version of IsTriggering.

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.

CLOSESTDISTANCEback to summary
public static final int CLOSESTDISTANCE

The struct member offsets.

CLOSESTPOINTback to summary
public static final int CLOSESTPOINT

The struct member offsets.

CLOSESTPOINTNORMALback to summary
public static final int CLOSESTPOINTNORMAL

The struct member offsets.

ISTRIGGERINGback to summary
public static final int ISTRIGGERING

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OVRBoundaryTestResultback to summary
protected OVRBoundaryTestResult(long address, ByteBuffer container)
OVRBoundaryTestResultback to summary
public OVRBoundaryTestResult(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRBoundaryTestResult calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ClosestDistanceback to summary
public float ClosestDistance()

Distance to the closest play area or outer boundary surface

ClosestPointback to summary
public OVRVector3f ClosestPoint()

Closest point on the boundary surface

Annotations
@NativeType:ovrVector3f
ClosestPointNormalback to summary
public OVRVector3f ClosestPointNormal()

Unit surface normal of the closest boundary surface

Annotations
@NativeType:ovrVector3f
createback to summary
protected OVRBoundaryTestResult 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 OVRBoundaryTestResult create()

Returns a new OVRBoundaryTestResult instance allocated with BufferUtils.

createback to summary
public static OVRBoundaryTestResult create(long address)

Returns a new OVRBoundaryTestResult instance for the specified memory address.

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

Returns a new OVRBoundaryTestResult.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRBoundaryTestResult.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRBoundaryTestResult createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
IsTriggeringback to summary
public boolean IsTriggering()

True if the boundary system is being triggered. Note that due to fade in/out effects this may not exactly match visibility.

Annotations
@NativeType:ovrBool
mallocback to summary
public static OVRBoundaryTestResult malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRBoundaryTestResult malloc(MemoryStack stack)

Returns a new OVRBoundaryTestResult instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nClosestDistanceback to summary
public static float nClosestDistance(long struct)

Unsafe version of ClosestDistance.

nClosestPointback to summary
public static OVRVector3f nClosestPoint(long struct)

Unsafe version of ClosestPoint.

nClosestPointNormalback to summary
public static OVRVector3f nClosestPointNormal(long struct)

Unsafe version of ClosestPointNormal.

nIsTriggeringback to summary
public static boolean nIsTriggering(long struct)

Unsafe version of IsTriggering.

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 OVRBoundaryTestResult.Buffer

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

An array of OVRBoundaryTestResult structs.

Field Summary

Modifier and TypeField and Description
private static final OVRBoundaryTestResult

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRBoundaryTestResult.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 float

Returns:

the value of the OVRBoundaryTestResult#ClosestDistance field.
ClosestDistance
()

public OVRVector3f
public OVRVector3f
protected OVRBoundaryTestResult
public boolean

Returns:

the value of the OVRBoundaryTestResult#IsTriggering field.
IsTriggering
()

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

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRBoundaryTestResult ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

ClosestDistanceback to summary
public float ClosestDistance()
Returns:float

the value of the OVRBoundaryTestResult#ClosestDistance field.

ClosestPointback to summary
public OVRVector3f ClosestPoint()
Returns:OVRVector3f

a OVRVector3f view of the OVRBoundaryTestResult#ClosestPoint field.

Annotations
@NativeType:ovrVector3f
ClosestPointNormalback to summary
public OVRVector3f ClosestPointNormal()
Returns:OVRVector3f

a OVRVector3f view of the OVRBoundaryTestResult#ClosestPointNormal field.

Annotations
@NativeType:ovrVector3f
getElementFactoryback to summary
protected OVRBoundaryTestResult getElementFactory()

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

Annotations
@Override
IsTriggeringback to summary
public boolean IsTriggering()
Returns:boolean

the value of the OVRBoundaryTestResult#IsTriggering field.

Annotations
@NativeType:ovrBool
selfback to summary
protected OVRBoundaryTestResult.Buffer self()

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

Annotations
@Override