Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSwapchainStateFoveationFB

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

Foveation swapchain state,xrefs=.
Valid Usage (Implicit)

Layout


struct XrSwapchainStateFoveationFB {
    XrStructureType type;
    void * next;
    XrSwapchainStateFoveationFlagsFB flags;
    XrFoveationProfileFB profile;
}

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
FLAGS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
PROFILE

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

public
XrSwapchainStateFoveationFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSwapchainStateFoveationFB
calloc()

Returns a new XrSwapchainStateFoveationFB instance allocated with memCalloc.

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

Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSwapchainStateFoveationFB instance allocated with BufferUtils.

public static XrSwapchainStateFoveationFB
create(long address)

Returns a new XrSwapchainStateFoveationFB instance for the specified memory address.

public static XrSwapchainStateFoveationFB
create(XrSwapchainStateBaseHeaderFB value)

Downcasts the specified XrSwapchainStateBaseHeaderFB instance to XrSwapchainStateFoveationFB.

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

Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with BufferUtils.

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

Create a XrSwapchainStateFoveationFB.Buffer instance at the specified memory.

public static XrSwapchainStateFoveationFB.Buffer
create(XrSwapchainStateBaseHeaderFB.Buffer value)

Downcasts the specified XrSwapchainStateBaseHeaderFB.Buffer instance to XrSwapchainStateFoveationFB.Buffer.

public static XrSwapchainStateFoveationFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
flags()

a bitmask of XrSwapchainStateFoveationFlagBitsFB which indicate various characteristics of how and when the foveation properties of the swapchain must be updated.

public XrSwapchainStateFoveationFB
flags(long value)

Sets the specified value to the flags field.

public static XrSwapchainStateFoveationFB
malloc()

Returns a new XrSwapchainStateFoveationFB instance allocated with memAlloc.

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

Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSwapchainStateFoveationFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSwapchainStateFoveationFB
next(long value)

Sets the specified value to the next field.

public static long
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, long value)

Unsafe version of flags.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nprofile(long struct)

Unsafe version of profile.

public static void
nprofile(long struct, XrFoveationProfileFB value)

Unsafe version of profile.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public long
profile()

an XrFoveationProfileFB defining the desired foveation properties to be applied to the swapchain.

public XrSwapchainStateFoveationFB
profile(XrFoveationProfileFB value)

Sets the specified value to the profile field.

public XrSwapchainStateFoveationFB
set(int type, long next, long flags, XrFoveationProfileFB profile)

Initializes this struct with the specified values.

public XrSwapchainStateFoveationFB

Returns:

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

Sets the specified value to the type field.

public XrSwapchainStateFoveationFB
type$Default()

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

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

PROFILEback to summary
public static final int PROFILE

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

XrSwapchainStateFoveationFBback to summary
protected XrSwapchainStateFoveationFB(long address, ByteBuffer container)
XrSwapchainStateFoveationFBback to summary
public XrSwapchainStateFoveationFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSwapchainStateFoveationFB calloc(MemoryStack stack)

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

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

Returns a new XrSwapchainStateFoveationFB instance allocated with BufferUtils.

createback to summary
public static XrSwapchainStateFoveationFB create(long address)

Returns a new XrSwapchainStateFoveationFB instance for the specified memory address.

createback to summary
public static XrSwapchainStateFoveationFB create(XrSwapchainStateBaseHeaderFB value)

Downcasts the specified XrSwapchainStateBaseHeaderFB instance to XrSwapchainStateFoveationFB.

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

Returns a new XrSwapchainStateFoveationFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSwapchainStateFoveationFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createback to summary
public static XrSwapchainStateFoveationFB.Buffer create(XrSwapchainStateBaseHeaderFB.Buffer value)

Downcasts the specified XrSwapchainStateBaseHeaderFB.Buffer instance to XrSwapchainStateFoveationFB.Buffer.

createSafeback to summary
public static XrSwapchainStateFoveationFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public long flags()

a bitmask of XrSwapchainStateFoveationFlagBitsFB which indicate various characteristics of how and when the foveation properties of the swapchain must be updated.

Annotations
@NativeType:XrSwapchainStateFoveationFlagsFB
flagsback to summary
public XrSwapchainStateFoveationFB flags(long value)

Sets the specified value to the flags field.

mallocback to summary
public static XrSwapchainStateFoveationFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSwapchainStateFoveationFB malloc(MemoryStack stack)

Returns a new XrSwapchainStateFoveationFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

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

Sets the specified value to the next field.

nflagsback to summary
public static long nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, long value)

Unsafe version of flags.

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.

nprofileback to summary
public static long nprofile(long struct)

Unsafe version of profile.

nprofileback to summary
public static void nprofile(long struct, XrFoveationProfileFB value)

Unsafe version of profile.

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.

profileback to summary
public long profile()

an XrFoveationProfileFB defining the desired foveation properties to be applied to the swapchain.

Annotations
@NativeType:XrFoveationProfileFB
profileback to summary
public XrSwapchainStateFoveationFB profile(XrFoveationProfileFB value)

Sets the specified value to the profile field.

setback to summary
public XrSwapchainStateFoveationFB set(int type, long next, long flags, XrFoveationProfileFB profile)

Initializes this struct with the specified values.

setback to summary
public XrSwapchainStateFoveationFB set(XrSwapchainStateFoveationFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSwapchainStateFoveationFB

the source struct

Returns:XrSwapchainStateFoveationFB

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 XrSwapchainStateFoveationFB type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_SWAPCHAIN_STATE_FOVEATION_FB value to the type 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.openxr back to summary

public Class XrSwapchainStateFoveationFB.Buffer

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

An array of XrSwapchainStateFoveationFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSwapchainStateFoveationFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSwapchainStateFoveationFB.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 long

Returns:

the value of the XrSwapchainStateFoveationFB#flags field.
flags
()

public XrSwapchainStateFoveationFB.Buffer
flags(long value)

Sets the specified value to the XrSwapchainStateFoveationFB#flags field.

protected XrSwapchainStateFoveationFB
public long

Returns:

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

public XrSwapchainStateFoveationFB.Buffer
next(long value)

Sets the specified value to the XrSwapchainStateFoveationFB#next field.

public long

Returns:

the value of the XrSwapchainStateFoveationFB#profile field.
profile
()

public XrSwapchainStateFoveationFB.Buffer
profile(XrFoveationProfileFB value)

Sets the specified value to the XrSwapchainStateFoveationFB#profile field.

protected XrSwapchainStateFoveationFB.Buffer
public int

Returns:

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

public XrSwapchainStateFoveationFB.Buffer
type(int value)

Sets the specified value to the XrSwapchainStateFoveationFB#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSwapchainStateFoveationFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public long flags()
Returns:long

the value of the XrSwapchainStateFoveationFB#flags field.

Annotations
@NativeType:XrSwapchainStateFoveationFlagsFB
flagsback to summary
public XrSwapchainStateFoveationFB.Buffer flags(long value)

Sets the specified value to the XrSwapchainStateFoveationFB#flags field.

getElementFactoryback to summary
protected XrSwapchainStateFoveationFB getElementFactory()

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

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

the value of the XrSwapchainStateFoveationFB#next field.

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

Sets the specified value to the XrSwapchainStateFoveationFB#next field.

profileback to summary
public long profile()
Returns:long

the value of the XrSwapchainStateFoveationFB#profile field.

Annotations
@NativeType:XrFoveationProfileFB
profileback to summary
public XrSwapchainStateFoveationFB.Buffer profile(XrFoveationProfileFB value)

Sets the specified value to the XrSwapchainStateFoveationFB#profile field.

selfback to summary
protected XrSwapchainStateFoveationFB.Buffer self()

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

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

the value of the XrSwapchainStateFoveationFB#type field.

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

Sets the specified value to the XrSwapchainStateFoveationFB#type field.

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

Sets the TYPE_SWAPCHAIN_STATE_FOVEATION_FB value to the XrSwapchainStateFoveationFB#type field.