Record Class XrInstanceCreateInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrInstanceCreateInfo

All Implemented Interfaces:

IPointer, IXrInstanceCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrInstanceCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IXrInstanceCreateInfo

Represents a pointer to a XrInstanceCreateInfo structure in native memory.

Structure

typedef struct XrInstanceCreateInfo {
    XrStructureType type;
    void const* next;
    XrInstanceCreateFlags createFlags; // optional
    XrApplicationInfo applicationInfo;
    uint32_t enabledApiLayerCount; // optional
    char const* const* enabledApiLayerNames; // optional
    uint32_t enabledExtensionCount; // optional
    char const* const* enabledExtensionNames; // optional
} XrInstanceCreateInfo;

Auto initialization

This structure has the following members that can be automatically initialized:

• type = XR_TYPE_INSTANCE_CREATE_INFO

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

• XrInstanceCreateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrInstanceCreateInfo.Ptr	Represents a pointer to / an array of XrInstanceCreateInfo structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$applicationInfo
static final ValueLayout.OfLong	LAYOUT$createFlags
static final ValueLayout.OfInt	LAYOUT$enabledApiLayerCount
static final AddressLayout	LAYOUT$enabledApiLayerNames
static final ValueLayout.OfInt	LAYOUT$enabledExtensionCount
static final AddressLayout	LAYOUT$enabledExtensionNames
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$applicationInfo
static final long	OFFSET$createFlags
static final long	OFFSET$enabledApiLayerCount
static final long	OFFSET$enabledApiLayerNames
static final long	OFFSET$enabledExtensionCount
static final long	OFFSET$enabledExtensionNames
static final long	OFFSET$next
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$applicationInfo
static final MemoryLayout.PathElement	PATH$createFlags
static final MemoryLayout.PathElement	PATH$enabledApiLayerCount
static final MemoryLayout.PathElement	PATH$enabledApiLayerNames
static final MemoryLayout.PathElement	PATH$enabledExtensionCount
static final MemoryLayout.PathElement	PATH$enabledExtensionNames
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$applicationInfo
static final long	SIZE$createFlags
static final long	SIZE$enabledApiLayerCount
static final long	SIZE$enabledApiLayerNames
static final long	SIZE$enabledExtensionCount
static final long	SIZE$enabledExtensionNames
static final long	SIZE$next
static final long	SIZE$type

Constructor Summary

Constructors

Constructor	Description
XrInstanceCreateInfo(@NotNull MemorySegment segment)	Creates an instance of a XrInstanceCreateInfo record class.

Method Summary

Modifier and Type	Method	Description
static XrInstanceCreateInfo	allocate(Arena arena)
static XrInstanceCreateInfo.Ptr	allocate(Arena arena, long count)
@NotNull XrApplicationInfo	applicationInfo()
XrInstanceCreateInfo	applicationInfo(@NotNull XrApplicationInfo value)
XrInstanceCreateInfo	applicationInfo(Consumer<@NotNull XrApplicationInfo> consumer)
void	autoInit()
static XrInstanceCreateInfo	clone(Arena arena, XrInstanceCreateInfo src)
long	createFlags()
XrInstanceCreateInfo	createFlags(long value)
int	enabledApiLayerCount()
XrInstanceCreateInfo	enabledApiLayerCount(int value)
@Nullable PointerPtr	enabledApiLayerNames()	Note: the returned PointerPtr does not have correct PointerPtr.size() property.
XrInstanceCreateInfo	enabledApiLayerNames(@Nullable PointerPtr value)
@NotNull MemorySegment	enabledApiLayerNamesRaw()
void	enabledApiLayerNamesRaw(@NotNull MemorySegment value)
int	enabledExtensionCount()
XrInstanceCreateInfo	enabledExtensionCount(int value)
@Nullable PointerPtr	enabledExtensionNames()	Note: the returned PointerPtr does not have correct PointerPtr.size() property.
XrInstanceCreateInfo	enabledExtensionNames(@Nullable PointerPtr value)
@NotNull MemorySegment	enabledExtensionNamesRaw()
void	enabledExtensionNamesRaw(@NotNull MemorySegment value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	next()
XrInstanceCreateInfo	next(@Nullable IPointer pointer)
XrInstanceCreateInfo	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
XrInstanceCreateInfo	type(int value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$type

public static final MemoryLayout.PathElement PATH$type

PATH$next

public static final MemoryLayout.PathElement PATH$next

PATH$createFlags

public static final MemoryLayout.PathElement PATH$createFlags

PATH$applicationInfo

public static final MemoryLayout.PathElement PATH$applicationInfo

PATH$enabledApiLayerCount

public static final MemoryLayout.PathElement PATH$enabledApiLayerCount

PATH$enabledApiLayerNames

public static final MemoryLayout.PathElement PATH$enabledApiLayerNames

PATH$enabledExtensionCount

public static final MemoryLayout.PathElement PATH$enabledExtensionCount

PATH$enabledExtensionNames

public static final MemoryLayout.PathElement PATH$enabledExtensionNames

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$createFlags

public static final ValueLayout.OfLong LAYOUT$createFlags

LAYOUT$applicationInfo

public static final StructLayout LAYOUT$applicationInfo

LAYOUT$enabledApiLayerCount

public static final ValueLayout.OfInt LAYOUT$enabledApiLayerCount

LAYOUT$enabledApiLayerNames

public static final AddressLayout LAYOUT$enabledApiLayerNames

LAYOUT$enabledExtensionCount

public static final ValueLayout.OfInt LAYOUT$enabledExtensionCount

LAYOUT$enabledExtensionNames

public static final AddressLayout LAYOUT$enabledExtensionNames

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$createFlags

public static final long SIZE$createFlags

SIZE$applicationInfo

public static final long SIZE$applicationInfo

SIZE$enabledApiLayerCount

public static final long SIZE$enabledApiLayerCount

SIZE$enabledApiLayerNames

public static final long SIZE$enabledApiLayerNames

SIZE$enabledExtensionCount

public static final long SIZE$enabledExtensionCount

SIZE$enabledExtensionNames

public static final long SIZE$enabledExtensionNames

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$createFlags

public static final long OFFSET$createFlags

OFFSET$applicationInfo

public static final long OFFSET$applicationInfo

OFFSET$enabledApiLayerCount

public static final long OFFSET$enabledApiLayerCount

OFFSET$enabledApiLayerNames

public static final long OFFSET$enabledApiLayerNames

OFFSET$enabledExtensionCount

public static final long OFFSET$enabledExtensionCount

OFFSET$enabledExtensionNames

public static final long OFFSET$enabledExtensionNames

Constructor Details

XrInstanceCreateInfo

public XrInstanceCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrInstanceCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrInstanceCreateInfo allocate(Arena arena)

allocate

public static XrInstanceCreateInfo.Ptr allocate(Arena arena,
 long count)

clone

public static XrInstanceCreateInfo clone(Arena arena,
 XrInstanceCreateInfo src)

autoInit

public void autoInit()

type

@EnumType(XrStructureType.class)
public int type()

type

public XrInstanceCreateInfo type(@EnumType(XrStructureType.class)
 int value)

next

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment next()

next

public XrInstanceCreateInfo next(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

next

public XrInstanceCreateInfo next(@Nullable
 @Nullable IPointer pointer)

createFlags

@Bitmask(XrInstanceCreateFlags.class)
public long createFlags()

createFlags

public XrInstanceCreateInfo createFlags(@Bitmask(XrInstanceCreateFlags.class)
 long value)

applicationInfo

@NotNull
public @NotNull XrApplicationInfo applicationInfo()

applicationInfo

public XrInstanceCreateInfo applicationInfo(@NotNull
 @NotNull XrApplicationInfo value)

applicationInfo

public XrInstanceCreateInfo applicationInfo(Consumer<@NotNull XrApplicationInfo> consumer)

enabledApiLayerCount

@Unsigned
public int enabledApiLayerCount()

enabledApiLayerCount

public XrInstanceCreateInfo enabledApiLayerCount(@Unsigned
 int value)

enabledApiLayerNames

@Nullable
public @Nullable PointerPtr enabledApiLayerNames()

Note: the returned PointerPtr does not have correct PointerPtr.size() property. It's up to user to track the size of the buffer, and use PointerPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

enabledApiLayerNames

public XrInstanceCreateInfo enabledApiLayerNames(@Nullable
 @Nullable PointerPtr value)

enabledApiLayerNamesRaw

@Pointer(comment="void**")
@NotNull
public @NotNull MemorySegment enabledApiLayerNamesRaw()

enabledApiLayerNamesRaw

public void enabledApiLayerNamesRaw(@Pointer(comment="void**") @NotNull
 @NotNull MemorySegment value)

enabledExtensionCount

@Unsigned
public int enabledExtensionCount()

enabledExtensionCount

public XrInstanceCreateInfo enabledExtensionCount(@Unsigned
 int value)

enabledExtensionNames

@Nullable
public @Nullable PointerPtr enabledExtensionNames()

Note: the returned PointerPtr does not have correct PointerPtr.size() property. It's up to user to track the size of the buffer, and use PointerPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

enabledExtensionNames

public XrInstanceCreateInfo enabledExtensionNames(@Nullable
 @Nullable PointerPtr value)

enabledExtensionNamesRaw

@Pointer(comment="void**")
@NotNull
public @NotNull MemorySegment enabledExtensionNamesRaw()

enabledExtensionNamesRaw

public void enabledExtensionNamesRaw(@Pointer(comment="void**") @NotNull
 @NotNull MemorySegment value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component