Top Description Fields Constructors Methods
org.lwjgl.ovr

public Class OVRInitParams

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

Layout


struct ovrInitParams {
    uint32_t Flags;
    uint32_t RequestedMinorVersion;
    ovrLogCallback LogCallback;
    uintptr_t UserData;
    uint32_t ConnectionTimeoutMS;
}

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONNECTIONTIMEOUTMS

The struct member offsets.

public static final int
FLAGS

The struct member offsets.

public static final int
LOGCALLBACK

The struct member offsets.

public static final int
REQUESTEDMINORVERSION

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
USERDATA

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
OVRInitParams(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static OVRInitParams
calloc()

Returns a new OVRInitParams instance allocated with memCalloc.

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

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

public static OVRInitParams
callocStack()

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

Deprecated
Deprecated for removal in 3.4.0.
public int
ConnectionTimeoutMS()

relative number of milliseconds to wait for a connection to the server before failing.

public OVRInitParams
ConnectionTimeoutMS(int value)

Sets the specified value to the ConnectionTimeoutMS field.

protected OVRInitParams
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 OVRInitParams
create()

Returns a new OVRInitParams instance allocated with BufferUtils.

public static OVRInitParams
create(long address)

Returns a new OVRInitParams instance for the specified memory address.

public static OVRInitParams
createSafe(long address)

Like create, but returns null if address is NULL.

public int
Flags()

flags from ovrInitFlags to override default behavior.

public OVRInitParams
Flags(int value)

Sets the specified value to the Flags field.

public OVRLogCallback
LogCallback()

user-supplied log callback function, which may be called at any time asynchronously from multiple threads until Shutdown completes.

public OVRInitParams
LogCallback(OVRLogCallbackI value)

Sets the specified value to the LogCallback field.

public static OVRInitParams
malloc()

Returns a new OVRInitParams instance allocated with memAlloc.

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

Returns a new OVRInitParams instance allocated on the specified MemoryStack.

public static OVRInitParams
mallocStack()

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

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

Unsafe version of ConnectionTimeoutMS.

public static void
nConnectionTimeoutMS(long struct, int value)

Unsafe version of ConnectionTimeoutMS.

public static int
nFlags(long struct)

Unsafe version of Flags.

public static void
nFlags(long struct, int value)

Unsafe version of Flags.

public static OVRLogCallback
nLogCallback(long struct)

Unsafe version of LogCallback.

public static void
nLogCallback(long struct, OVRLogCallbackI value)

Unsafe version of LogCallback.

public static int
nRequestedMinorVersion(long struct)

Unsafe version of RequestedMinorVersion.

public static void
nRequestedMinorVersion(long struct, int value)

Unsafe version of RequestedMinorVersion.

public static long
nUserData(long struct)

Unsafe version of UserData.

public static void
nUserData(long struct, long value)

Unsafe version of UserData.

public int
RequestedMinorVersion()

requests a specific minor version of the LibOVR runtime.

public OVRInitParams
RequestedMinorVersion(int value)

Sets the specified value to the RequestedMinorVersion field.

public OVRInitParams
set(int Flags, int RequestedMinorVersion, OVRLogCallbackI LogCallback, long UserData, int ConnectionTimeoutMS)

Initializes this struct with the specified values.

public OVRInitParams

Returns:

this struct
set(OVRInitParams
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 long
UserData()

user-supplied data which is passed as-is to LogCallback.

public OVRInitParams
UserData(long value)

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

CONNECTIONTIMEOUTMSback to summary
public static final int CONNECTIONTIMEOUTMS

The struct member offsets.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

LOGCALLBACKback to summary
public static final int LOGCALLBACK

The struct member offsets.

REQUESTEDMINORVERSIONback to summary
public static final int REQUESTEDMINORVERSION

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

USERDATAback to summary
public static final int USERDATA

The struct member offsets.

Constructor Detail

OVRInitParamsback to summary
protected OVRInitParams(long address, ByteBuffer container)
OVRInitParamsback to summary
public OVRInitParams(ByteBuffer container)

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

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

callocback to summary
public static OVRInitParams calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static OVRInitParams callocStack()

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ConnectionTimeoutMSback to summary
public int ConnectionTimeoutMS()

relative number of milliseconds to wait for a connection to the server before failing. Use 0 for the default timeout.

Annotations
@NativeType:uint32_t
ConnectionTimeoutMSback to summary
public OVRInitParams ConnectionTimeoutMS(int value)

Sets the specified value to the ConnectionTimeoutMS field.

createback to summary
protected OVRInitParams 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 OVRInitParams create()

Returns a new OVRInitParams instance allocated with BufferUtils.

createback to summary
public static OVRInitParams create(long address)

Returns a new OVRInitParams instance for the specified memory address.

createSafeback to summary
public static OVRInitParams createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
Flagsback to summary
public int Flags()

flags from ovrInitFlags to override default behavior. Use 0 for the defaults.

Annotations
@NativeType:uint32_t
Flagsback to summary
public OVRInitParams Flags(int value)

Sets the specified value to the Flags field.

LogCallbackback to summary
public OVRLogCallback LogCallback()

user-supplied log callback function, which may be called at any time asynchronously from multiple threads until Shutdown completes. Use NULL to specify no log callback.

Annotations
@Nullable
@NativeType:ovrLogCallback
LogCallbackback to summary
public OVRInitParams LogCallback(OVRLogCallbackI value)

Sets the specified value to the LogCallback field.

mallocback to summary
public static OVRInitParams malloc()

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

mallocback to summary
public static OVRInitParams malloc(MemoryStack stack)

Returns a new OVRInitParams instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static OVRInitParams mallocStack()

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nConnectionTimeoutMSback to summary
public static int nConnectionTimeoutMS(long struct)

Unsafe version of ConnectionTimeoutMS.

nConnectionTimeoutMSback to summary
public static void nConnectionTimeoutMS(long struct, int value)

Unsafe version of ConnectionTimeoutMS.

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.

nLogCallbackback to summary
public static OVRLogCallback nLogCallback(long struct)

Unsafe version of LogCallback.

Annotations
@Nullable
nLogCallbackback to summary
public static void nLogCallback(long struct, OVRLogCallbackI value)

Unsafe version of LogCallback.

nRequestedMinorVersionback to summary
public static int nRequestedMinorVersion(long struct)

Unsafe version of RequestedMinorVersion.

nRequestedMinorVersionback to summary
public static void nRequestedMinorVersion(long struct, int value)

Unsafe version of RequestedMinorVersion.

nUserDataback to summary
public static long nUserData(long struct)

Unsafe version of UserData.

nUserDataback to summary
public static void nUserData(long struct, long value)

Unsafe version of UserData.

RequestedMinorVersionback to summary
public int RequestedMinorVersion()

requests a specific minor version of the LibOVR runtime. Flags must include Init_RequestVersion or this will be ignored and MINOR_VERSION will be used. If you are directly calling the LibOVRRT version of Initialize in the LibOVRRT DLL then this must be valid and include Init_RequestVersion.

Annotations
@NativeType:uint32_t
RequestedMinorVersionback to summary
public OVRInitParams RequestedMinorVersion(int value)

Sets the specified value to the RequestedMinorVersion field.

setback to summary
public OVRInitParams set(int Flags, int RequestedMinorVersion, OVRLogCallbackI LogCallback, long UserData, int ConnectionTimeoutMS)

Initializes this struct with the specified values.

setback to summary
public OVRInitParams set(OVRInitParams src)

Copies the specified struct data to this struct.

Parameters
src:OVRInitParams

the source struct

Returns:OVRInitParams

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
UserDataback to summary
public long UserData()

user-supplied data which is passed as-is to LogCallback. Typically this is used to store an application-specific pointer which is read in the callback function.

Annotations
@NativeType:uintptr_t
UserDataback to summary
public OVRInitParams UserData(long value)

Sets the specified value to the UserData field.