Package org.lwjgl.openxr

Class XrEventDataSceneCaptureCompleteFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrEventDataSceneCaptureCompleteFB>

org.lwjgl.openxr.XrEventDataSceneCaptureCompleteFB

All Implemented Interfaces:

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

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

Event which occurs after a scene capture operation completes.

Description

The XrEventDataSceneCaptureCompleteFB structure is used by an application to instruct the system what to look for during a scene capture.

Valid Usage (Implicit)

• The XR_FB_scene_capture extension must be enabled prior to using XrEventDataSceneCaptureCompleteFB
• type must be TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• result must be a valid XrResult value

Layout

 struct XrEventDataSceneCaptureCompleteFB {
     XrStructureType type();
     void const * next();
     XrAsyncRequestIdFB requestId();
     XrResult result();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static XrEventDataSceneCaptureCompleteFB	calloc()	Returns a new XrEventDataSceneCaptureCompleteFB instance allocated with memCalloc.
static XrEventDataSceneCaptureCompleteFB.Buffer	calloc(int capacity)	Returns a new XrEventDataSceneCaptureCompleteFB.Buffer instance allocated with memCalloc.
static XrEventDataSceneCaptureCompleteFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSceneCaptureCompleteFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataSceneCaptureCompleteFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSceneCaptureCompleteFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrEventDataSceneCaptureCompleteFB	create()	Returns a new XrEventDataSceneCaptureCompleteFB instance allocated with BufferUtils.
static XrEventDataSceneCaptureCompleteFB.Buffer	create(int capacity)	Returns a new XrEventDataSceneCaptureCompleteFB.Buffer instance allocated with BufferUtils.
static XrEventDataSceneCaptureCompleteFB	create(long address)	Returns a new XrEventDataSceneCaptureCompleteFB instance for the specified memory address.
static XrEventDataSceneCaptureCompleteFB.Buffer	create(long address, int capacity)	Create a XrEventDataSceneCaptureCompleteFB.Buffer instance at the specified memory.
static @Nullable XrEventDataSceneCaptureCompleteFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrEventDataSceneCaptureCompleteFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrEventDataSceneCaptureCompleteFB	malloc()	Returns a new XrEventDataSceneCaptureCompleteFB instance allocated with memAlloc.
static XrEventDataSceneCaptureCompleteFB.Buffer	malloc(int capacity)	Returns a new XrEventDataSceneCaptureCompleteFB.Buffer instance allocated with memAlloc.
static XrEventDataSceneCaptureCompleteFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSceneCaptureCompleteFB.Buffer instance allocated on the specified MemoryStack.
static XrEventDataSceneCaptureCompleteFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrEventDataSceneCaptureCompleteFB instance allocated on the specified MemoryStack.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrEventDataSceneCaptureCompleteFB	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 long	nrequestId(long struct)	Unsafe version of requestId().
static void	nrequestId(long struct, long value)	Unsafe version of requestId.
static int	nresult(long struct)	Unsafe version of result().
static void	nresult(long struct, int value)	Unsafe version of result.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
long	requestId()	the ID of the asynchronous query request.
XrEventDataSceneCaptureCompleteFB	requestId(long value)	Sets the specified value to the requestId() field.
int	result()	an XrResult that indicates if the request succeeded or if an error occurred.
XrEventDataSceneCaptureCompleteFB	result(int value)	Sets the specified value to the result() field.
XrEventDataSceneCaptureCompleteFB	set(int type, long next, long requestId, int result)	Initializes this struct with the specified values.
XrEventDataSceneCaptureCompleteFB	set(XrEventDataSceneCaptureCompleteFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrEventDataSceneCaptureCompleteFB	type(int value)	Sets the specified value to the type() field.
XrEventDataSceneCaptureCompleteFB	type$Default()	Sets the TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB 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.

REQUESTID

public static final int REQUESTID

The struct member offsets.

RESULT

public static final int RESULT

The struct member offsets.

Constructor Details

XrEventDataSceneCaptureCompleteFB

public XrEventDataSceneCaptureCompleteFB(ByteBuffer container)

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

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.

requestId

public long requestId()

the ID of the asynchronous query request.

result

public int result()

an XrResult that indicates if the request succeeded or if an error occurred.

type

public XrEventDataSceneCaptureCompleteFB type(int value)

Sets the specified value to the type() field.

type$Default

public XrEventDataSceneCaptureCompleteFB type$Default()

Sets the TYPE_EVENT_DATA_SCENE_CAPTURE_COMPLETE_FB value to the type() field.

next

public XrEventDataSceneCaptureCompleteFB next(long value)

Sets the specified value to the next() field.

requestId

public XrEventDataSceneCaptureCompleteFB requestId(long value)

Sets the specified value to the requestId() field.

result

public XrEventDataSceneCaptureCompleteFB result(int value)

Sets the specified value to the result() field.

set

public XrEventDataSceneCaptureCompleteFB set(int type,
 long next,
 long requestId,
 int result)

Initializes this struct with the specified values.

set

public XrEventDataSceneCaptureCompleteFB set(XrEventDataSceneCaptureCompleteFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrEventDataSceneCaptureCompleteFB malloc()

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

calloc

public static XrEventDataSceneCaptureCompleteFB calloc()

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

create

public static XrEventDataSceneCaptureCompleteFB create()

Returns a new XrEventDataSceneCaptureCompleteFB instance allocated with BufferUtils.

create

public static XrEventDataSceneCaptureCompleteFB create(long address)

Returns a new XrEventDataSceneCaptureCompleteFB instance for the specified memory address.

createSafe

public static @Nullable XrEventDataSceneCaptureCompleteFB createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrEventDataSceneCaptureCompleteFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrEventDataSceneCaptureCompleteFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrEventDataSceneCaptureCompleteFB.Buffer create(int capacity)

Returns a new XrEventDataSceneCaptureCompleteFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrEventDataSceneCaptureCompleteFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrEventDataSceneCaptureCompleteFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nrequestId

public static long nrequestId(long struct)

Unsafe version of requestId().

nresult

public static int nresult(long struct)

Unsafe version of result().

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.

nrequestId

public static void nrequestId(long struct,
 long value)

Unsafe version of requestId.

nresult

public static void nresult(long struct,
 int value)

Unsafe version of result.