Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRLayerCube

extends Struct<OVRLayerCube>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct ovrLayerCube
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Describes a layer of type LayerType_Cube which is a single timewarped cubemap at infinity. When looking down the recentered origin's -Z axis, +X face is left and +Y face is up. Similarly, if headlocked the +X face is left, +Y face is up and -Z face is forward. Note that the coordinate system is left-handed.

LayerFlag_TextureOriginAtBottomLeft flag is not supported by ovrLayerCube.

Layout


struct ovrLayerCube {
    ovrLayerHeader Header;
    ovrQuatf Orientation;
    ovrTextureSwapChain CubeMapTexture;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
OVRLayerCube.Buffer

An array of OVRLayerCube structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CUBEMAPTEXTURE

The struct member offsets.

public static final int
HEADER

The struct member offsets.

public static final int
ORIENTATION

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

public
OVRLayerCube(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRLayerCube
calloc()

Returns a new OVRLayerCube instance allocated with memCalloc.

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

Returns a new OVRLayerCube.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRLayerCube
callocStack()

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

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

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

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

Returns a new OVRLayerCube instance allocated with BufferUtils.

public static OVRLayerCube
create(long address)

Returns a new OVRLayerCube instance for the specified memory address.

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

Returns a new OVRLayerCube.Buffer instance allocated with BufferUtils.

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

Create a OVRLayerCube.Buffer instance at the specified memory.

public static OVRLayerCube
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
CubeMapTexture()

contains a single cubemap swapchain (not a stereo pair of swapchains)

public OVRLayerCube
CubeMapTexture(long value)

Sets the specified value to the CubeMapTexture field.

public OVRLayerHeader
Header()

Header.Type must be LayerType_Cube

public OVRLayerCube
Header(OVRLayerHeader value)

Copies the specified OVRLayerHeader to the Header field.

public OVRLayerCube
Header(Consumer<OVRLayerHeader> consumer)

Passes the Header field to the specified Consumer.

public static OVRLayerCube
malloc()

Returns a new OVRLayerCube instance allocated with memAlloc.

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

Returns a new OVRLayerCube.Buffer instance allocated with memAlloc.

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

Returns a new OVRLayerCube instance allocated on the specified MemoryStack.

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

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

public static OVRLayerCube
mallocStack()

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

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

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

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

Unsafe version of CubeMapTexture.

public static void
nCubeMapTexture(long struct, long value)

Unsafe version of CubeMapTexture.

public static OVRLayerHeader
nHeader(long struct)

Unsafe version of Header.

public static void
nHeader(long struct, OVRLayerHeader value)

Unsafe version of Header.

public static OVRQuatf
nOrientation(long struct)

Unsafe version of Orientation.

public static void
nOrientation(long struct, OVRQuatf value)

Unsafe version of Orientation.

public OVRQuatf
Orientation()

orientation of the cube

public OVRLayerCube
Orientation(OVRQuatf value)

Copies the specified OVRQuatf to the Orientation field.

public OVRLayerCube
Orientation(Consumer<OVRQuatf> consumer)

Passes the Orientation field to the specified Consumer.

public OVRLayerCube
set(OVRLayerHeader Header, OVRQuatf Orientation, long CubeMapTexture)

Initializes this struct with the specified values.

public OVRLayerCube

Returns:

this struct
set(OVRLayerCube
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 static void
validate(long
the struct to validate
struct)

Validates pointer members that should not be NULL.

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.

CUBEMAPTEXTUREback to summary
public static final int CUBEMAPTEXTURE

The struct member offsets.

ORIENTATIONback to summary
public static final int ORIENTATION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OVRLayerCubeback to summary
protected OVRLayerCube(long address, ByteBuffer container)
OVRLayerCubeback to summary
public OVRLayerCube(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRLayerCube calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new OVRLayerCube instance allocated with BufferUtils.

createback to summary
public static OVRLayerCube create(long address)

Returns a new OVRLayerCube instance for the specified memory address.

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

Returns a new OVRLayerCube.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRLayerCube.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRLayerCube createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
CubeMapTextureback to summary
public long CubeMapTexture()

contains a single cubemap swapchain (not a stereo pair of swapchains)

Annotations
@NativeType:ovrTextureSwapChain
CubeMapTextureback to summary
public OVRLayerCube CubeMapTexture(long value)

Sets the specified value to the CubeMapTexture field.

Headerback to summary
public OVRLayerHeader Header()

Header.Type must be LayerType_Cube

Annotations
@NativeType:ovrLayerHeader
Headerback to summary
public OVRLayerCube Header(OVRLayerHeader value)

Copies the specified OVRLayerHeader to the Header field.

Headerback to summary
public OVRLayerCube Header(Consumer<OVRLayerHeader> consumer)

Passes the Header field to the specified Consumer.

mallocback to summary
public static OVRLayerCube malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRLayerCube malloc(MemoryStack stack)

Returns a new OVRLayerCube instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nCubeMapTextureback to summary
public static long nCubeMapTexture(long struct)

Unsafe version of CubeMapTexture.

nCubeMapTextureback to summary
public static void nCubeMapTexture(long struct, long value)

Unsafe version of CubeMapTexture.

nHeaderback to summary
public static OVRLayerHeader nHeader(long struct)

Unsafe version of Header.

nHeaderback to summary
public static void nHeader(long struct, OVRLayerHeader value)

Unsafe version of Header.

nOrientationback to summary
public static OVRQuatf nOrientation(long struct)

Unsafe version of Orientation.

nOrientationback to summary
public static void nOrientation(long struct, OVRQuatf value)

Unsafe version of Orientation.

Orientationback to summary
public OVRQuatf Orientation()

orientation of the cube

Annotations
@NativeType:ovrQuatf
Orientationback to summary
public OVRLayerCube Orientation(OVRQuatf value)

Copies the specified OVRQuatf to the Orientation field.

Orientationback to summary
public OVRLayerCube Orientation(Consumer<OVRQuatf> consumer)

Passes the Orientation field to the specified Consumer.

setback to summary
public OVRLayerCube set(OVRLayerHeader Header, OVRQuatf Orientation, long CubeMapTexture)

Initializes this struct with the specified values.

setback to summary
public OVRLayerCube set(OVRLayerCube src)

Copies the specified struct data to this struct.

Parameters
src:OVRLayerCube

the source struct

Returns:OVRLayerCube

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
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.ovr back to summary

public Class OVRLayerCube.Buffer

extends StructBuffer<OVRLayerCube, OVRLayerCube.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of OVRLayerCube structs.

Field Summary

Modifier and TypeField and Description
private static final OVRLayerCube
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRLayerCube.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 long

Returns:

the value of the OVRLayerCube#CubeMapTexture field.
CubeMapTexture()

public OVRLayerCube.Buffer
CubeMapTexture(long value)

Sets the specified value to the OVRLayerCube#CubeMapTexture field.

protected OVRLayerCube
getElementFactory()

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

public OVRLayerHeader

Returns:

a OVRLayerHeader view of the OVRLayerCube#Header field.
Header()

public OVRLayerCube.Buffer
Header(OVRLayerHeader value)

Copies the specified OVRLayerHeader to the OVRLayerCube#Header field.

public OVRLayerCube.Buffer
Header(Consumer<OVRLayerHeader> consumer)

Passes the OVRLayerCube#Header field to the specified Consumer.

public OVRQuatf

Returns:

a OVRQuatf view of the OVRLayerCube#Orientation field.
Orientation()

public OVRLayerCube.Buffer
Orientation(OVRQuatf value)

Copies the specified OVRQuatf to the OVRLayerCube#Orientation field.

public OVRLayerCube.Buffer
Orientation(Consumer<OVRQuatf> consumer)

Passes the OVRLayerCube#Orientation field to the specified Consumer.

protected OVRLayerCube.Buffer
self()

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

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRLayerCube ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

CubeMapTextureback to summary
public long CubeMapTexture()
Returns:long

the value of the OVRLayerCube#CubeMapTexture field.

Annotations
@NativeType:ovrTextureSwapChain
CubeMapTextureback to summary
public OVRLayerCube.Buffer CubeMapTexture(long value)

Sets the specified value to the OVRLayerCube#CubeMapTexture field.

getElementFactoryback to summary
protected OVRLayerCube getElementFactory()

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

Annotations
@Override
Headerback to summary
public OVRLayerHeader Header()
Returns:OVRLayerHeader

a OVRLayerHeader view of the OVRLayerCube#Header field.

Annotations
@NativeType:ovrLayerHeader
Headerback to summary
public OVRLayerCube.Buffer Header(OVRLayerHeader value)

Copies the specified OVRLayerHeader to the OVRLayerCube#Header field.

Headerback to summary
public OVRLayerCube.Buffer Header(Consumer<OVRLayerHeader> consumer)

Passes the OVRLayerCube#Header field to the specified Consumer.

Orientationback to summary
public OVRQuatf Orientation()
Returns:OVRQuatf

a OVRQuatf view of the OVRLayerCube#Orientation field.

Annotations
@NativeType:ovrQuatf
Orientationback to summary
public OVRLayerCube.Buffer Orientation(OVRQuatf value)

Copies the specified OVRQuatf to the OVRLayerCube#Orientation field.

Orientationback to summary
public OVRLayerCube.Buffer Orientation(Consumer<OVRQuatf> consumer)

Passes the OVRLayerCube#Orientation field to the specified Consumer.

selfback to summary
protected OVRLayerCube.Buffer self()

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

Annotations
@Override