Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRFovStencilDesc

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

Fov-stencil mesh descriptor passed into the function GetFovStencil.

Layout


struct ovrFovStencilDesc {
    ovrFovStencilType StencilType;
    uint32_t StencilFlags;
    ovrEyeType Eye;
    ovrFovPort FovPort;
    ovrQuatf HmdToEyeRotation;
}

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
EYE

The struct member offsets.

public static final int
FOVPORT

The struct member offsets.

public static final int
HMDTOEYEROTATION

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STENCILFLAGS

The struct member offsets.

public static final int
STENCILTYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OVRFovStencilDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRFovStencilDesc
calloc()

Returns a new OVRFovStencilDesc instance allocated with memCalloc.

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

Returns a new OVRFovStencilDesc.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRFovStencilDesc
callocStack()

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

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

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

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

Returns a new OVRFovStencilDesc instance allocated with BufferUtils.

public static OVRFovStencilDesc
create(long address)

Returns a new OVRFovStencilDesc instance for the specified memory address.

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

Returns a new OVRFovStencilDesc.Buffer instance allocated with BufferUtils.

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

Create a OVRFovStencilDesc.Buffer instance at the specified memory.

public static OVRFovStencilDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the Eye field.
Eye
()

public OVRFovStencilDesc
Eye(int value)

Sets the specified value to the Eye field.

public OVRFovPort
FovPort()

typically FOV obtained from GetRenderDesc

public OVRFovStencilDesc
FovPort(OVRFovPort value)

Copies the specified OVRFovPort to the FovPort field.

public OVRFovStencilDesc
FovPort(Consumer<OVRFovPort> consumer)

Passes the FovPort field to the specified Consumer.

public OVRQuatf
HmdToEyeRotation()

typically HmdToEyePose.Orientation obtained from GetRenderDesc.

public OVRFovStencilDesc
HmdToEyeRotation(OVRQuatf value)

Copies the specified OVRQuatf to the HmdToEyeRotation field.

public OVRFovStencilDesc
HmdToEyeRotation(Consumer<OVRQuatf> consumer)

Passes the HmdToEyeRotation field to the specified Consumer.

public static OVRFovStencilDesc
malloc()

Returns a new OVRFovStencilDesc instance allocated with memAlloc.

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

Returns a new OVRFovStencilDesc.Buffer instance allocated with memAlloc.

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

Returns a new OVRFovStencilDesc instance allocated on the specified MemoryStack.

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

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

public static OVRFovStencilDesc
mallocStack()

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

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

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

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

Unsafe version of Eye.

public static void
nEye(long struct, int value)

Unsafe version of Eye.

public static OVRFovPort
nFovPort(long struct)

Unsafe version of FovPort.

public static void
nFovPort(long struct, OVRFovPort value)

Unsafe version of FovPort.

public static OVRQuatf
nHmdToEyeRotation(long struct)

Unsafe version of HmdToEyeRotation.

public static void
nHmdToEyeRotation(long struct, OVRQuatf value)

Unsafe version of HmdToEyeRotation.

public static int
nStencilFlags(long struct)

Unsafe version of StencilFlags.

public static void
nStencilFlags(long struct, int value)

Unsafe version of StencilFlags.

public static int
nStencilType(long struct)

Unsafe version of StencilType.

public static void
nStencilType(long struct, int value)

Unsafe version of StencilType.

public OVRFovStencilDesc
set(int StencilType, int StencilFlags, int Eye, OVRFovPort FovPort, OVRQuatf HmdToEyeRotation)

Initializes this struct with the specified values.

public OVRFovStencilDesc

Returns:

this struct
set
(OVRFovStencilDesc
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
public OVRFovStencilDesc
StencilFlags(int value)

Sets the specified value to the StencilFlags field.

public int
public OVRFovStencilDesc
StencilType(int value)

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

EYEback to summary
public static final int EYE

The struct member offsets.

FOVPORTback to summary
public static final int FOVPORT

The struct member offsets.

HMDTOEYEROTATIONback to summary
public static final int HMDTOEYEROTATION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STENCILFLAGSback to summary
public static final int STENCILFLAGS

The struct member offsets.

STENCILTYPEback to summary
public static final int STENCILTYPE

The struct member offsets.

Constructor Detail

OVRFovStencilDescback to summary
protected OVRFovStencilDesc(long address, ByteBuffer container)
OVRFovStencilDescback to summary
public OVRFovStencilDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRFovStencilDesc calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new OVRFovStencilDesc instance allocated with BufferUtils.

createback to summary
public static OVRFovStencilDesc create(long address)

Returns a new OVRFovStencilDesc instance for the specified memory address.

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

Returns a new OVRFovStencilDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRFovStencilDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRFovStencilDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
Eyeback to summary
public int Eye()
Returns:int

the value of the Eye field.

Annotations
@NativeType:ovrEyeType
Eyeback to summary
public OVRFovStencilDesc Eye(int value)

Sets the specified value to the Eye field.

FovPortback to summary
public OVRFovPort FovPort()

typically FOV obtained from GetRenderDesc

Annotations
@NativeType:ovrFovPort
FovPortback to summary
public OVRFovStencilDesc FovPort(OVRFovPort value)

Copies the specified OVRFovPort to the FovPort field.

FovPortback to summary
public OVRFovStencilDesc FovPort(Consumer<OVRFovPort> consumer)

Passes the FovPort field to the specified Consumer.

HmdToEyeRotationback to summary
public OVRQuatf HmdToEyeRotation()

typically HmdToEyePose.Orientation obtained from GetRenderDesc.

Note

Currently unsupported, always treated as identity.

Annotations
@NativeType:ovrQuatf
HmdToEyeRotationback to summary
public OVRFovStencilDesc HmdToEyeRotation(OVRQuatf value)

Copies the specified OVRQuatf to the HmdToEyeRotation field.

HmdToEyeRotationback to summary
public OVRFovStencilDesc HmdToEyeRotation(Consumer<OVRQuatf> consumer)

Passes the HmdToEyeRotation field to the specified Consumer.

mallocback to summary
public static OVRFovStencilDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRFovStencilDesc malloc(MemoryStack stack)

Returns a new OVRFovStencilDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nEyeback to summary
public static int nEye(long struct)

Unsafe version of Eye.

nEyeback to summary
public static void nEye(long struct, int value)

Unsafe version of Eye.

nFovPortback to summary
public static OVRFovPort nFovPort(long struct)

Unsafe version of FovPort.

nFovPortback to summary
public static void nFovPort(long struct, OVRFovPort value)

Unsafe version of FovPort.

nHmdToEyeRotationback to summary
public static OVRQuatf nHmdToEyeRotation(long struct)

Unsafe version of HmdToEyeRotation.

nHmdToEyeRotationback to summary
public static void nHmdToEyeRotation(long struct, OVRQuatf value)

Unsafe version of HmdToEyeRotation.

nStencilFlagsback to summary
public static int nStencilFlags(long struct)

Unsafe version of StencilFlags.

nStencilFlagsback to summary
public static void nStencilFlags(long struct, int value)

Unsafe version of StencilFlags.

nStencilTypeback to summary
public static int nStencilType(long struct)

Unsafe version of StencilType.

nStencilTypeback to summary
public static void nStencilType(long struct, int value)

Unsafe version of StencilType.

setback to summary
public OVRFovStencilDesc set(int StencilType, int StencilFlags, int Eye, OVRFovPort FovPort, OVRQuatf HmdToEyeRotation)

Initializes this struct with the specified values.

setback to summary
public OVRFovStencilDesc set(OVRFovStencilDesc src)

Copies the specified struct data to this struct.

Parameters
src:OVRFovStencilDesc

the source struct

Returns:OVRFovStencilDesc

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
StencilFlagsback to summary
public int StencilFlags()

one or more of:

FovStencilFlag_MeshOriginAtBottomLeft
Annotations
@NativeType:uint32_t
StencilFlagsback to summary
public OVRFovStencilDesc StencilFlags(int value)

Sets the specified value to the StencilFlags field.

StencilTypeback to summary
public int StencilType()

one of:

FovStencil_HiddenAreaFovStencil_VisibleAreaFovStencil_BorderLine
FovStencil_VisibleRectangle
Annotations
@NativeType:ovrFovStencilType
StencilTypeback to summary
public OVRFovStencilDesc StencilType(int value)

Sets the specified value to the StencilType field.

org.lwjgl.ovr back to summary

public Class OVRFovStencilDesc.Buffer

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

An array of OVRFovStencilDesc structs.

Field Summary

Modifier and TypeField and Description
private static final OVRFovStencilDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRFovStencilDesc.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 int

Returns:

the value of the Eye field.
Eye
()

public OVRFovStencilDesc.Buffer
Eye(int value)

Sets the specified value to the Eye field.

public OVRFovPort

Returns:

a OVRFovPort view of the OVRFovStencilDesc#FovPort field.
FovPort
()

public OVRFovStencilDesc.Buffer
FovPort(OVRFovPort value)

Copies the specified OVRFovPort to the OVRFovStencilDesc#FovPort field.

public OVRFovStencilDesc.Buffer
FovPort(Consumer<OVRFovPort> consumer)

Passes the OVRFovStencilDesc#FovPort field to the specified Consumer.

protected OVRFovStencilDesc
public OVRQuatf
public OVRFovStencilDesc.Buffer
HmdToEyeRotation(OVRQuatf value)

Copies the specified OVRQuatf to the OVRFovStencilDesc#HmdToEyeRotation field.

public OVRFovStencilDesc.Buffer
HmdToEyeRotation(Consumer<OVRQuatf> consumer)

Passes the OVRFovStencilDesc#HmdToEyeRotation field to the specified Consumer.

protected OVRFovStencilDesc.Buffer
public int

Returns:

the value of the OVRFovStencilDesc#StencilFlags field.
StencilFlags
()

public OVRFovStencilDesc.Buffer
StencilFlags(int value)

Sets the specified value to the OVRFovStencilDesc#StencilFlags field.

public int

Returns:

the value of the OVRFovStencilDesc#StencilType field.
StencilType
()

public OVRFovStencilDesc.Buffer
StencilType(int value)

Sets the specified value to the OVRFovStencilDesc#StencilType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRFovStencilDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

Eyeback to summary
public int Eye()
Returns:int

the value of the Eye field.

Annotations
@NativeType:ovrEyeType
Eyeback to summary
public OVRFovStencilDesc.Buffer Eye(int value)

Sets the specified value to the Eye field.

FovPortback to summary
public OVRFovPort FovPort()
Returns:OVRFovPort

a OVRFovPort view of the OVRFovStencilDesc#FovPort field.

Annotations
@NativeType:ovrFovPort
FovPortback to summary
public OVRFovStencilDesc.Buffer FovPort(OVRFovPort value)

Copies the specified OVRFovPort to the OVRFovStencilDesc#FovPort field.

FovPortback to summary
public OVRFovStencilDesc.Buffer FovPort(Consumer<OVRFovPort> consumer)

Passes the OVRFovStencilDesc#FovPort field to the specified Consumer.

getElementFactoryback to summary
protected OVRFovStencilDesc getElementFactory()

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

Annotations
@Override
HmdToEyeRotationback to summary
public OVRQuatf HmdToEyeRotation()
Returns:OVRQuatf

a OVRQuatf view of the OVRFovStencilDesc#HmdToEyeRotation field.

Annotations
@NativeType:ovrQuatf
HmdToEyeRotationback to summary
public OVRFovStencilDesc.Buffer HmdToEyeRotation(OVRQuatf value)

Copies the specified OVRQuatf to the OVRFovStencilDesc#HmdToEyeRotation field.

HmdToEyeRotationback to summary
public OVRFovStencilDesc.Buffer HmdToEyeRotation(Consumer<OVRQuatf> consumer)

Passes the OVRFovStencilDesc#HmdToEyeRotation field to the specified Consumer.

selfback to summary
protected OVRFovStencilDesc.Buffer self()

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

Annotations
@Override
StencilFlagsback to summary
public int StencilFlags()
Returns:int

the value of the OVRFovStencilDesc#StencilFlags field.

Annotations
@NativeType:uint32_t
StencilFlagsback to summary
public OVRFovStencilDesc.Buffer StencilFlags(int value)

Sets the specified value to the OVRFovStencilDesc#StencilFlags field.

StencilTypeback to summary
public int StencilType()
Returns:int

the value of the OVRFovStencilDesc#StencilType field.

Annotations
@NativeType:ovrFovStencilType
StencilTypeback to summary
public OVRFovStencilDesc.Buffer StencilType(int value)

Sets the specified value to the OVRFovStencilDesc#StencilType field.