Top Description Inners Fields Constructors Methods
org.lwjgl.openvr

public Class CameraVideoStreamFrameHeader

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

Layout


struct CameraVideoStreamFrameHeader_t {
    EVRTrackedCameraFrameType eFrameType;
    uint32_t nWidth;
    uint32_t nHeight;
    uint32_t nBytesPerPixel;
    uint32_t nFrameSequence;
    TrackedDevicePose_t trackedDevicePose;
    uint64_t ulFrameExposureTime;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CameraVideoStreamFrameHeader.Buffer

An array of CameraVideoStreamFrameHeader structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
EFRAMETYPE

The struct member offsets.

public static final int
NBYTESPERPIXEL

The struct member offsets.

public static final int
NFRAMESEQUENCE

The struct member offsets.

public static final int
NHEIGHT

The struct member offsets.

public static final int
NWIDTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TRACKEDDEVICEPOSE

The struct member offsets.

public static final int
ULFRAMEEXPOSURETIME

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
CameraVideoStreamFrameHeader(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static CameraVideoStreamFrameHeader
calloc()

Returns a new CameraVideoStreamFrameHeader instance allocated with memCalloc.

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

Returns a new CameraVideoStreamFrameHeader.Buffer instance allocated with memCalloc.

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

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

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

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

public static CameraVideoStreamFrameHeader
callocStack()

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

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

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

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

Returns a new CameraVideoStreamFrameHeader instance allocated with BufferUtils.

public static CameraVideoStreamFrameHeader
create(long address)

Returns a new CameraVideoStreamFrameHeader instance for the specified memory address.

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

Returns a new CameraVideoStreamFrameHeader.Buffer instance allocated with BufferUtils.

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

Create a CameraVideoStreamFrameHeader.Buffer instance at the specified memory.

public static CameraVideoStreamFrameHeader
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int

Returns:

the value of the eFrameType field.
eFrameType()

public static CameraVideoStreamFrameHeader
malloc()

Returns a new CameraVideoStreamFrameHeader instance allocated with memAlloc.

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

Returns a new CameraVideoStreamFrameHeader.Buffer instance allocated with memAlloc.

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

Returns a new CameraVideoStreamFrameHeader instance allocated on the specified MemoryStack.

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

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

public static CameraVideoStreamFrameHeader
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int

Returns:

the value of the nBytesPerPixel field.
nBytesPerPixel()

public static int
neFrameType(long struct)

Unsafe version of eFrameType.

public int

Returns:

the value of the nFrameSequence field.
nFrameSequence()

public int

Returns:

the value of the nHeight field.
nHeight()

public static int
nnBytesPerPixel(long struct)

Unsafe version of nBytesPerPixel.

public static int
nnFrameSequence(long struct)

Unsafe version of nFrameSequence.

public static int
nnHeight(long struct)

Unsafe version of nHeight.

public static int
nnWidth(long struct)

Unsafe version of nWidth.

public static TrackedDevicePose
ntrackedDevicePose(long struct)

Unsafe version of trackedDevicePose.

public static long
nulFrameExposureTime(long struct)

Unsafe version of ulFrameExposureTime.

public int

Returns:

the value of the nWidth field.
nWidth()

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public TrackedDevicePose

Returns:

a TrackedDevicePose view of the trackedDevicePose field.
trackedDevicePose()

public long
ulFrameExposureTime()

mid-point of the exposure of the image in host system ticks

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.

EFRAMETYPEback to summary
public static final int EFRAMETYPE

The struct member offsets.

NBYTESPERPIXELback to summary
public static final int NBYTESPERPIXEL

The struct member offsets.

NFRAMESEQUENCEback to summary
public static final int NFRAMESEQUENCE

The struct member offsets.

NHEIGHTback to summary
public static final int NHEIGHT

The struct member offsets.

NWIDTHback to summary
public static final int NWIDTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TRACKEDDEVICEPOSEback to summary
public static final int TRACKEDDEVICEPOSE

The struct member offsets.

ULFRAMEEXPOSURETIMEback to summary
public static final int ULFRAMEEXPOSURETIME

The struct member offsets.

Constructor Detail

CameraVideoStreamFrameHeaderback to summary
protected CameraVideoStreamFrameHeader(long address, ByteBuffer container)
CameraVideoStreamFrameHeaderback to summary
public CameraVideoStreamFrameHeader(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CameraVideoStreamFrameHeader calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new CameraVideoStreamFrameHeader instance allocated with BufferUtils.

createback to summary
public static CameraVideoStreamFrameHeader create(long address)

Returns a new CameraVideoStreamFrameHeader instance for the specified memory address.

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

Returns a new CameraVideoStreamFrameHeader.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a CameraVideoStreamFrameHeader.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CameraVideoStreamFrameHeader createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
eFrameTypeback to summary
public int eFrameType()
Returns:int

the value of the eFrameType field.

Annotations
@NativeType:EVRTrackedCameraFrameType
mallocback to summary
public static CameraVideoStreamFrameHeader malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CameraVideoStreamFrameHeader malloc(MemoryStack stack)

Returns a new CameraVideoStreamFrameHeader instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
nBytesPerPixelback to summary
public int nBytesPerPixel()
Returns:int

the value of the nBytesPerPixel field.

Annotations
@NativeType:uint32_t
neFrameTypeback to summary
public static int neFrameType(long struct)

Unsafe version of eFrameType.

nFrameSequenceback to summary
public int nFrameSequence()
Returns:int

the value of the nFrameSequence field.

Annotations
@NativeType:uint32_t
nHeightback to summary
public int nHeight()
Returns:int

the value of the nHeight field.

Annotations
@NativeType:uint32_t
nnBytesPerPixelback to summary
public static int nnBytesPerPixel(long struct)

Unsafe version of nBytesPerPixel.

nnFrameSequenceback to summary
public static int nnFrameSequence(long struct)

Unsafe version of nFrameSequence.

nnHeightback to summary
public static int nnHeight(long struct)

Unsafe version of nHeight.

nnWidthback to summary
public static int nnWidth(long struct)

Unsafe version of nWidth.

ntrackedDevicePoseback to summary
public static TrackedDevicePose ntrackedDevicePose(long struct)

Unsafe version of trackedDevicePose.

nulFrameExposureTimeback to summary
public static long nulFrameExposureTime(long struct)

Unsafe version of ulFrameExposureTime.

nWidthback to summary
public int nWidth()
Returns:int

the value of the nWidth field.

Annotations
@NativeType:uint32_t
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
trackedDevicePoseback to summary
public TrackedDevicePose trackedDevicePose()
Returns:TrackedDevicePose

a TrackedDevicePose view of the trackedDevicePose field.

Annotations
@NativeType:TrackedDevicePose_t
ulFrameExposureTimeback to summary
public long ulFrameExposureTime()

mid-point of the exposure of the image in host system ticks

Annotations
@NativeType:uint64_t
org.lwjgl.openvr back to summary

public Class CameraVideoStreamFrameHeader.Buffer

extends StructBuffer<CameraVideoStreamFrameHeader, CameraVideoStreamFrameHeader.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of CameraVideoStreamFrameHeader structs.

Field Summary

Modifier and TypeField and Description
private static final CameraVideoStreamFrameHeader
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CameraVideoStreamFrameHeader.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 eFrameType field.
eFrameType()

protected CameraVideoStreamFrameHeader
getElementFactory()

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

public int

Returns:

the value of the nBytesPerPixel field.
nBytesPerPixel()

public int

Returns:

the value of the nFrameSequence field.
nFrameSequence()

public int

Returns:

the value of the nHeight field.
nHeight()

public int

Returns:

the value of the nWidth field.
nWidth()

protected CameraVideoStreamFrameHeader.Buffer
self()

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

public TrackedDevicePose

Returns:

a TrackedDevicePose view of the trackedDevicePose field.
trackedDevicePose()

public long

Returns:

the value of the CameraVideoStreamFrameHeader#ulFrameExposureTime field.
ulFrameExposureTime()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CameraVideoStreamFrameHeader ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

eFrameTypeback to summary
public int eFrameType()
Returns:int

the value of the eFrameType field.

Annotations
@NativeType:EVRTrackedCameraFrameType
getElementFactoryback to summary
protected CameraVideoStreamFrameHeader getElementFactory()

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

Annotations
@Override
nBytesPerPixelback to summary
public int nBytesPerPixel()
Returns:int

the value of the nBytesPerPixel field.

Annotations
@NativeType:uint32_t
nFrameSequenceback to summary
public int nFrameSequence()
Returns:int

the value of the nFrameSequence field.

Annotations
@NativeType:uint32_t
nHeightback to summary
public int nHeight()
Returns:int

the value of the nHeight field.

Annotations
@NativeType:uint32_t
nWidthback to summary
public int nWidth()
Returns:int

the value of the nWidth field.

Annotations
@NativeType:uint32_t
selfback to summary
protected CameraVideoStreamFrameHeader.Buffer self()

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

Annotations
@Override
trackedDevicePoseback to summary
public TrackedDevicePose trackedDevicePose()
Returns:TrackedDevicePose

a TrackedDevicePose view of the trackedDevicePose field.

Annotations
@NativeType:TrackedDevicePose_t
ulFrameExposureTimeback to summary
public long ulFrameExposureTime()
Returns:long

the value of the CameraVideoStreamFrameHeader#ulFrameExposureTime field.

Annotations
@NativeType:uint64_t