Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class OVRViewScaleDesc

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

Contains the data necessary to properly calculate position info for various layer types.

In other words, it is how big an in-application unit is in the player's physical meters. For example, if the application uses inches as its units then HmdSpaceToWorldScaleInMeters would be 0.0254. Note that if you are scaling the player in size, this must also scale. So if your application units are inches, but you're shrinking the player to half their normal size, then HmdSpaceToWorldScaleInMeters would be 0.0254*2.0.

Layout


struct ovrViewScaleDesc {
    ovrPosef HmdToEyePose[ovrEye_Count];
    float HmdSpaceToWorldScaleInMeters;
}

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
HMDSPACETOWORLDSCALEINMETERS

The struct member offsets.

public static final int
HMDTOEYEPOSE

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

public
OVRViewScaleDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRViewScaleDesc
calloc()

Returns a new OVRViewScaleDesc instance allocated with memCalloc.

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

Returns a new OVRViewScaleDesc.Buffer instance allocated with memCalloc.

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

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

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

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

public static OVRViewScaleDesc
callocStack()

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

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

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

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

Returns a new OVRViewScaleDesc instance allocated with BufferUtils.

public static OVRViewScaleDesc
create(long address)

Returns a new OVRViewScaleDesc instance for the specified memory address.

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

Returns a new OVRViewScaleDesc.Buffer instance allocated with BufferUtils.

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

Create a OVRViewScaleDesc.Buffer instance at the specified memory.

public static OVRViewScaleDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public float
HmdSpaceToWorldScaleInMeters()

ratio of viewer units to meter units

public OVRViewScaleDesc
HmdSpaceToWorldScaleInMeters(float value)

Sets the specified value to the HmdSpaceToWorldScaleInMeters field.

public OVRPosef.Buffer
HmdToEyePose()

transform of each eye from the HMD center, in meters

public OVRPosef
HmdToEyePose(int index)

transform of each eye from the HMD center, in meters

public OVRViewScaleDesc
HmdToEyePose(OVRPosef.Buffer value)

Copies the specified OVRPosef.Buffer to the HmdToEyePose field.

public OVRViewScaleDesc
HmdToEyePose(int index, OVRPosef value)

Copies the specified OVRPosef at the specified index of the HmdToEyePose field.

public OVRViewScaleDesc
HmdToEyePose(Consumer<OVRPosef.Buffer> consumer)

Passes the HmdToEyePose field to the specified Consumer.

public OVRViewScaleDesc
HmdToEyePose(int index, Consumer<OVRPosef> consumer)

Passes the element at index of the HmdToEyePose field to the specified Consumer.

public static OVRViewScaleDesc
malloc()

Returns a new OVRViewScaleDesc instance allocated with memAlloc.

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

Returns a new OVRViewScaleDesc.Buffer instance allocated with memAlloc.

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

Returns a new OVRViewScaleDesc instance allocated on the specified MemoryStack.

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

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

public static OVRViewScaleDesc
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static float
public static void
nHmdSpaceToWorldScaleInMeters(long struct, float value)

Unsafe version of HmdSpaceToWorldScaleInMeters.

public static OVRPosef.Buffer
nHmdToEyePose(long struct)

Unsafe version of HmdToEyePose.

public static OVRPosef
nHmdToEyePose(long struct, int index)

Unsafe version of HmdToEyePose.

public static void
nHmdToEyePose(long struct, OVRPosef.Buffer value)

Unsafe version of HmdToEyePose.

public static void
nHmdToEyePose(long struct, int index, OVRPosef value)

Unsafe version of HmdToEyePose.

public OVRViewScaleDesc
set(OVRPosef.Buffer HmdToEyePose, float HmdSpaceToWorldScaleInMeters)

Initializes this struct with the specified values.

public OVRViewScaleDesc

Returns:

this struct
set
(OVRViewScaleDesc
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).
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.

HMDSPACETOWORLDSCALEINMETERSback to summary
public static final int HMDSPACETOWORLDSCALEINMETERS

The struct member offsets.

HMDTOEYEPOSEback to summary
public static final int HMDTOEYEPOSE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

OVRViewScaleDescback to summary
protected OVRViewScaleDesc(long address, ByteBuffer container)
OVRViewScaleDescback to summary
public OVRViewScaleDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static OVRViewScaleDesc calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new OVRViewScaleDesc instance allocated with BufferUtils.

createback to summary
public static OVRViewScaleDesc create(long address)

Returns a new OVRViewScaleDesc instance for the specified memory address.

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

Returns a new OVRViewScaleDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a OVRViewScaleDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static OVRViewScaleDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
HmdSpaceToWorldScaleInMetersback to summary
public float HmdSpaceToWorldScaleInMeters()

ratio of viewer units to meter units

HmdSpaceToWorldScaleInMetersback to summary
public OVRViewScaleDesc HmdSpaceToWorldScaleInMeters(float value)

Sets the specified value to the HmdSpaceToWorldScaleInMeters field.

HmdToEyePoseback to summary
public OVRPosef.Buffer HmdToEyePose()

transform of each eye from the HMD center, in meters

Annotations
@NativeType:ovrPosef[ovrEye_Count]
HmdToEyePoseback to summary
public OVRPosef HmdToEyePose(int index)

transform of each eye from the HMD center, in meters

Annotations
@NativeType:ovrPosef
HmdToEyePoseback to summary
public OVRViewScaleDesc HmdToEyePose(OVRPosef.Buffer value)

Copies the specified OVRPosef.Buffer to the HmdToEyePose field.

HmdToEyePoseback to summary
public OVRViewScaleDesc HmdToEyePose(int index, OVRPosef value)

Copies the specified OVRPosef at the specified index of the HmdToEyePose field.

HmdToEyePoseback to summary
public OVRViewScaleDesc HmdToEyePose(Consumer<OVRPosef.Buffer> consumer)

Passes the HmdToEyePose field to the specified Consumer.

HmdToEyePoseback to summary
public OVRViewScaleDesc HmdToEyePose(int index, Consumer<OVRPosef> consumer)

Passes the element at index of the HmdToEyePose field to the specified Consumer.

mallocback to summary
public static OVRViewScaleDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static OVRViewScaleDesc malloc(MemoryStack stack)

Returns a new OVRViewScaleDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nHmdSpaceToWorldScaleInMetersback to summary
public static float nHmdSpaceToWorldScaleInMeters(long struct)

Unsafe version of HmdSpaceToWorldScaleInMeters.

nHmdSpaceToWorldScaleInMetersback to summary
public static void nHmdSpaceToWorldScaleInMeters(long struct, float value)

Unsafe version of HmdSpaceToWorldScaleInMeters.

nHmdToEyePoseback to summary
public static OVRPosef.Buffer nHmdToEyePose(long struct)

Unsafe version of HmdToEyePose.

nHmdToEyePoseback to summary
public static OVRPosef nHmdToEyePose(long struct, int index)

Unsafe version of HmdToEyePose.

nHmdToEyePoseback to summary
public static void nHmdToEyePose(long struct, OVRPosef.Buffer value)

Unsafe version of HmdToEyePose.

nHmdToEyePoseback to summary
public static void nHmdToEyePose(long struct, int index, OVRPosef value)

Unsafe version of HmdToEyePose.

setback to summary
public OVRViewScaleDesc set(OVRPosef.Buffer HmdToEyePose, float HmdSpaceToWorldScaleInMeters)

Initializes this struct with the specified values.

setback to summary
public OVRViewScaleDesc set(OVRViewScaleDesc src)

Copies the specified struct data to this struct.

Parameters
src:OVRViewScaleDesc

the source struct

Returns:OVRViewScaleDesc

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
org.lwjgl.ovr back to summary

public Class OVRViewScaleDesc.Buffer

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

An array of OVRViewScaleDesc structs.

Field Summary

Modifier and TypeField and Description
private static final OVRViewScaleDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new OVRViewScaleDesc.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
protected OVRViewScaleDesc
public float
public OVRViewScaleDesc.Buffer
HmdSpaceToWorldScaleInMeters(float value)

Sets the specified value to the OVRViewScaleDesc#HmdSpaceToWorldScaleInMeters field.

public OVRPosef.Buffer

Returns:

a OVRPosef.Buffer view of the OVRViewScaleDesc#HmdToEyePose field.
HmdToEyePose
()

public OVRPosef

Returns:

a OVRPosef view of the struct at the specified index of the OVRViewScaleDesc#HmdToEyePose field.
HmdToEyePose
(int index)

public OVRViewScaleDesc.Buffer
public OVRViewScaleDesc.Buffer
HmdToEyePose(int index, OVRPosef value)

Copies the specified OVRPosef at the specified index of the OVRViewScaleDesc#HmdToEyePose field.

public OVRViewScaleDesc.Buffer
HmdToEyePose(Consumer<OVRPosef.Buffer> consumer)

Passes the OVRViewScaleDesc#HmdToEyePose field to the specified Consumer.

public OVRViewScaleDesc.Buffer
HmdToEyePose(int index, Consumer<OVRPosef> consumer)

Passes the element at index of the OVRViewScaleDesc#HmdToEyePose field to the specified Consumer.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final OVRViewScaleDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected OVRViewScaleDesc getElementFactory()

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

Annotations
@Override
HmdSpaceToWorldScaleInMetersback to summary
public float HmdSpaceToWorldScaleInMeters()
Returns:float

the value of the OVRViewScaleDesc#HmdSpaceToWorldScaleInMeters field.

HmdSpaceToWorldScaleInMetersback to summary
public OVRViewScaleDesc.Buffer HmdSpaceToWorldScaleInMeters(float value)

Sets the specified value to the OVRViewScaleDesc#HmdSpaceToWorldScaleInMeters field.

HmdToEyePoseback to summary
public OVRPosef.Buffer HmdToEyePose()
Returns:OVRPosef.Buffer

a OVRPosef.Buffer view of the OVRViewScaleDesc#HmdToEyePose field.

Annotations
@NativeType:ovrPosef[ovrEye_Count]
HmdToEyePoseback to summary
public OVRPosef HmdToEyePose(int index)
Returns:OVRPosef

a OVRPosef view of the struct at the specified index of the OVRViewScaleDesc#HmdToEyePose field.

Annotations
@NativeType:ovrPosef
HmdToEyePoseback to summary
public OVRViewScaleDesc.Buffer HmdToEyePose(OVRPosef.Buffer value)

Copies the specified OVRPosef.Buffer to the OVRViewScaleDesc#HmdToEyePose field.

HmdToEyePoseback to summary
public OVRViewScaleDesc.Buffer HmdToEyePose(int index, OVRPosef value)

Copies the specified OVRPosef at the specified index of the OVRViewScaleDesc#HmdToEyePose field.

HmdToEyePoseback to summary
public OVRViewScaleDesc.Buffer HmdToEyePose(Consumer<OVRPosef.Buffer> consumer)

Passes the OVRViewScaleDesc#HmdToEyePose field to the specified Consumer.

HmdToEyePoseback to summary
public OVRViewScaleDesc.Buffer HmdToEyePose(int index, Consumer<OVRPosef> consumer)

Passes the element at index of the OVRViewScaleDesc#HmdToEyePose field to the specified Consumer.

selfback to summary
protected OVRViewScaleDesc.Buffer self()

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

Annotations
@Override