Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSwapchainImageFoveationVulkanFB

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

Profile with properties defining a foveation pattern.
Valid Usage (Implicit)
See Also

XrSwapchainImageVulkanKHR, EnumerateSwapchainImages

Layout


struct XrSwapchainImageFoveationVulkanFB {
    XrStructureType type;
    void * next;
    VkImage image;
    uint32_t width;
    uint32_t height;
}

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
HEIGHT

The struct member offsets.

public static final int
IMAGE

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.

public static final int
WIDTH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
XrSwapchainImageFoveationVulkanFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSwapchainImageFoveationVulkanFB
calloc()

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with memCalloc.

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

Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with BufferUtils.

public static XrSwapchainImageFoveationVulkanFB
create(long address)

Returns a new XrSwapchainImageFoveationVulkanFB instance for the specified memory address.

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

Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with BufferUtils.

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

Create a XrSwapchainImageFoveationVulkanFB.Buffer instance at the specified memory.

public static XrSwapchainImageFoveationVulkanFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
height()

the vertical height in pixels of the image.

public long
image()

a valid Vulkan VkImage to use.

public static XrSwapchainImageFoveationVulkanFB
malloc()

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with memAlloc.

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

Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSwapchainImageFoveationVulkanFB
next(long value)

Sets the specified value to the next field.

public static int
nheight(long struct)

Unsafe version of height.

public static long
nimage(long struct)

Unsafe version of image.

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 static int
nwidth(long struct)

Unsafe version of width.

public XrSwapchainImageFoveationVulkanFB
set(int type, long next)

Initializes this struct with the specified values.

public XrSwapchainImageFoveationVulkanFB

Returns:

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

Sets the specified value to the type field.

public XrSwapchainImageFoveationVulkanFB
public int
width()

the horizontal width in pixels of the image.

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.

HEIGHTback to summary
public static final int HEIGHT

The struct member offsets.

IMAGEback to summary
public static final int IMAGE

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.

WIDTHback to summary
public static final int WIDTH

The struct member offsets.

Constructor Detail

XrSwapchainImageFoveationVulkanFBback to summary
protected XrSwapchainImageFoveationVulkanFB(long address, ByteBuffer container)
XrSwapchainImageFoveationVulkanFBback to summary
public XrSwapchainImageFoveationVulkanFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSwapchainImageFoveationVulkanFB calloc(MemoryStack stack)

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

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

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with BufferUtils.

createback to summary
public static XrSwapchainImageFoveationVulkanFB create(long address)

Returns a new XrSwapchainImageFoveationVulkanFB instance for the specified memory address.

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

Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSwapchainImageFoveationVulkanFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSwapchainImageFoveationVulkanFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
heightback to summary
public int height()

the vertical height in pixels of the image.

Annotations
@NativeType:uint32_t
imageback to summary
public long image()

a valid Vulkan VkImage to use.

Annotations
@NativeType:VkImage
mallocback to summary
public static XrSwapchainImageFoveationVulkanFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSwapchainImageFoveationVulkanFB malloc(MemoryStack stack)

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrSwapchainImageFoveationVulkanFB.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 XrSwapchainImageFoveationVulkanFB next(long value)

Sets the specified value to the next field.

nheightback to summary
public static int nheight(long struct)

Unsafe version of height.

nimageback to summary
public static long nimage(long struct)

Unsafe version of image.

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.

nwidthback to summary
public static int nwidth(long struct)

Unsafe version of width.

setback to summary
public XrSwapchainImageFoveationVulkanFB set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrSwapchainImageFoveationVulkanFB set(XrSwapchainImageFoveationVulkanFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSwapchainImageFoveationVulkanFB

the source struct

Returns:XrSwapchainImageFoveationVulkanFB

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

Sets the specified value to the type field.

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

Sets the TYPE_SWAPCHAIN_IMAGE_FOVEATION_VULKAN_FB value to the type field.

widthback to summary
public int width()

the horizontal width in pixels of the image.

Annotations
@NativeType:uint32_t
org.lwjgl.openxr back to summary

public Class XrSwapchainImageFoveationVulkanFB.Buffer

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

An array of XrSwapchainImageFoveationVulkanFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSwapchainImageFoveationVulkanFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSwapchainImageFoveationVulkanFB.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
protected XrSwapchainImageFoveationVulkanFB
public int

Returns:

the value of the XrSwapchainImageFoveationVulkanFB#height field.
height
()

public long

Returns:

the value of the XrSwapchainImageFoveationVulkanFB#image field.
image
()

public long

Returns:

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

public XrSwapchainImageFoveationVulkanFB.Buffer
next(long value)

Sets the specified value to the XrSwapchainImageFoveationVulkanFB#next field.

protected XrSwapchainImageFoveationVulkanFB.Buffer
public int

Returns:

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

public XrSwapchainImageFoveationVulkanFB.Buffer
type(int value)

Sets the specified value to the XrSwapchainImageFoveationVulkanFB#type field.

public XrSwapchainImageFoveationVulkanFB.Buffer
public int

Returns:

the value of the XrSwapchainImageFoveationVulkanFB#width field.
width
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSwapchainImageFoveationVulkanFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected XrSwapchainImageFoveationVulkanFB getElementFactory()

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

Annotations
@Override
heightback to summary
public int height()
Returns:int

the value of the XrSwapchainImageFoveationVulkanFB#height field.

Annotations
@NativeType:uint32_t
imageback to summary
public long image()
Returns:long

the value of the XrSwapchainImageFoveationVulkanFB#image field.

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

the value of the XrSwapchainImageFoveationVulkanFB#next field.

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

Sets the specified value to the XrSwapchainImageFoveationVulkanFB#next field.

selfback to summary
protected XrSwapchainImageFoveationVulkanFB.Buffer self()

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

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

the value of the XrSwapchainImageFoveationVulkanFB#type field.

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

Sets the specified value to the XrSwapchainImageFoveationVulkanFB#type field.

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

Sets the TYPE_SWAPCHAIN_IMAGE_FOVEATION_VULKAN_FB value to the XrSwapchainImageFoveationVulkanFB#type field.

widthback to summary
public int width()
Returns:int

the value of the XrSwapchainImageFoveationVulkanFB#width field.

Annotations
@NativeType:uint32_t