Package org.lwjgl.openxr

Class XrSwapchainImageFoveationVulkanFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSwapchainImageFoveationVulkanFB>

org.lwjgl.openxr.XrSwapchainImageFoveationVulkanFB

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrSwapchainImageFoveationVulkanFB
extends org.lwjgl.system.Struct<XrSwapchainImageFoveationVulkanFB>
implements org.lwjgl.system.NativeResource

Profile with properties defining a foveation pattern.

Valid Usage (Implicit)

• The XR_FB_foveation_vulkan extension must be enabled prior to using XrSwapchainImageFoveationVulkanFB
• type must be TYPE_SWAPCHAIN_IMAGE_FOVEATION_VULKAN_FB
• next must be NULL or a valid pointer to the next structure in a structure chain

See Also

XrSwapchainImageVulkanKHR, EnumerateSwapchainImages

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSwapchainImageFoveationVulkanFB.Buffer	An array of XrSwapchainImageFoveationVulkanFB structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	HEIGHT	The struct member offsets.
static final int	IMAGE	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.
static final int	WIDTH	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrSwapchainImageFoveationVulkanFB(ByteBuffer container)	Creates a XrSwapchainImageFoveationVulkanFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSwapchainImageFoveationVulkanFB	calloc()	Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with memCalloc.
static XrSwapchainImageFoveationVulkanFB.Buffer	calloc(int capacity)	Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with memCalloc.
static XrSwapchainImageFoveationVulkanFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainImageFoveationVulkanFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageFoveationVulkanFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSwapchainImageFoveationVulkanFB	create()	Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with BufferUtils.
static XrSwapchainImageFoveationVulkanFB.Buffer	create(int capacity)	Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with BufferUtils.
static XrSwapchainImageFoveationVulkanFB	create(long address)	Returns a new XrSwapchainImageFoveationVulkanFB instance for the specified memory address.
static XrSwapchainImageFoveationVulkanFB.Buffer	create(long address, int capacity)	Create a XrSwapchainImageFoveationVulkanFB.Buffer instance at the specified memory.
static @Nullable XrSwapchainImageFoveationVulkanFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSwapchainImageFoveationVulkanFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	height()	the vertical height in pixels of the image.
long	image()	a valid Vulkan VkImage to use.
static XrSwapchainImageFoveationVulkanFB	malloc()	Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with memAlloc.
static XrSwapchainImageFoveationVulkanFB.Buffer	malloc(int capacity)	Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with memAlloc.
static XrSwapchainImageFoveationVulkanFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated on the specified MemoryStack.
static XrSwapchainImageFoveationVulkanFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSwapchainImageFoveationVulkanFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSwapchainImageFoveationVulkanFB	next(long value)	Sets the specified value to the next() field.
static int	nheight(long struct)	Unsafe version of height().
static long	nimage(long struct)	Unsafe version of image().
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
static int	nwidth(long struct)	Unsafe version of width().
XrSwapchainImageFoveationVulkanFB	set(int type, long next)	Initializes this struct with the specified values.
XrSwapchainImageFoveationVulkanFB	set(XrSwapchainImageFoveationVulkanFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSwapchainImageFoveationVulkanFB	type(int value)	Sets the specified value to the type() field.
XrSwapchainImageFoveationVulkanFB	type$Default()	Sets the TYPE_SWAPCHAIN_IMAGE_FOVEATION_VULKAN_FB value to the type() field.
int	width()	the horizontal width in pixels of the image.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

IMAGE

public static final int IMAGE

The struct member offsets.

WIDTH

public static final int WIDTH

The struct member offsets.

HEIGHT

public static final int HEIGHT

The struct member offsets.

Constructor Details

XrSwapchainImageFoveationVulkanFB

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrSwapchainImageFoveationVulkanFB>

type

public int type()

the XrStructureType of this structure.

next

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.

image

public long image()

a valid Vulkan VkImage to use.

width

public int width()

the horizontal width in pixels of the image.

height

public int height()

the vertical height in pixels of the image.

type

public XrSwapchainImageFoveationVulkanFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrSwapchainImageFoveationVulkanFB type$Default()

Sets the TYPE_SWAPCHAIN_IMAGE_FOVEATION_VULKAN_FB value to the type() field.

next

public XrSwapchainImageFoveationVulkanFB next(long value)

Sets the specified value to the next() field.

set

public XrSwapchainImageFoveationVulkanFB set(int type,
 long next)

Initializes this struct with the specified values.

set

public XrSwapchainImageFoveationVulkanFB set(XrSwapchainImageFoveationVulkanFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSwapchainImageFoveationVulkanFB malloc()

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

calloc

public static XrSwapchainImageFoveationVulkanFB calloc()

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

create

public static XrSwapchainImageFoveationVulkanFB create()

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated with BufferUtils.

create

public static XrSwapchainImageFoveationVulkanFB create(long address)

Returns a new XrSwapchainImageFoveationVulkanFB instance for the specified memory address.

createSafe

public static @Nullable XrSwapchainImageFoveationVulkanFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSwapchainImageFoveationVulkanFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSwapchainImageFoveationVulkanFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSwapchainImageFoveationVulkanFB.Buffer create(int capacity)

Returns a new XrSwapchainImageFoveationVulkanFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSwapchainImageFoveationVulkanFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static XrSwapchainImageFoveationVulkanFB malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrSwapchainImageFoveationVulkanFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrSwapchainImageFoveationVulkanFB calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrSwapchainImageFoveationVulkanFB.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrSwapchainImageFoveationVulkanFB.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nimage

public static long nimage(long struct)

Unsafe version of image().

nwidth

public static int nwidth(long struct)

Unsafe version of width().

nheight

public static int nheight(long struct)

Unsafe version of height().

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.