Package org.lwjgl.ovr

Class OVRLayerCube

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<OVRLayerCube>

org.lwjgl.ovr.OVRLayerCube

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class OVRLayerCube
extends Struct<OVRLayerCube>
implements NativeResource

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OVRLayerCube.Buffer	An array of OVRLayerCube structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CUBEMAPTEXTURE	The struct member offsets.
static final int	HEADER	The struct member offsets.
static final int	ORIENTATION	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
OVRLayerCube(ByteBuffer container)	Creates a OVRLayerCube instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static OVRLayerCube	calloc()	Returns a new OVRLayerCube instance allocated with memCalloc.
static OVRLayerCube.Buffer	calloc(int capacity)	Returns a new OVRLayerCube.Buffer instance allocated with memCalloc.
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.
static OVRLayerCube	calloc(MemoryStack stack)	Returns a new OVRLayerCube instance allocated on the specified MemoryStack and initializes all its bits to zero.
static OVRLayerCube	callocStack()	Deprecated.
static OVRLayerCube.Buffer	callocStack(int capacity)	Deprecated.
static OVRLayerCube.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static OVRLayerCube	callocStack(MemoryStack stack)	Deprecated.
static OVRLayerCube	create()	Returns a new OVRLayerCube instance allocated with BufferUtils.
static OVRLayerCube.Buffer	create(int capacity)	Returns a new OVRLayerCube.Buffer instance allocated with BufferUtils.
static OVRLayerCube	create(long address)	Returns a new OVRLayerCube instance for the specified memory address.
static OVRLayerCube.Buffer	create(long address, int capacity)	Create a OVRLayerCube.Buffer instance at the specified memory.
static OVRLayerCube	createSafe(long address)	Like create, but returns null if address is NULL.
static OVRLayerCube.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	CubeMapTexture()	contains a single cubemap swapchain (not a stereo pair of swapchains)
OVRLayerCube	CubeMapTexture(long value)	Sets the specified value to the CubeMapTexture() field.
OVRLayerHeader	Header()	Header.Type must be LayerType_Cube
OVRLayerCube	Header(Consumer<OVRLayerHeader> consumer)	Passes the Header() field to the specified Consumer.
OVRLayerCube	Header(OVRLayerHeader value)	Copies the specified OVRLayerHeader to the Header() field.
static OVRLayerCube	malloc()	Returns a new OVRLayerCube instance allocated with memAlloc.
static OVRLayerCube.Buffer	malloc(int capacity)	Returns a new OVRLayerCube.Buffer instance allocated with memAlloc.
static OVRLayerCube.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new OVRLayerCube.Buffer instance allocated on the specified MemoryStack.
static OVRLayerCube	malloc(MemoryStack stack)	Returns a new OVRLayerCube instance allocated on the specified MemoryStack.
static OVRLayerCube	mallocStack()	Deprecated.
static OVRLayerCube.Buffer	mallocStack(int capacity)	Deprecated.
static OVRLayerCube.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static OVRLayerCube	mallocStack(MemoryStack stack)	Deprecated.
static long	nCubeMapTexture(long struct)	Unsafe version of CubeMapTexture().
static void	nCubeMapTexture(long struct, long value)	Unsafe version of CubeMapTexture.
static OVRLayerHeader	nHeader(long struct)	Unsafe version of Header().
static void	nHeader(long struct, OVRLayerHeader value)	Unsafe version of Header.
static OVRQuatf	nOrientation(long struct)	Unsafe version of Orientation().
static void	nOrientation(long struct, OVRQuatf value)	Unsafe version of Orientation.
OVRQuatf	Orientation()	orientation of the cube
OVRLayerCube	Orientation(Consumer<OVRQuatf> consumer)	Passes the Orientation() field to the specified Consumer.
OVRLayerCube	Orientation(OVRQuatf value)	Copies the specified OVRQuatf to the Orientation() field.
OVRLayerCube	set(OVRLayerCube src)	Copies the specified struct data to this struct.
OVRLayerCube	set(OVRLayerHeader Header, OVRQuatf Orientation, long CubeMapTexture)	Initializes this struct with the specified values.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

HEADER

public static final int HEADER

The struct member offsets.

ORIENTATION

public static final int ORIENTATION

The struct member offsets.

CUBEMAPTEXTURE

public static final int CUBEMAPTEXTURE

The struct member offsets.

Constructor Details

OVRLayerCube

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<OVRLayerCube>

Header

public OVRLayerHeader Header()

Header.Type must be LayerType_Cube

Orientation

public OVRQuatf Orientation()

orientation of the cube

CubeMapTexture

public long CubeMapTexture()

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

Header

public OVRLayerCube Header(OVRLayerHeader value)

Copies the specified OVRLayerHeader to the Header() field.

Header

public OVRLayerCube Header(Consumer<OVRLayerHeader> consumer)

Passes the Header() field to the specified Consumer.

Orientation

public OVRLayerCube Orientation(OVRQuatf value)

Copies the specified OVRQuatf to the Orientation() field.

Orientation

public OVRLayerCube Orientation(Consumer<OVRQuatf> consumer)

Passes the Orientation() field to the specified Consumer.

CubeMapTexture

public OVRLayerCube CubeMapTexture(long value)

Sets the specified value to the CubeMapTexture() field.

set

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

Initializes this struct with the specified values.

set

public OVRLayerCube set(OVRLayerCube src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static OVRLayerCube malloc()

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

calloc

public static OVRLayerCube calloc()

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

create

public static OVRLayerCube create()

Returns a new OVRLayerCube instance allocated with BufferUtils.

create

public static OVRLayerCube create(long address)

Returns a new OVRLayerCube instance for the specified memory address.

createSafe

@Nullable
public static OVRLayerCube createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static OVRLayerCube.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static OVRLayerCube.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static OVRLayerCube.Buffer create(int capacity)

Returns a new OVRLayerCube.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a OVRLayerCube.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static OVRLayerCube mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static OVRLayerCube callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static OVRLayerCube mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static OVRLayerCube callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static OVRLayerCube.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static OVRLayerCube.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static OVRLayerCube.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static OVRLayerCube.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static OVRLayerCube malloc(MemoryStack stack)

Returns a new OVRLayerCube instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nHeader

public static OVRLayerHeader nHeader(long struct)

Unsafe version of Header().

nOrientation

public static OVRQuatf nOrientation(long struct)

Unsafe version of Orientation().

nCubeMapTexture

public static long nCubeMapTexture(long struct)

Unsafe version of CubeMapTexture().

nHeader

public static void nHeader(long struct,
 OVRLayerHeader value)

Unsafe version of Header.

nOrientation

public static void nOrientation(long struct,
 OVRQuatf value)

Unsafe version of Orientation.

nCubeMapTexture

public static void nCubeMapTexture(long struct,
 long value)

Unsafe version of CubeMapTexture.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate