Top Description Inners Fields Constructors Methods
org.lwjgl.ovr

public Class ovrHmdColorDesc

extends Struct<ovrHmdColorDesc>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Layout


struct ovrHmdColorDesc {
    ovrColorSpace ColorSpace;
    char[4];
}

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
COLORSPACE

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

public
ovrHmdColorDesc(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static ovrHmdColorDesc
calloc()

Returns a new ovrHmdColorDesc instance allocated with memCalloc.

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

Returns a new ovrHmdColorDesc.Buffer instance allocated with memCalloc.

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

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

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

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

public int
ColorSpace()

Approximate color space the HMD display can output.

public ovrHmdColorDesc
ColorSpace(int value)

Sets the specified value to the ColorSpace field.

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

Returns a new ovrHmdColorDesc instance allocated with BufferUtils.

public static ovrHmdColorDesc
create(long address)

Returns a new ovrHmdColorDesc instance for the specified memory address.

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

Returns a new ovrHmdColorDesc.Buffer instance allocated with BufferUtils.

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

Create a ovrHmdColorDesc.Buffer instance at the specified memory.

public static ovrHmdColorDesc
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static ovrHmdColorDesc
malloc()

Returns a new ovrHmdColorDesc instance allocated with memAlloc.

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

Returns a new ovrHmdColorDesc.Buffer instance allocated with memAlloc.

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

Returns a new ovrHmdColorDesc instance allocated on the specified MemoryStack.

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

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

public static int
nColorSpace(long struct)

Unsafe version of ColorSpace.

public static void
nColorSpace(long struct, int value)

Unsafe version of ColorSpace.

public ovrHmdColorDesc

Returns:

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

COLORSPACEback to summary
public static final int COLORSPACE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

ovrHmdColorDescback to summary
protected ovrHmdColorDesc(long address, ByteBuffer container)
ovrHmdColorDescback to summary
public ovrHmdColorDesc(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static ovrHmdColorDesc calloc(MemoryStack stack)

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

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

ColorSpaceback to summary
public int ColorSpace()

Approximate color space the HMD display can output.

Use ColorPrimaries for more precise color space definition including white point (e.g. DN75)

Annotations
@NativeType:ovrColorSpace
ColorSpaceback to summary
public ovrHmdColorDesc ColorSpace(int value)

Sets the specified value to the ColorSpace field.

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

Returns a new ovrHmdColorDesc instance allocated with BufferUtils.

createback to summary
public static ovrHmdColorDesc create(long address)

Returns a new ovrHmdColorDesc instance for the specified memory address.

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

Returns a new ovrHmdColorDesc.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a ovrHmdColorDesc.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static ovrHmdColorDesc createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static ovrHmdColorDesc malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static ovrHmdColorDesc malloc(MemoryStack stack)

Returns a new ovrHmdColorDesc instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nColorSpaceback to summary
public static int nColorSpace(long struct)

Unsafe version of ColorSpace.

nColorSpaceback to summary
public static void nColorSpace(long struct, int value)

Unsafe version of ColorSpace.

setback to summary
public ovrHmdColorDesc set(ovrHmdColorDesc src)

Copies the specified struct data to this struct.

Parameters
src:ovrHmdColorDesc

the source struct

Returns:ovrHmdColorDesc

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 ovrHmdColorDesc.Buffer

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

An array of ovrHmdColorDesc structs.

Field Summary

Modifier and TypeField and Description
private static final ovrHmdColorDesc

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new ovrHmdColorDesc.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 ovrHmdColorDesc#ColorSpace field.
ColorSpace
()

public ovrHmdColorDesc.Buffer
ColorSpace(int value)

Sets the specified value to the ovrHmdColorDesc#ColorSpace field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final ovrHmdColorDesc ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

ColorSpaceback to summary
public int ColorSpace()
Returns:int

the value of the ovrHmdColorDesc#ColorSpace field.

Annotations
@NativeType:ovrColorSpace
ColorSpaceback to summary
public ovrHmdColorDesc.Buffer ColorSpace(int value)

Sets the specified value to the ovrHmdColorDesc#ColorSpace field.

getElementFactoryback to summary
protected ovrHmdColorDesc getElementFactory()

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

Annotations
@Override
selfback to summary
protected ovrHmdColorDesc.Buffer self()

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

Annotations
@Override