Package org.lwjgl.openvr

Class PathRead

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<PathRead>

org.lwjgl.openvr.PathRead

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class PathRead
extends org.lwjgl.system.Struct<PathRead>
implements org.lwjgl.system.NativeResource

Layout

 struct PathRead_t {
     PathHandle_t ulPath;
     void * pvBuffer;
     uint32_t unBufferSize;
     PropertyTypeTag_t unTag;
     uint32_t unRequiredBufferSize;
     ETrackedPropertyError eError();
     char * pszPath;
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	EERROR	The struct member offsets.
static final int	PSZPATH	The struct member offsets.
static final int	PVBUFFER	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	ULPATH	The struct member offsets.
static final int	UNBUFFERSIZE	The struct member offsets.
static final int	UNREQUIREDBUFFERSIZE	The struct member offsets.
static final int	UNTAG	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static PathRead	calloc()	Returns a new PathRead instance allocated with memCalloc.
static PathRead.Buffer	calloc(int capacity)	Returns a new PathRead.Buffer instance allocated with memCalloc.
static PathRead.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new PathRead.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static PathRead	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new PathRead instance allocated on the specified MemoryStack and initializes all its bits to zero.
static PathRead	create()	Returns a new PathRead instance allocated with BufferUtils.
static PathRead.Buffer	create(int capacity)	Returns a new PathRead.Buffer instance allocated with BufferUtils.
static PathRead	create(long address)	Returns a new PathRead instance for the specified memory address.
static PathRead.Buffer	create(long address, int capacity)	Create a PathRead.Buffer instance at the specified memory.
static @Nullable PathRead	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable PathRead.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	eError()	one of: VR.ETrackedPropertyError_TrackedProp_SuccessVR.ETrackedPropertyError_TrackedProp_WrongDataTypeVR.ETrackedPropertyError_TrackedProp_WrongDeviceClassVR.ETrackedPropertyError_TrackedProp_BufferTooSmallVR.ETrackedPropertyError_TrackedProp_UnknownPropertyVR.ETrackedPropertyError_TrackedProp_InvalidDeviceVR.ETrackedPropertyError_TrackedProp_CouldNotContactServerVR.ETrackedPropertyError_TrackedProp_ValueNotProvidedByDeviceVR.ETrackedPropertyError_TrackedProp_StringExceedsMaximumLengthVR.ETrackedPropertyError_TrackedProp_NotYetAvailableVR.ETrackedPropertyError_TrackedProp_PermissionDeniedVR.ETrackedPropertyError_TrackedProp_InvalidOperationVR.ETrackedPropertyError_TrackedProp_CannotWriteToWildcardsVR.ETrackedPropertyError_TrackedProp_IPCReadFailureVR.ETrackedPropertyError_TrackedProp_OutOfMemoryVR.ETrackedPropertyError_TrackedProp_InvalidContainer
PathRead	eError(int value)	Sets the specified value to the eError() field.
static PathRead	malloc()	Returns a new PathRead instance allocated with memAlloc.
static PathRead.Buffer	malloc(int capacity)	Returns a new PathRead.Buffer instance allocated with memAlloc.
static PathRead.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new PathRead.Buffer instance allocated on the specified MemoryStack.
static PathRead	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new PathRead instance allocated on the specified MemoryStack.
static int	neError(long struct)	Unsafe version of eError().
static void	neError(long struct, int value)	Unsafe version of eError.
static ByteBuffer	npszPath(long struct)	Unsafe version of pszPath().
static void	npszPath(long struct, ByteBuffer value)	Unsafe version of pszPath.
static String	npszPathString(long struct)	Unsafe version of pszPathString().
static ByteBuffer	npvBuffer(long struct)	Unsafe version of pvBuffer.
static void	npvBuffer(long struct, ByteBuffer value)	Unsafe version of pvBuffer.
static long	nulPath(long struct)	Unsafe version of ulPath().
static void	nulPath(long struct, long value)	Unsafe version of ulPath.
static int	nunBufferSize(long struct)	Unsafe version of unBufferSize().
static void	nunBufferSize(long struct, int value)	Sets the specified value to the unBufferSize field of the specified struct.
static int	nunRequiredBufferSize(long struct)	Unsafe version of unRequiredBufferSize().
static void	nunRequiredBufferSize(long struct, int value)	Unsafe version of unRequiredBufferSize.
static int	nunTag(long struct)	Unsafe version of unTag().
static void	nunTag(long struct, int value)	Unsafe version of unTag.
ByteBuffer	pszPath()
PathRead	pszPath(ByteBuffer value)	Sets the address of the specified encoded string to the pszPath field.
String	pszPathString()
ByteBuffer	pvBuffer()
PathRead	pvBuffer(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pvBuffer field.
PathRead	set(long ulPath, ByteBuffer pvBuffer, int unTag, int unRequiredBufferSize, int eError, ByteBuffer pszPath)	Initializes this struct with the specified values.
PathRead	set(PathRead src)	Copies the specified struct data to this struct.
int	sizeof()
long	ulPath()
PathRead	ulPath(long value)	Sets the specified value to the ulPath field.
int	unBufferSize()
int	unRequiredBufferSize()
PathRead	unRequiredBufferSize(int value)	Sets the specified value to the unRequiredBufferSize field.
int	unTag()
PathRead	unTag(int value)	Sets the specified value to the unTag field.
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, 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.

ULPATH

public static final int ULPATH

The struct member offsets.

PVBUFFER

public static final int PVBUFFER

The struct member offsets.

UNBUFFERSIZE

public static final int UNBUFFERSIZE

The struct member offsets.

UNTAG

public static final int UNTAG

The struct member offsets.

UNREQUIREDBUFFERSIZE

public static final int UNREQUIREDBUFFERSIZE

The struct member offsets.

EERROR

public static final int EERROR

The struct member offsets.

PSZPATH

public static final int PSZPATH

The struct member offsets.

Constructor Details

PathRead

public PathRead(ByteBuffer container)

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

Specified by:

sizeof in class org.lwjgl.system.Struct<PathRead>

ulPath

public long ulPath()

Returns:

the value of the ulPath field.

pvBuffer

public ByteBuffer pvBuffer()

Returns:

a ByteBuffer view of the data pointed to by the pvBuffer field.

unBufferSize

public int unBufferSize()

Returns:

the value of the unBufferSize field.

unTag

public int unTag()

Returns:

the value of the unTag field.

unRequiredBufferSize

public int unRequiredBufferSize()

Returns:

the value of the unRequiredBufferSize field.

eError

public int eError()

one of:

VR.ETrackedPropertyError_TrackedProp_Success

VR.ETrackedPropertyError_TrackedProp_WrongDataType

VR.ETrackedPropertyError_TrackedProp_WrongDeviceClass

VR.ETrackedPropertyError_TrackedProp_BufferTooSmall

VR.ETrackedPropertyError_TrackedProp_UnknownProperty

VR.ETrackedPropertyError_TrackedProp_InvalidDevice

VR.ETrackedPropertyError_TrackedProp_CouldNotContactServer

VR.ETrackedPropertyError_TrackedProp_ValueNotProvidedByDevice

VR.ETrackedPropertyError_TrackedProp_StringExceedsMaximumLength

VR.ETrackedPropertyError_TrackedProp_NotYetAvailable

VR.ETrackedPropertyError_TrackedProp_PermissionDenied

VR.ETrackedPropertyError_TrackedProp_InvalidOperation

VR.ETrackedPropertyError_TrackedProp_CannotWriteToWildcards

VR.ETrackedPropertyError_TrackedProp_IPCReadFailure

VR.ETrackedPropertyError_TrackedProp_OutOfMemory

VR.ETrackedPropertyError_TrackedProp_InvalidContainer

pszPath

public ByteBuffer pszPath()

Returns:

a ByteBuffer view of the null-terminated string pointed to by the pszPath field.

pszPathString

public String pszPathString()

Returns:

the null-terminated string pointed to by the pszPath field.

ulPath

public PathRead ulPath(long value)

Sets the specified value to the ulPath field.

pvBuffer

public PathRead pvBuffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pvBuffer field.

unTag

public PathRead unTag(int value)

Sets the specified value to the unTag field.

unRequiredBufferSize

public PathRead unRequiredBufferSize(int value)

Sets the specified value to the unRequiredBufferSize field.

eError

public PathRead eError(int value)

Sets the specified value to the eError() field.

pszPath

public PathRead pszPath(ByteBuffer value)

Sets the address of the specified encoded string to the pszPath field.

set

public PathRead set(long ulPath,
 ByteBuffer pvBuffer,
 int unTag,
 int unRequiredBufferSize,
 int eError,
 ByteBuffer pszPath)

Initializes this struct with the specified values.

set

public PathRead set(PathRead src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static PathRead malloc()

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

calloc

public static PathRead calloc()

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

create

public static PathRead create()

Returns a new PathRead instance allocated with BufferUtils.

create

public static PathRead create(long address)

Returns a new PathRead instance for the specified memory address.

createSafe

public static @Nullable PathRead createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static PathRead.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static PathRead.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static PathRead.Buffer create(int capacity)

Returns a new PathRead.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a PathRead.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static PathRead malloc(org.lwjgl.system.MemoryStack stack)

Returns a new PathRead instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static PathRead calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static PathRead.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static PathRead.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new PathRead.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

nulPath

public static long nulPath(long struct)

Unsafe version of ulPath().

npvBuffer

public static ByteBuffer npvBuffer(long struct)

Unsafe version of pvBuffer.

nunBufferSize

public static int nunBufferSize(long struct)

Unsafe version of unBufferSize().

nunTag

public static int nunTag(long struct)

Unsafe version of unTag().

nunRequiredBufferSize

public static int nunRequiredBufferSize(long struct)

Unsafe version of unRequiredBufferSize().

neError

public static int neError(long struct)

Unsafe version of eError().

npszPath

public static ByteBuffer npszPath(long struct)

Unsafe version of pszPath().

npszPathString

public static String npszPathString(long struct)

Unsafe version of pszPathString().

nulPath

public static void nulPath(long struct,
 long value)

Unsafe version of ulPath.

npvBuffer

public static void npvBuffer(long struct,
 ByteBuffer value)

Unsafe version of pvBuffer.

nunBufferSize

public static void nunBufferSize(long struct,
 int value)

Sets the specified value to the unBufferSize field of the specified struct.

nunTag

public static void nunTag(long struct,
 int value)

Unsafe version of unTag.

nunRequiredBufferSize

public static void nunRequiredBufferSize(long struct,
 int value)

Unsafe version of unRequiredBufferSize.

neError

public static void neError(long struct,
 int value)

Unsafe version of eError.

npszPath

public static void npszPath(long struct,
 ByteBuffer value)

Unsafe version of pszPath.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate