Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSwapchainCreateInfoFoveationFB

extends Struct<XrSwapchainCreateInfoFoveationFB>
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 information to create a swapchain supporting foveation.
Valid Usage (Implicit)

Layout


struct XrSwapchainCreateInfoFoveationFB {
    XrStructureType type;
    void * next;
    XrSwapchainCreateFoveationFlagsFB flags;
}

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
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
public
XrSwapchainCreateInfoFoveationFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSwapchainCreateInfoFoveationFB
calloc()

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated with memCalloc.

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

Returns a new XrSwapchainCreateInfoFoveationFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated with BufferUtils.

public static XrSwapchainCreateInfoFoveationFB
create(long address)

Returns a new XrSwapchainCreateInfoFoveationFB instance for the specified memory address.

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

Returns a new XrSwapchainCreateInfoFoveationFB.Buffer instance allocated with BufferUtils.

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

Create a XrSwapchainCreateInfoFoveationFB.Buffer instance at the specified memory.

public static XrSwapchainCreateInfoFoveationFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
flags()

a bitmask of XrSwapchainCreateFoveationFlagBitsFB which indicate various characteristics for how foveation is enabled on the swapchain.

public XrSwapchainCreateInfoFoveationFB
flags(long value)

Sets the specified value to the flags field.

public static XrSwapchainCreateInfoFoveationFB
malloc()

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated with memAlloc.

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

Returns a new XrSwapchainCreateInfoFoveationFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSwapchainCreateInfoFoveationFB
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 int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrSwapchainCreateInfoFoveationFB
set(int type, long next, long flags)

Initializes this struct with the specified values.

public XrSwapchainCreateInfoFoveationFB

Returns:

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

Sets the specified value to the type field.

public XrSwapchainCreateInfoFoveationFB
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.

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

XrSwapchainCreateInfoFoveationFBback to summary
protected XrSwapchainCreateInfoFoveationFB(long address, ByteBuffer container)
XrSwapchainCreateInfoFoveationFBback to summary
public XrSwapchainCreateInfoFoveationFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSwapchainCreateInfoFoveationFB calloc(MemoryStack stack)

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

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

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated with BufferUtils.

createback to summary
public static XrSwapchainCreateInfoFoveationFB create(long address)

Returns a new XrSwapchainCreateInfoFoveationFB instance for the specified memory address.

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

Returns a new XrSwapchainCreateInfoFoveationFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSwapchainCreateInfoFoveationFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSwapchainCreateInfoFoveationFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrSwapchainCreateInfoFoveationFB.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 XrSwapchainCreateFoveationFlagBitsFB which indicate various characteristics for how foveation is enabled on the swapchain.

Annotations
@NativeType:XrSwapchainCreateFoveationFlagsFB
flagsback to summary
public XrSwapchainCreateInfoFoveationFB flags(long value)

Sets the specified value to the flags field.

mallocback to summary
public static XrSwapchainCreateInfoFoveationFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSwapchainCreateInfoFoveationFB malloc(MemoryStack stack)

Returns a new XrSwapchainCreateInfoFoveationFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

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 XrSwapchainCreateInfoFoveationFB set(int type, long next, long flags)

Initializes this struct with the specified values.

setback to summary
public XrSwapchainCreateInfoFoveationFB set(XrSwapchainCreateInfoFoveationFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSwapchainCreateInfoFoveationFB

the source struct

Returns:XrSwapchainCreateInfoFoveationFB

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

Sets the specified value to the type field.

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

Sets the TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrSwapchainCreateInfoFoveationFB.Buffer

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

An array of XrSwapchainCreateInfoFoveationFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSwapchainCreateInfoFoveationFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public XrSwapchainCreateInfoFoveationFB.Buffer
flags(long value)

Sets the specified value to the XrSwapchainCreateInfoFoveationFB#flags field.

protected XrSwapchainCreateInfoFoveationFB
public long

Returns:

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

public XrSwapchainCreateInfoFoveationFB.Buffer
next(long value)

Sets the specified value to the XrSwapchainCreateInfoFoveationFB#next field.

protected XrSwapchainCreateInfoFoveationFB.Buffer
public int

Returns:

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

public XrSwapchainCreateInfoFoveationFB.Buffer
type(int value)

Sets the specified value to the XrSwapchainCreateInfoFoveationFB#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSwapchainCreateInfoFoveationFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSwapchainCreateInfoFoveationFB.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 XrSwapchainCreateInfoFoveationFB#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 XrSwapchainCreateInfoFoveationFB#flags field.

Annotations
@NativeType:XrSwapchainCreateFoveationFlagsFB
flagsback to summary
public XrSwapchainCreateInfoFoveationFB.Buffer flags(long value)

Sets the specified value to the XrSwapchainCreateInfoFoveationFB#flags field.

getElementFactoryback to summary
protected XrSwapchainCreateInfoFoveationFB getElementFactory()

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

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

the value of the XrSwapchainCreateInfoFoveationFB#next field.

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

Sets the specified value to the XrSwapchainCreateInfoFoveationFB#next field.

selfback to summary
protected XrSwapchainCreateInfoFoveationFB.Buffer self()

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

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

the value of the XrSwapchainCreateInfoFoveationFB#type field.

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

Sets the specified value to the XrSwapchainCreateInfoFoveationFB#type field.

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

Sets the TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB value to the XrSwapchainCreateInfoFoveationFB#type field.