Top Description Inners Fields Constructors Methods
org.lwjgl.openvr

public Class PathRead

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

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
PathRead.Buffer

An array of PathRead structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EERROR

The struct member offsets.

public static final int
PSZPATH

The struct member offsets.

public static final int
PVBUFFER

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
ULPATH

The struct member offsets.

public static final int
UNBUFFERSIZE

The struct member offsets.

public static final int
UNREQUIREDBUFFERSIZE

The struct member offsets.

public static final int
UNTAG

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
PathRead(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static PathRead
calloc()

Returns a new PathRead instance allocated with memCalloc.

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

Returns a new PathRead.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new PathRead instance allocated with BufferUtils.

public static PathRead
create(long address)

Returns a new PathRead instance for the specified memory address.

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

Returns a new PathRead.Buffer instance allocated with BufferUtils.

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

Create a PathRead.Buffer instance at the specified memory.

public static PathRead
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
public PathRead
eError(int value)

Sets the specified value to the eError field.

public static PathRead
malloc()

Returns a new PathRead instance allocated with memAlloc.

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

Returns a new PathRead.Buffer instance allocated with memAlloc.

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

Returns a new PathRead instance allocated on the specified MemoryStack.

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

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

public static int
neError(long struct)

Unsafe version of eError.

public static void
neError(long struct, int value)

Unsafe version of eError.

public static ByteBuffer
npszPath(long struct)

Unsafe version of pszPath.

public static void
npszPath(long struct, ByteBuffer value)

Unsafe version of pszPath.

public static String
npszPathString(long struct)

Unsafe version of pszPathString.

public static ByteBuffer
npvBuffer(long struct)

Unsafe version of pvBuffer.

public static void
npvBuffer(long struct, ByteBuffer value)

Unsafe version of pvBuffer.

public static long
nulPath(long struct)

Unsafe version of ulPath.

public static void
nulPath(long struct, long value)

Unsafe version of ulPath.

public static int
nunBufferSize(long struct)

Unsafe version of unBufferSize.

public static void
nunBufferSize(long struct, int value)

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

public static int
nunRequiredBufferSize(long struct)

Unsafe version of unRequiredBufferSize.

public static void
nunRequiredBufferSize(long struct, int value)

Unsafe version of unRequiredBufferSize.

public static int
nunTag(long struct)

Unsafe version of unTag.

public static void
nunTag(long struct, int value)

Unsafe version of unTag.

public ByteBuffer

Returns:

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

public PathRead
pszPath(ByteBuffer value)

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

public String

Returns:

the null-terminated string pointed to by the pszPath field.
pszPathString
()

public ByteBuffer

Returns:

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

public PathRead
pvBuffer(ByteBuffer value)

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

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

Initializes this struct with the specified values.

public PathRead

Returns:

this struct
set
(PathRead
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

Returns:

the value of the ulPath field.
ulPath
()

public PathRead
ulPath(long value)

Sets the specified value to the ulPath field.

public int

Returns:

the value of the unBufferSize field.
unBufferSize
()

public int

Returns:

the value of the unRequiredBufferSize field.
unRequiredBufferSize
()

public PathRead
unRequiredBufferSize(int value)

Sets the specified value to the unRequiredBufferSize field.

public int

Returns:

the value of the unTag field.
unTag
()

public PathRead
unTag(int value)

Sets the specified value to the unTag field.

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.

EERRORback to summary
public static final int EERROR

The struct member offsets.

PSZPATHback to summary
public static final int PSZPATH

The struct member offsets.

PVBUFFERback to summary
public static final int PVBUFFER

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

ULPATHback to summary
public static final int ULPATH

The struct member offsets.

UNBUFFERSIZEback to summary
public static final int UNBUFFERSIZE

The struct member offsets.

UNREQUIREDBUFFERSIZEback to summary
public static final int UNREQUIREDBUFFERSIZE

The struct member offsets.

UNTAGback to summary
public static final int UNTAG

The struct member offsets.

Constructor Detail

PathReadback to summary
protected PathRead(long address, ByteBuffer container)
PathReadback to summary
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 Detail

callocback to summary
public static PathRead calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static PathRead calloc(MemoryStack stack)

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

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

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

Returns a new PathRead instance allocated with BufferUtils.

createback to summary
public static PathRead create(long address)

Returns a new PathRead instance for the specified memory address.

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

Returns a new PathRead.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a PathRead.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static PathRead createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
eErrorback to summary
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
Annotations
@NativeType:ETrackedPropertyError
eErrorback to summary
public PathRead eError(int value)

Sets the specified value to the eError field.

mallocback to summary
public static PathRead malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static PathRead malloc(MemoryStack stack)

Returns a new PathRead instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

neErrorback to summary
public static int neError(long struct)

Unsafe version of eError.

neErrorback to summary
public static void neError(long struct, int value)

Unsafe version of eError.

npszPathback to summary
public static ByteBuffer npszPath(long struct)

Unsafe version of pszPath.

npszPathback to summary
public static void npszPath(long struct, ByteBuffer value)

Unsafe version of pszPath.

npszPathStringback to summary
public static String npszPathString(long struct)

Unsafe version of pszPathString.

npvBufferback to summary
public static ByteBuffer npvBuffer(long struct)

Unsafe version of pvBuffer.

npvBufferback to summary
public static void npvBuffer(long struct, ByteBuffer value)

Unsafe version of pvBuffer.

nulPathback to summary
public static long nulPath(long struct)

Unsafe version of ulPath.

nulPathback to summary
public static void nulPath(long struct, long value)

Unsafe version of ulPath.

nunBufferSizeback to summary
public static int nunBufferSize(long struct)

Unsafe version of unBufferSize.

nunBufferSizeback to summary
public static void nunBufferSize(long struct, int value)

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

nunRequiredBufferSizeback to summary
public static int nunRequiredBufferSize(long struct)

Unsafe version of unRequiredBufferSize.

nunRequiredBufferSizeback to summary
public static void nunRequiredBufferSize(long struct, int value)

Unsafe version of unRequiredBufferSize.

nunTagback to summary
public static int nunTag(long struct)

Unsafe version of unTag.

nunTagback to summary
public static void nunTag(long struct, int value)

Unsafe version of unTag.

pszPathback to summary
public ByteBuffer pszPath()
Returns:ByteBuffer

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

Annotations
@NativeType:char *
pszPathback to summary
public PathRead pszPath(ByteBuffer value)

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

pszPathStringback to summary
public String pszPathString()
Returns:String

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

Annotations
@NativeType:char *
pvBufferback to summary
public ByteBuffer pvBuffer()
Returns:ByteBuffer

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

Annotations
@NativeType:void *
pvBufferback to summary
public PathRead pvBuffer(ByteBuffer value)

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

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

Initializes this struct with the specified values.

setback to summary
public PathRead set(PathRead src)

Copies the specified struct data to this struct.

Parameters
src:PathRead

the source struct

Returns:PathRead

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
ulPathback to summary
public long ulPath()
Returns:long

the value of the ulPath field.

Annotations
@NativeType:PathHandle_t
ulPathback to summary
public PathRead ulPath(long value)

Sets the specified value to the ulPath field.

unBufferSizeback to summary
public int unBufferSize()
Returns:int

the value of the unBufferSize field.

Annotations
@NativeType:uint32_t
unRequiredBufferSizeback to summary
public int unRequiredBufferSize()
Returns:int

the value of the unRequiredBufferSize field.

Annotations
@NativeType:uint32_t
unRequiredBufferSizeback to summary
public PathRead unRequiredBufferSize(int value)

Sets the specified value to the unRequiredBufferSize field.

unTagback to summary
public int unTag()
Returns:int

the value of the unTag field.

Annotations
@NativeType:PropertyTypeTag_t
unTagback to summary
public PathRead unTag(int value)

Sets the specified value to the unTag field.

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.openvr back to summary

public Class PathRead.Buffer

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

An array of PathRead structs.

Field Summary

Modifier and TypeField and Description
private static final PathRead

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

the value of the PathRead#eError field.
eError
()

public PathRead.Buffer
eError(int value)

Sets the specified value to the PathRead#eError field.

protected PathRead
public ByteBuffer

Returns:

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

public PathRead.Buffer
pszPath(ByteBuffer value)

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

public String

Returns:

the null-terminated string pointed to by the pszPath field.
pszPathString
()

public ByteBuffer

Returns:

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

public PathRead.Buffer
pvBuffer(ByteBuffer value)

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

protected PathRead.Buffer
public long

Returns:

the value of the ulPath field.
ulPath
()

public PathRead.Buffer
ulPath(long value)

Sets the specified value to the ulPath field.

public int

Returns:

the value of the unBufferSize field.
unBufferSize
()

public int

Returns:

the value of the unRequiredBufferSize field.
unRequiredBufferSize
()

public PathRead.Buffer
unRequiredBufferSize(int value)

Sets the specified value to the unRequiredBufferSize field.

public int

Returns:

the value of the unTag field.
unTag
()

public PathRead.Buffer
unTag(int value)

Sets the specified value to the unTag field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final PathRead ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

eErrorback to summary
public int eError()
Returns:int

the value of the PathRead#eError field.

Annotations
@NativeType:ETrackedPropertyError
eErrorback to summary
public PathRead.Buffer eError(int value)

Sets the specified value to the PathRead#eError field.

getElementFactoryback to summary
protected PathRead getElementFactory()

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

Annotations
@Override
pszPathback to summary
public ByteBuffer pszPath()
Returns:ByteBuffer

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

Annotations
@NativeType:char *
pszPathback to summary
public PathRead.Buffer pszPath(ByteBuffer value)

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

pszPathStringback to summary
public String pszPathString()
Returns:String

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

Annotations
@NativeType:char *
pvBufferback to summary
public ByteBuffer pvBuffer()
Returns:ByteBuffer

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

Annotations
@NativeType:void *
pvBufferback to summary
public PathRead.Buffer pvBuffer(ByteBuffer value)

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

selfback to summary
protected PathRead.Buffer self()

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

Annotations
@Override
ulPathback to summary
public long ulPath()
Returns:long

the value of the ulPath field.

Annotations
@NativeType:PathHandle_t
ulPathback to summary
public PathRead.Buffer ulPath(long value)

Sets the specified value to the ulPath field.

unBufferSizeback to summary
public int unBufferSize()
Returns:int

the value of the unBufferSize field.

Annotations
@NativeType:uint32_t
unRequiredBufferSizeback to summary
public int unRequiredBufferSize()
Returns:int

the value of the unRequiredBufferSize field.

Annotations
@NativeType:uint32_t
unRequiredBufferSizeback to summary
public PathRead.Buffer unRequiredBufferSize(int value)

Sets the specified value to the unRequiredBufferSize field.

unTagback to summary
public int unTag()
Returns:int

the value of the unTag field.

Annotations
@NativeType:PropertyTypeTag_t
unTagback to summary
public PathRead.Buffer unTag(int value)

Sets the specified value to the unTag field.