Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrPassthroughColorHTC

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

The alpha value of the passthrough.
Description

The application can specify the XrPassthroughColorHTC to adjust the alpha value of the passthrough. The range is between 0.0f and 1.0f, 1.0f means opaque.

Valid Usage (Implicit)
See Also

XrCompositionLayerPassthroughHTC

Layout


struct XrPassthroughColorHTC {
    XrStructureType type;
    void const * next;
    float alpha;
}

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
ALPHA

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrPassthroughColorHTC(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public float
alpha()

the alpha value of the passthrough in the range [0, 1].

public XrPassthroughColorHTC
alpha(float value)

Sets the specified value to the alpha field.

public static XrPassthroughColorHTC
calloc()

Returns a new XrPassthroughColorHTC instance allocated with memCalloc.

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

Returns a new XrPassthroughColorHTC.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrPassthroughColorHTC instance allocated with BufferUtils.

public static XrPassthroughColorHTC
create(long address)

Returns a new XrPassthroughColorHTC instance for the specified memory address.

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

Returns a new XrPassthroughColorHTC.Buffer instance allocated with BufferUtils.

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

Create a XrPassthroughColorHTC.Buffer instance at the specified memory.

public static XrPassthroughColorHTC
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrPassthroughColorHTC
malloc()

Returns a new XrPassthroughColorHTC instance allocated with memAlloc.

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

Returns a new XrPassthroughColorHTC.Buffer instance allocated with memAlloc.

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

Returns a new XrPassthroughColorHTC instance allocated on the specified MemoryStack.

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

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

public static float
nalpha(long struct)

Unsafe version of alpha.

public static void
nalpha(long struct, float value)

Unsafe version of alpha.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrPassthroughColorHTC
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPassthroughColorHTC
set(int type, long next, float alpha)

Initializes this struct with the specified values.

public XrPassthroughColorHTC

Returns:

this struct
set
(XrPassthroughColorHTC
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 int
type()

the XrStructureType of this structure.

public XrPassthroughColorHTC
type(int value)

Sets the specified value to the type field.

public XrPassthroughColorHTC
type$Default()

Sets the TYPE_PASSTHROUGH_COLOR_HTC value to the type 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.

ALPHAback to summary
public static final int ALPHA

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrPassthroughColorHTCback to summary
protected XrPassthroughColorHTC(long address, ByteBuffer container)
XrPassthroughColorHTCback to summary
public XrPassthroughColorHTC(ByteBuffer container)

Creates a XrPassthroughColorHTC 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

alphaback to summary
public float alpha()

the alpha value of the passthrough in the range [0, 1].

alphaback to summary
public XrPassthroughColorHTC alpha(float value)

Sets the specified value to the alpha field.

callocback to summary
public static XrPassthroughColorHTC calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrPassthroughColorHTC calloc(MemoryStack stack)

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

Returns a new XrPassthroughColorHTC.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 XrPassthroughColorHTC 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 XrPassthroughColorHTC create()

Returns a new XrPassthroughColorHTC instance allocated with BufferUtils.

createback to summary
public static XrPassthroughColorHTC create(long address)

Returns a new XrPassthroughColorHTC instance for the specified memory address.

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

Returns a new XrPassthroughColorHTC.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrPassthroughColorHTC.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrPassthroughColorHTC createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrPassthroughColorHTC malloc(MemoryStack stack)

Returns a new XrPassthroughColorHTC instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nalphaback to summary
public static float nalpha(long struct)

Unsafe version of alpha.

nalphaback to summary
public static void nalpha(long struct, float value)

Unsafe version of alpha.

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain.

Annotations
@NativeType:void const *
nextback to summary
public XrPassthroughColorHTC next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public XrPassthroughColorHTC set(int type, long next, float alpha)

Initializes this struct with the specified values.

setback to summary
public XrPassthroughColorHTC set(XrPassthroughColorHTC src)

Copies the specified struct data to this struct.

Parameters
src:XrPassthroughColorHTC

the source struct

Returns:XrPassthroughColorHTC

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
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrPassthroughColorHTC type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrPassthroughColorHTC type$Default()

Sets the TYPE_PASSTHROUGH_COLOR_HTC value to the type field.

org.lwjgl.openxr back to summary

public Class XrPassthroughColorHTC.Buffer

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

An array of XrPassthroughColorHTC structs.

Field Summary

Modifier and TypeField and Description
private static final XrPassthroughColorHTC

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrPassthroughColorHTC.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 float

Returns:

the value of the XrPassthroughColorHTC#alpha field.
alpha
()

public XrPassthroughColorHTC.Buffer
alpha(float value)

Sets the specified value to the XrPassthroughColorHTC#alpha field.

protected XrPassthroughColorHTC
public long

Returns:

the value of the XrPassthroughColorHTC#next field.
next
()

public XrPassthroughColorHTC.Buffer
next(long value)

Sets the specified value to the XrPassthroughColorHTC#next field.

protected XrPassthroughColorHTC.Buffer
public int

Returns:

the value of the XrPassthroughColorHTC#type field.
type
()

public XrPassthroughColorHTC.Buffer
type(int value)

Sets the specified value to the XrPassthroughColorHTC#type field.

public XrPassthroughColorHTC.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrPassthroughColorHTC ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

alphaback to summary
public float alpha()
Returns:float

the value of the XrPassthroughColorHTC#alpha field.

alphaback to summary
public XrPassthroughColorHTC.Buffer alpha(float value)

Sets the specified value to the XrPassthroughColorHTC#alpha field.

getElementFactoryback to summary
protected XrPassthroughColorHTC getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrPassthroughColorHTC#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrPassthroughColorHTC.Buffer next(long value)

Sets the specified value to the XrPassthroughColorHTC#next field.

selfback to summary
protected XrPassthroughColorHTC.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrPassthroughColorHTC#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrPassthroughColorHTC.Buffer type(int value)

Sets the specified value to the XrPassthroughColorHTC#type field.

type$Defaultback to summary
public XrPassthroughColorHTC.Buffer type$Default()

Sets the TYPE_PASSTHROUGH_COLOR_HTC value to the XrPassthroughColorHTC#type field.