Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSceneCaptureRequestInfoFB

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

Describes how a scene capture should be conducted by the system.
Description

The XrSceneCaptureRequestInfoFB structure is used by an application to instruct the system what to look for during a scene capture. If the request parameter is NULL, then the runtime must conduct a default scene capture.

Valid Usage (Implicit)
See Also

RequestSceneCaptureFB

Layout


struct XrSceneCaptureRequestInfoFB {
    XrStructureType type;
    void const * next;
    uint32_t requestByteCount;
    char const * request;
}

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
NEXT

The struct member offsets.

public static final int
REQUEST

The struct member offsets.

public static final int
REQUESTBYTECOUNT

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
XrSceneCaptureRequestInfoFB(long address, ByteBuffer container)

public
XrSceneCaptureRequestInfoFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrSceneCaptureRequestInfoFB
calloc()

Returns a new XrSceneCaptureRequestInfoFB instance allocated with memCalloc.

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

Returns a new XrSceneCaptureRequestInfoFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrSceneCaptureRequestInfoFB instance allocated with BufferUtils.

public static XrSceneCaptureRequestInfoFB
create(long address)

Returns a new XrSceneCaptureRequestInfoFB instance for the specified memory address.

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

Returns a new XrSceneCaptureRequestInfoFB.Buffer instance allocated with BufferUtils.

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

Create a XrSceneCaptureRequestInfoFB.Buffer instance at the specified memory.

public static XrSceneCaptureRequestInfoFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSceneCaptureRequestInfoFB
malloc()

Returns a new XrSceneCaptureRequestInfoFB instance allocated with memAlloc.

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

Returns a new XrSceneCaptureRequestInfoFB.Buffer instance allocated with memAlloc.

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

Returns a new XrSceneCaptureRequestInfoFB instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrSceneCaptureRequestInfoFB
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static ByteBuffer
nrequest(long struct)

Unsafe version of request.

public static void
nrequest(long struct, ByteBuffer value)

Unsafe version of request.

public static int
nrequestByteCount(long struct)

Unsafe version of requestByteCount.

public static void
nrequestByteCount(long struct, int value)

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

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public ByteBuffer
request()

a string which the application can use to specify which type of scene capture should be initiated by the runtime.

public XrSceneCaptureRequestInfoFB
request(ByteBuffer value)

Sets the address of the specified ByteBuffer to the request field.

public int
requestByteCount()

byte length of the request parameter.

public XrSceneCaptureRequestInfoFB
requestByteCount(int value)

Sets the specified value to the requestByteCount field.

public XrSceneCaptureRequestInfoFB
set(int type, long next, int requestByteCount, ByteBuffer request)

Initializes this struct with the specified values.

public XrSceneCaptureRequestInfoFB

Returns:

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

Sets the specified value to the type field.

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

NEXTback to summary
public static final int NEXT

The struct member offsets.

REQUESTback to summary
public static final int REQUEST

The struct member offsets.

REQUESTBYTECOUNTback to summary
public static final int REQUESTBYTECOUNT

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

XrSceneCaptureRequestInfoFBback to summary
protected XrSceneCaptureRequestInfoFB(long address, ByteBuffer container)
XrSceneCaptureRequestInfoFBback to summary
public XrSceneCaptureRequestInfoFB(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSceneCaptureRequestInfoFB calloc(MemoryStack stack)

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

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

Returns a new XrSceneCaptureRequestInfoFB instance allocated with BufferUtils.

createback to summary
public static XrSceneCaptureRequestInfoFB create(long address)

Returns a new XrSceneCaptureRequestInfoFB instance for the specified memory address.

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

Returns a new XrSceneCaptureRequestInfoFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSceneCaptureRequestInfoFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrSceneCaptureRequestInfoFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrSceneCaptureRequestInfoFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSceneCaptureRequestInfoFB malloc(MemoryStack stack)

Returns a new XrSceneCaptureRequestInfoFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrSceneCaptureRequestInfoFB.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 const *
nextback to summary
public XrSceneCaptureRequestInfoFB next(long value)

Sets the specified value to the next field.

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.

nrequestback to summary
public static ByteBuffer nrequest(long struct)

Unsafe version of request.

Annotations
@Nullable
nrequestback to summary
public static void nrequest(long struct, ByteBuffer value)

Unsafe version of request.

nrequestByteCountback to summary
public static int nrequestByteCount(long struct)

Unsafe version of requestByteCount.

nrequestByteCountback to summary
public static void nrequestByteCount(long struct, int value)

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

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.

requestback to summary
public ByteBuffer request()

a string which the application can use to specify which type of scene capture should be initiated by the runtime. The contents of buffer pointed to by the request parameter is runtime-specific.

Annotations
@Nullable
@NativeType:char const *
requestback to summary
public XrSceneCaptureRequestInfoFB request(ByteBuffer value)

Sets the address of the specified ByteBuffer to the request field.

requestByteCountback to summary
public int requestByteCount()

byte length of the request parameter.

Annotations
@NativeType:uint32_t
requestByteCountback to summary
public XrSceneCaptureRequestInfoFB requestByteCount(int value)

Sets the specified value to the requestByteCount field.

setback to summary
public XrSceneCaptureRequestInfoFB set(int type, long next, int requestByteCount, ByteBuffer request)

Initializes this struct with the specified values.

setback to summary
public XrSceneCaptureRequestInfoFB set(XrSceneCaptureRequestInfoFB src)

Copies the specified struct data to this struct.

Parameters
src:XrSceneCaptureRequestInfoFB

the source struct

Returns:XrSceneCaptureRequestInfoFB

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

Sets the specified value to the type field.

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

Sets the TYPE_SCENE_CAPTURE_REQUEST_INFO_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrSceneCaptureRequestInfoFB.Buffer

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

An array of XrSceneCaptureRequestInfoFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrSceneCaptureRequestInfoFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSceneCaptureRequestInfoFB.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 XrSceneCaptureRequestInfoFB
public long

Returns:

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

public XrSceneCaptureRequestInfoFB.Buffer
next(long value)

Sets the specified value to the XrSceneCaptureRequestInfoFB#next field.

public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the XrSceneCaptureRequestInfoFB#request field.
request
()

public XrSceneCaptureRequestInfoFB.Buffer
request(ByteBuffer value)

Sets the address of the specified ByteBuffer to the XrSceneCaptureRequestInfoFB#request field.

public int
public XrSceneCaptureRequestInfoFB.Buffer
requestByteCount(int value)

Sets the specified value to the XrSceneCaptureRequestInfoFB#requestByteCount field.

protected XrSceneCaptureRequestInfoFB.Buffer
public int

Returns:

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

public XrSceneCaptureRequestInfoFB.Buffer
type(int value)

Sets the specified value to the XrSceneCaptureRequestInfoFB#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSceneCaptureRequestInfoFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSceneCaptureRequestInfoFB.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 XrSceneCaptureRequestInfoFB#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 XrSceneCaptureRequestInfoFB getElementFactory()

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

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

the value of the XrSceneCaptureRequestInfoFB#next field.

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

Sets the specified value to the XrSceneCaptureRequestInfoFB#next field.

requestback to summary
public ByteBuffer request()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the XrSceneCaptureRequestInfoFB#request field.

Annotations
@Nullable
@NativeType:char const *
requestback to summary
public XrSceneCaptureRequestInfoFB.Buffer request(ByteBuffer value)

Sets the address of the specified ByteBuffer to the XrSceneCaptureRequestInfoFB#request field.

requestByteCountback to summary
public int requestByteCount()
Returns:int

the value of the XrSceneCaptureRequestInfoFB#requestByteCount field.

Annotations
@NativeType:uint32_t
requestByteCountback to summary
public XrSceneCaptureRequestInfoFB.Buffer requestByteCount(int value)

Sets the specified value to the XrSceneCaptureRequestInfoFB#requestByteCount field.

selfback to summary
protected XrSceneCaptureRequestInfoFB.Buffer self()

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

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

the value of the XrSceneCaptureRequestInfoFB#type field.

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

Sets the specified value to the XrSceneCaptureRequestInfoFB#type field.

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

Sets the TYPE_SCENE_CAPTURE_REQUEST_INFO_FB value to the XrSceneCaptureRequestInfoFB#type field.