Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRLayerHeader

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

Defines properties shared by all ovrLayer structs, such as OVRLayerEyeFov.

ovrLayerHeader is used as a base member in these larger structs. This struct cannot be used by itself except for the case that Type is LayerType_Disabled.

Layout


struct ovrLayerHeader {
    ovrLayerType Type;
    unsigned int Flags;
    char[128];
}

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
FLAGS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OVRLayerHeader(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRLayerHeader
calloc()

Returns a new OVRLayerHeader instance allocated with memCalloc.

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

Returns a new OVRLayerHeader.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRLayerHeader
callocStack()

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

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

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

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

Returns a new OVRLayerHeader instance allocated with BufferUtils.

public static OVRLayerHeader
create(long address)

Returns a new OVRLayerHeader instance for the specified memory address.

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

Returns a new OVRLayerHeader.Buffer instance allocated with BufferUtils.

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

Create a OVRLayerHeader.Buffer instance at the specified memory.

public static OVRLayerHeader
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
Flags()

described by ovrLayerFlags

public OVRLayerHeader
Flags(int value)

Sets the specified value to the Flags field.

public static OVRLayerHeader
malloc()

Returns a new OVRLayerHeader instance allocated with memAlloc.

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

Returns a new OVRLayerHeader.Buffer instance allocated with memAlloc.

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

Returns a new OVRLayerHeader instance allocated on the specified MemoryStack.

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

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

public static OVRLayerHeader
mallocStack()

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

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

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

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

Unsafe version of Flags.

public static void
nFlags(long struct, int value)

Unsafe version of Flags.

public static int
nType(long struct)

Unsafe version of Type.

public static void
nType(long struct, int value)

Unsafe version of Type.

public OVRLayerHeader
set(int Type, int Flags)

Initializes this struct with the specified values.

public OVRLayerHeader

Returns:

this struct
set
(OVRLayerHeader
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
Type()

described by ovrLayerType.

public OVRLayerHeader
Type(int value)

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

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

OVRLayerHeaderback to summary
protected OVRLayerHeader(long address, ByteBuffer container)
OVRLayerHeaderback to summary
public OVRLayerHeader(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRLayerHeader calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new OVRLayerHeader instance allocated with BufferUtils.

createback to summary
public static OVRLayerHeader create(long address)

Returns a new OVRLayerHeader instance for the specified memory address.

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

Returns a new OVRLayerHeader.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRLayerHeader.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRLayerHeader createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
Flagsback to summary
public int Flags()

described by ovrLayerFlags

Annotations
@NativeType:unsigned int
Flagsback to summary
public OVRLayerHeader Flags(int value)

Sets the specified value to the Flags field.

mallocback to summary
public static OVRLayerHeader malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRLayerHeader malloc(MemoryStack stack)

Returns a new OVRLayerHeader instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nFlagsback to summary
public static int nFlags(long struct)

Unsafe version of Flags.

nFlagsback to summary
public static void nFlags(long struct, int value)

Unsafe version of Flags.

nTypeback to summary
public static int nType(long struct)

Unsafe version of Type.

nTypeback to summary
public static void nType(long struct, int value)

Unsafe version of Type.

setback to summary
public OVRLayerHeader set(int Type, int Flags)

Initializes this struct with the specified values.

setback to summary
public OVRLayerHeader set(OVRLayerHeader src)

Copies the specified struct data to this struct.

Parameters
src:OVRLayerHeader

the source struct

Returns:OVRLayerHeader

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
Typeback to summary
public int Type()

described by ovrLayerType. One of:

LayerType_DisabledLayerType_EyeFovLayerType_EyeFovDepthLayerType_Quad
LayerType_EyeMatrixLayerType_EyeFovMultiresLayerType_CylinderLayerType_Cube
Annotations
@NativeType:ovrLayerType
Typeback to summary
public OVRLayerHeader Type(int value)

Sets the specified value to the Type field.

org.lwjgl.ovr back to summary

public Class OVRLayerHeader.Buffer

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

An array of OVRLayerHeader structs.

Field Summary

Modifier and TypeField and Description
private static final OVRLayerHeader

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRLayerHeader.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 OVRLayerHeader#Flags field.
Flags
()

public OVRLayerHeader.Buffer
Flags(int value)

Sets the specified value to the OVRLayerHeader#Flags field.

protected OVRLayerHeader
protected OVRLayerHeader.Buffer
public int

Returns:

the value of the OVRLayerHeader#Type field.
Type
()

public OVRLayerHeader.Buffer
Type(int value)

Sets the specified value to the OVRLayerHeader#Type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRLayerHeader ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

Flagsback to summary
public int Flags()
Returns:int

the value of the OVRLayerHeader#Flags field.

Annotations
@NativeType:unsigned int
Flagsback to summary
public OVRLayerHeader.Buffer Flags(int value)

Sets the specified value to the OVRLayerHeader#Flags field.

getElementFactoryback to summary
protected OVRLayerHeader getElementFactory()

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

Annotations
@Override
selfback to summary
protected OVRLayerHeader.Buffer self()

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

Annotations
@Override
Typeback to summary
public int Type()
Returns:int

the value of the OVRLayerHeader#Type field.

Annotations
@NativeType:ovrLayerType
Typeback to summary
public OVRLayerHeader.Buffer Type(int value)

Sets the specified value to the OVRLayerHeader#Type field.