Package org.lwjgl.openxr

Class XrVirtualKeyboardTextureDataMETA

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrVirtualKeyboardTextureDataMETA>

org.lwjgl.openxr.XrVirtualKeyboardTextureDataMETA

All Implemented Interfaces:

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

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

Virtual keyboard texture data.

Valid Usage (Implicit)

• The XR_META_virtual_keyboard extension must be enabled prior to using XrVirtualKeyboardTextureDataMETA
• type must be TYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_META
• next must be NULL or a valid pointer to the next structure in a structure chain
• If bufferCapacityInput is not 0, buffer must be a pointer to an array of bufferCapacityInput uint8_t values

See Also

GetVirtualKeyboardTextureDataMETA

Layout

 struct XrVirtualKeyboardTextureDataMETA {
     XrStructureType type();
     void * next();
     uint32_t textureWidth();
     uint32_t textureHeight();
     uint32_t bufferCapacityInput();
     uint32_t bufferCountOutput();
     uint8_t * buffer();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrVirtualKeyboardTextureDataMETA.Buffer	An array of XrVirtualKeyboardTextureDataMETA 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	BUFFER	The struct member offsets.
static final int	BUFFERCAPACITYINPUT	The struct member offsets.
static final int	BUFFERCOUNTOUTPUT	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TEXTUREHEIGHT	The struct member offsets.
static final int	TEXTUREWIDTH	The struct member offsets.
static final int	TYPE	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
XrVirtualKeyboardTextureDataMETA(ByteBuffer container)	Creates a XrVirtualKeyboardTextureDataMETA instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
@Nullable ByteBuffer	buffer()	the pixel data in linear color space, RGBA 8-bit unsigned normalized integer format (i.e.
XrVirtualKeyboardTextureDataMETA	buffer(@Nullable ByteBuffer value)	Sets the address of the specified ByteBuffer to the buffer() field.
int	bufferCapacityInput()	the capacity of buffer, or 0 to indicate a request to retrieve the required capacity.
XrVirtualKeyboardTextureDataMETA	bufferCapacityInput(int value)	Sets the specified value to the bufferCapacityInput() field.
int	bufferCountOutput()	filled in by the runtime with the byte count written or the required capacity in the case that bufferCapacityInput is insufficient.
XrVirtualKeyboardTextureDataMETA	bufferCountOutput(int value)	Sets the specified value to the bufferCountOutput() field.
static XrVirtualKeyboardTextureDataMETA	calloc()	Returns a new XrVirtualKeyboardTextureDataMETA instance allocated with memCalloc.
static XrVirtualKeyboardTextureDataMETA.Buffer	calloc(int capacity)	Returns a new XrVirtualKeyboardTextureDataMETA.Buffer instance allocated with memCalloc.
static XrVirtualKeyboardTextureDataMETA.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardTextureDataMETA.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVirtualKeyboardTextureDataMETA	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardTextureDataMETA instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrVirtualKeyboardTextureDataMETA	create()	Returns a new XrVirtualKeyboardTextureDataMETA instance allocated with BufferUtils.
static XrVirtualKeyboardTextureDataMETA.Buffer	create(int capacity)	Returns a new XrVirtualKeyboardTextureDataMETA.Buffer instance allocated with BufferUtils.
static XrVirtualKeyboardTextureDataMETA	create(long address)	Returns a new XrVirtualKeyboardTextureDataMETA instance for the specified memory address.
static XrVirtualKeyboardTextureDataMETA.Buffer	create(long address, int capacity)	Create a XrVirtualKeyboardTextureDataMETA.Buffer instance at the specified memory.
static @Nullable XrVirtualKeyboardTextureDataMETA	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrVirtualKeyboardTextureDataMETA.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrVirtualKeyboardTextureDataMETA	malloc()	Returns a new XrVirtualKeyboardTextureDataMETA instance allocated with memAlloc.
static XrVirtualKeyboardTextureDataMETA.Buffer	malloc(int capacity)	Returns a new XrVirtualKeyboardTextureDataMETA.Buffer instance allocated with memAlloc.
static XrVirtualKeyboardTextureDataMETA.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardTextureDataMETA.Buffer instance allocated on the specified MemoryStack.
static XrVirtualKeyboardTextureDataMETA	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrVirtualKeyboardTextureDataMETA instance allocated on the specified MemoryStack.
static @Nullable ByteBuffer	nbuffer(long struct)	Unsafe version of buffer.
static void	nbuffer(long struct, @Nullable ByteBuffer value)	Unsafe version of buffer.
static int	nbufferCapacityInput(long struct)	Unsafe version of bufferCapacityInput().
static void	nbufferCapacityInput(long struct, int value)	Sets the specified value to the bufferCapacityInput field of the specified struct.
static int	nbufferCountOutput(long struct)	Unsafe version of bufferCountOutput().
static void	nbufferCountOutput(long struct, int value)	Unsafe version of bufferCountOutput.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrVirtualKeyboardTextureDataMETA	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntextureHeight(long struct)	Unsafe version of textureHeight().
static void	ntextureHeight(long struct, int value)	Unsafe version of textureHeight.
static int	ntextureWidth(long struct)	Unsafe version of textureWidth().
static void	ntextureWidth(long struct, int value)	Unsafe version of textureWidth.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrVirtualKeyboardTextureDataMETA	set(int type, long next, int textureWidth, int textureHeight, int bufferCapacityInput, int bufferCountOutput, @Nullable ByteBuffer buffer)	Initializes this struct with the specified values.
XrVirtualKeyboardTextureDataMETA	set(XrVirtualKeyboardTextureDataMETA src)	Copies the specified struct data to this struct.
int	sizeof()
int	textureHeight()	the pixel height of the texture to be updated.
XrVirtualKeyboardTextureDataMETA	textureHeight(int value)	Sets the specified value to the textureHeight() field.
int	textureWidth()	the pixel width of the texture to be updated.
XrVirtualKeyboardTextureDataMETA	textureWidth(int value)	Sets the specified value to the textureWidth() field.
int	type()	the XrStructureType of this structure.
XrVirtualKeyboardTextureDataMETA	type(int value)	Sets the specified value to the type() field.
XrVirtualKeyboardTextureDataMETA	type$Default()	Sets the TYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_META value to the type() field.

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.

TEXTUREWIDTH

public static final int TEXTUREWIDTH

The struct member offsets.

TEXTUREHEIGHT

public static final int TEXTUREHEIGHT

The struct member offsets.

BUFFERCAPACITYINPUT

public static final int BUFFERCAPACITYINPUT

The struct member offsets.

BUFFERCOUNTOUTPUT

public static final int BUFFERCOUNTOUTPUT

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

Constructor Details

XrVirtualKeyboardTextureDataMETA

public XrVirtualKeyboardTextureDataMETA(ByteBuffer container)

Creates a XrVirtualKeyboardTextureDataMETA 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<XrVirtualKeyboardTextureDataMETA>

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.

textureWidth

public int textureWidth()

the pixel width of the texture to be updated.

textureHeight

public int textureHeight()

the pixel height of the texture to be updated.

bufferCapacityInput

public int bufferCapacityInput()

the capacity of buffer, or 0 to indicate a request to retrieve the required capacity.

bufferCountOutput

public int bufferCountOutput()

filled in by the runtime with the byte count written or the required capacity in the case that bufferCapacityInput is insufficient.

buffer

public @Nullable ByteBuffer buffer()

the pixel data in linear color space, RGBA 8-bit unsigned normalized integer format (i.e. GL_RGBA8 in OpenGL, VK_FORMAT_R8G8B8A8_UNORM in Vulkan).

type

public XrVirtualKeyboardTextureDataMETA type(int value)

Sets the specified value to the type() field.

type$Default

public XrVirtualKeyboardTextureDataMETA type$Default()

Sets the TYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_META value to the type() field.

next

public XrVirtualKeyboardTextureDataMETA next(long value)

Sets the specified value to the next() field.

textureWidth

public XrVirtualKeyboardTextureDataMETA textureWidth(int value)

Sets the specified value to the textureWidth() field.

textureHeight

public XrVirtualKeyboardTextureDataMETA textureHeight(int value)

Sets the specified value to the textureHeight() field.

bufferCapacityInput

public XrVirtualKeyboardTextureDataMETA bufferCapacityInput(int value)

Sets the specified value to the bufferCapacityInput() field.

bufferCountOutput

public XrVirtualKeyboardTextureDataMETA bufferCountOutput(int value)

Sets the specified value to the bufferCountOutput() field.

buffer

public XrVirtualKeyboardTextureDataMETA buffer(@Nullable ByteBuffer value)

Sets the address of the specified ByteBuffer to the buffer() field.

set

public XrVirtualKeyboardTextureDataMETA set(int type,
 long next,
 int textureWidth,
 int textureHeight,
 int bufferCapacityInput,
 int bufferCountOutput,
 @Nullable ByteBuffer buffer)

Initializes this struct with the specified values.

set

public XrVirtualKeyboardTextureDataMETA set(XrVirtualKeyboardTextureDataMETA src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrVirtualKeyboardTextureDataMETA malloc()

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

calloc

public static XrVirtualKeyboardTextureDataMETA calloc()

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

create

public static XrVirtualKeyboardTextureDataMETA create()

Returns a new XrVirtualKeyboardTextureDataMETA instance allocated with BufferUtils.

create

public static XrVirtualKeyboardTextureDataMETA create(long address)

Returns a new XrVirtualKeyboardTextureDataMETA instance for the specified memory address.

createSafe

public static @Nullable XrVirtualKeyboardTextureDataMETA createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrVirtualKeyboardTextureDataMETA.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrVirtualKeyboardTextureDataMETA.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrVirtualKeyboardTextureDataMETA.Buffer create(int capacity)

Returns a new XrVirtualKeyboardTextureDataMETA.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrVirtualKeyboardTextureDataMETA.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrVirtualKeyboardTextureDataMETA instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ntextureWidth

public static int ntextureWidth(long struct)

Unsafe version of textureWidth().

ntextureHeight

public static int ntextureHeight(long struct)

Unsafe version of textureHeight().

nbufferCapacityInput

public static int nbufferCapacityInput(long struct)

Unsafe version of bufferCapacityInput().

nbufferCountOutput

public static int nbufferCountOutput(long struct)

Unsafe version of bufferCountOutput().

nbuffer

public static @Nullable ByteBuffer nbuffer(long struct)

Unsafe version of buffer.

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.

ntextureWidth

public static void ntextureWidth(long struct,
 int value)

Unsafe version of textureWidth.

ntextureHeight

public static void ntextureHeight(long struct,
 int value)

Unsafe version of textureHeight.

nbufferCapacityInput

public static void nbufferCapacityInput(long struct,
 int value)

Sets the specified value to the bufferCapacityInput field of the specified struct.

nbufferCountOutput

public static void nbufferCountOutput(long struct,
 int value)

Unsafe version of bufferCountOutput.

nbuffer

public static void nbuffer(long struct,
 @Nullable ByteBuffer value)

Unsafe version of buffer.