Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrPassthroughStyleFB

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

A layer style.
Description

XrPassthroughStyleFB lets applications customize the appearance of passthrough layers. In addition to the parameters specified here, applications may add one of the following structures to the structure chain: XrPassthroughColorMapMonoToRgbaFB, XrPassthroughColorMapMonoToMonoFB, XrPassthroughBrightnessContrastSaturationFB. These structures are mutually exclusive. The runtime must return ERROR_VALIDATION_FAILURE if more than one of them are present in the structure chain.

Valid Usage (Implicit)
See Also

XrColor4f, PassthroughLayerSetStyleFB

Layout


struct XrPassthroughStyleFB {
    XrStructureType type;
    void const * next;
    float textureOpacityFactor;
    XrColor4f edgeColor;
}

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
EDGECOLOR

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
TEXTUREOPACITYFACTOR

The struct member offsets.

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

public
XrPassthroughStyleFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrPassthroughStyleFB
calloc()

Returns a new XrPassthroughStyleFB instance allocated with memCalloc.

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

Returns a new XrPassthroughStyleFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrPassthroughStyleFB instance allocated with BufferUtils.

public static XrPassthroughStyleFB
create(long address)

Returns a new XrPassthroughStyleFB instance for the specified memory address.

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

Returns a new XrPassthroughStyleFB.Buffer instance allocated with BufferUtils.

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

Create a XrPassthroughStyleFB.Buffer instance at the specified memory.

public static XrPassthroughStyleFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public XrColor4f
edgeColor()

the XrColor4f that defines the edge rendering color.

public XrPassthroughStyleFB
edgeColor(XrColor4f value)

Copies the specified XrColor4f to the edgeColor field.

public XrPassthroughStyleFB
edgeColor(Consumer<XrColor4f> consumer)

Passes the edgeColor field to the specified Consumer.

public static XrPassthroughStyleFB
malloc()

Returns a new XrPassthroughStyleFB instance allocated with memAlloc.

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

Returns a new XrPassthroughStyleFB.Buffer instance allocated with memAlloc.

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

Returns a new XrPassthroughStyleFB instance allocated on the specified MemoryStack.

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

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

public static XrColor4f
nedgeColor(long struct)

Unsafe version of edgeColor.

public static void
nedgeColor(long struct, XrColor4f value)

Unsafe version of edgeColor.

public long
next()

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

public XrPassthroughStyleFB
next(long value)

Sets the specified value to the next field.

public XrPassthroughStyleFB
public XrPassthroughStyleFB
next(XrPassthroughColorMapInterpolatedLutMETA value)

Prepends the specified XrPassthroughColorMapInterpolatedLutMETA value to the next chain.

public XrPassthroughStyleFB
next(XrPassthroughColorMapLutMETA value)

Prepends the specified XrPassthroughColorMapLutMETA value to the next chain.

public XrPassthroughStyleFB
next(XrPassthroughColorMapMonoToMonoFB value)

Prepends the specified XrPassthroughColorMapMonoToMonoFB value to the next chain.

public XrPassthroughStyleFB
next(XrPassthroughColorMapMonoToRgbaFB value)

Prepends the specified XrPassthroughColorMapMonoToRgbaFB value to the next chain.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static float
ntextureOpacityFactor(long struct)

Unsafe version of textureOpacityFactor.

public static void
ntextureOpacityFactor(long struct, float value)

Unsafe version of textureOpacityFactor.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrPassthroughStyleFB
set(int type, long next, float textureOpacityFactor, XrColor4f edgeColor)

Initializes this struct with the specified values.

public XrPassthroughStyleFB

Returns:

this struct
set
(XrPassthroughStyleFB
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 float
textureOpacityFactor()

the opacity of the passthrough imagery in the range [0, 1].

public XrPassthroughStyleFB
textureOpacityFactor(float value)

Sets the specified value to the textureOpacityFactor field.

public int
type()

the XrStructureType of this structure.

public XrPassthroughStyleFB
type(int value)

Sets the specified value to the type field.

public XrPassthroughStyleFB
type$Default()

Sets the TYPE_PASSTHROUGH_STYLE_FB 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.

EDGECOLORback to summary
public static final int EDGECOLOR

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.

TEXTUREOPACITYFACTORback to summary
public static final int TEXTUREOPACITYFACTOR

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrPassthroughStyleFBback to summary
protected XrPassthroughStyleFB(long address, ByteBuffer container)
XrPassthroughStyleFBback to summary
public XrPassthroughStyleFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrPassthroughStyleFB calloc(MemoryStack stack)

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

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

Returns a new XrPassthroughStyleFB instance allocated with BufferUtils.

createback to summary
public static XrPassthroughStyleFB create(long address)

Returns a new XrPassthroughStyleFB instance for the specified memory address.

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

Returns a new XrPassthroughStyleFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrPassthroughStyleFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrPassthroughStyleFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
edgeColorback to summary
public XrColor4f edgeColor()

the XrColor4f that defines the edge rendering color. Edges are detected in the original passthrough imagery and rendered on top of it. Edge rendering is disabled when the alpha value of edgeColor is zero.

edgeColorback to summary
public XrPassthroughStyleFB edgeColor(XrColor4f value)

Copies the specified XrColor4f to the edgeColor field.

edgeColorback to summary
public XrPassthroughStyleFB edgeColor(Consumer<XrColor4f> consumer)

Passes the edgeColor field to the specified Consumer.

mallocback to summary
public static XrPassthroughStyleFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrPassthroughStyleFB malloc(MemoryStack stack)

Returns a new XrPassthroughStyleFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nedgeColorback to summary
public static XrColor4f nedgeColor(long struct)

Unsafe version of edgeColor.

nedgeColorback to summary
public static void nedgeColor(long struct, XrColor4f value)

Unsafe version of edgeColor.

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 XrPassthroughStyleFB next(long value)

Sets the specified value to the next field.

nextback to summary
public XrPassthroughStyleFB next(XrPassthroughBrightnessContrastSaturationFB value)

Prepends the specified XrPassthroughBrightnessContrastSaturationFB value to the next chain.

nextback to summary
public XrPassthroughStyleFB next(XrPassthroughColorMapInterpolatedLutMETA value)

Prepends the specified XrPassthroughColorMapInterpolatedLutMETA value to the next chain.

nextback to summary
public XrPassthroughStyleFB next(XrPassthroughColorMapLutMETA value)

Prepends the specified XrPassthroughColorMapLutMETA value to the next chain.

nextback to summary
public XrPassthroughStyleFB next(XrPassthroughColorMapMonoToMonoFB value)

Prepends the specified XrPassthroughColorMapMonoToMonoFB value to the next chain.

nextback to summary
public XrPassthroughStyleFB next(XrPassthroughColorMapMonoToRgbaFB value)

Prepends the specified XrPassthroughColorMapMonoToRgbaFB value to the next chain.

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.

ntextureOpacityFactorback to summary
public static float ntextureOpacityFactor(long struct)

Unsafe version of textureOpacityFactor.

ntextureOpacityFactorback to summary
public static void ntextureOpacityFactor(long struct, float value)

Unsafe version of textureOpacityFactor.

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 XrPassthroughStyleFB set(int type, long next, float textureOpacityFactor, XrColor4f edgeColor)

Initializes this struct with the specified values.

setback to summary
public XrPassthroughStyleFB set(XrPassthroughStyleFB src)

Copies the specified struct data to this struct.

Parameters
src:XrPassthroughStyleFB

the source struct

Returns:XrPassthroughStyleFB

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
textureOpacityFactorback to summary
public float textureOpacityFactor()

the opacity of the passthrough imagery in the range [0, 1].

textureOpacityFactorback to summary
public XrPassthroughStyleFB textureOpacityFactor(float value)

Sets the specified value to the textureOpacityFactor field.

typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_PASSTHROUGH_STYLE_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrPassthroughStyleFB.Buffer

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

An array of XrPassthroughStyleFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrPassthroughStyleFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrPassthroughStyleFB.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 XrColor4f

Returns:

a XrColor4f view of the XrPassthroughStyleFB#edgeColor field.
edgeColor
()

public XrPassthroughStyleFB.Buffer
edgeColor(XrColor4f value)

Copies the specified XrColor4f to the XrPassthroughStyleFB#edgeColor field.

public XrPassthroughStyleFB.Buffer
edgeColor(Consumer<XrColor4f> consumer)

Passes the XrPassthroughStyleFB#edgeColor field to the specified Consumer.

protected XrPassthroughStyleFB
public long

Returns:

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

public XrPassthroughStyleFB.Buffer
next(long value)

Sets the specified value to the XrPassthroughStyleFB#next field.

public XrPassthroughStyleFB.Buffer
public XrPassthroughStyleFB.Buffer
next(XrPassthroughColorMapInterpolatedLutMETA value)

Prepends the specified XrPassthroughColorMapInterpolatedLutMETA value to the next chain.

public XrPassthroughStyleFB.Buffer
next(XrPassthroughColorMapLutMETA value)

Prepends the specified XrPassthroughColorMapLutMETA value to the next chain.

public XrPassthroughStyleFB.Buffer
next(XrPassthroughColorMapMonoToMonoFB value)

Prepends the specified XrPassthroughColorMapMonoToMonoFB value to the next chain.

public XrPassthroughStyleFB.Buffer
next(XrPassthroughColorMapMonoToRgbaFB value)

Prepends the specified XrPassthroughColorMapMonoToRgbaFB value to the next chain.

protected XrPassthroughStyleFB.Buffer
public float
public XrPassthroughStyleFB.Buffer
textureOpacityFactor(float value)

Sets the specified value to the XrPassthroughStyleFB#textureOpacityFactor field.

public int

Returns:

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

public XrPassthroughStyleFB.Buffer
type(int value)

Sets the specified value to the XrPassthroughStyleFB#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrPassthroughStyleFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

edgeColorback to summary
public XrColor4f edgeColor()
Returns:XrColor4f

a XrColor4f view of the XrPassthroughStyleFB#edgeColor field.

edgeColorback to summary
public XrPassthroughStyleFB.Buffer edgeColor(XrColor4f value)

Copies the specified XrColor4f to the XrPassthroughStyleFB#edgeColor field.

edgeColorback to summary
public XrPassthroughStyleFB.Buffer edgeColor(Consumer<XrColor4f> consumer)

Passes the XrPassthroughStyleFB#edgeColor field to the specified Consumer.

getElementFactoryback to summary
protected XrPassthroughStyleFB getElementFactory()

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

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

the value of the XrPassthroughStyleFB#next field.

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

Sets the specified value to the XrPassthroughStyleFB#next field.

nextback to summary
public XrPassthroughStyleFB.Buffer next(XrPassthroughBrightnessContrastSaturationFB value)

Prepends the specified XrPassthroughBrightnessContrastSaturationFB value to the next chain.

nextback to summary
public XrPassthroughStyleFB.Buffer next(XrPassthroughColorMapInterpolatedLutMETA value)

Prepends the specified XrPassthroughColorMapInterpolatedLutMETA value to the next chain.

nextback to summary
public XrPassthroughStyleFB.Buffer next(XrPassthroughColorMapLutMETA value)

Prepends the specified XrPassthroughColorMapLutMETA value to the next chain.

nextback to summary
public XrPassthroughStyleFB.Buffer next(XrPassthroughColorMapMonoToMonoFB value)

Prepends the specified XrPassthroughColorMapMonoToMonoFB value to the next chain.

nextback to summary
public XrPassthroughStyleFB.Buffer next(XrPassthroughColorMapMonoToRgbaFB value)

Prepends the specified XrPassthroughColorMapMonoToRgbaFB value to the next chain.

selfback to summary
protected XrPassthroughStyleFB.Buffer self()

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

Annotations
@Override
textureOpacityFactorback to summary
public float textureOpacityFactor()
Returns:float

the value of the XrPassthroughStyleFB#textureOpacityFactor field.

textureOpacityFactorback to summary
public XrPassthroughStyleFB.Buffer textureOpacityFactor(float value)

Sets the specified value to the XrPassthroughStyleFB#textureOpacityFactor field.

typeback to summary
public int type()
Returns:int

the value of the XrPassthroughStyleFB#type field.

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

Sets the specified value to the XrPassthroughStyleFB#type field.

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

Sets the TYPE_PASSTHROUGH_STYLE_FB value to the XrPassthroughStyleFB#type field.