Record Class XrActionCreateInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrActionCreateInfo

All Implemented Interfaces:

IPointer, IXrActionCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrActionCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IXrActionCreateInfo

Represents a pointer to a XrActionCreateInfo structure in native memory.

Structure

typedef struct XrActionCreateInfo {
    XrStructureType type;
    void const* next;
    char[XR_MAX_ACTION_NAME_SIZE] actionName;
    XrActionType actionType;
    uint32_t countSubactionPaths; // optional
    XrPath const* subactionPaths; // optional
    char[XR_MAX_LOCALIZED_ACTION_NAME_SIZE] localizedActionName;
} XrActionCreateInfo;

Auto initialization

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

• type = XR_TYPE_ACTION_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:

• XrActionCreateInfo

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final SequenceLayout	LAYOUT$actionName
static final ValueLayout.OfInt	LAYOUT$actionType
static final ValueLayout.OfInt	LAYOUT$countSubactionPaths
static final SequenceLayout	LAYOUT$localizedActionName
static final AddressLayout	LAYOUT$next
static final AddressLayout	LAYOUT$subactionPaths
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$actionName
static final long	OFFSET$actionType
static final long	OFFSET$countSubactionPaths
static final long	OFFSET$localizedActionName
static final long	OFFSET$next
static final long	OFFSET$subactionPaths
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$actionName
static final MemoryLayout.PathElement	PATH$actionType
static final MemoryLayout.PathElement	PATH$countSubactionPaths
static final MemoryLayout.PathElement	PATH$localizedActionName
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$subactionPaths
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$actionName
static final long	SIZE$actionType
static final long	SIZE$countSubactionPaths
static final long	SIZE$localizedActionName
static final long	SIZE$next
static final long	SIZE$subactionPaths
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BytePtr	actionName()
XrActionCreateInfo	actionName(BytePtr value)
XrActionCreateInfo	actionName(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	actionNameRaw()
int	actionType()
XrActionCreateInfo	actionType(int value)
static XrActionCreateInfo	allocate(Arena arena)
static XrActionCreateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrActionCreateInfo	clone(Arena arena, XrActionCreateInfo src)
int	countSubactionPaths()
XrActionCreateInfo	countSubactionPaths(int 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.
BytePtr	localizedActionName()
XrActionCreateInfo	localizedActionName(BytePtr value)
XrActionCreateInfo	localizedActionName(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	localizedActionNameRaw()
@NotNull MemorySegment	next()
XrActionCreateInfo	next(@Nullable IPointer pointer)
XrActionCreateInfo	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable LongPtr	subactionPaths()	Note: the returned LongPtr does not have correct LongPtr.size() property.
XrActionCreateInfo	subactionPaths(@Nullable LongPtr value)
@NotNull MemorySegment	subactionPathsRaw()
void	subactionPathsRaw(@NotNull MemorySegment value)
final String	toString()	Returns a string representation of this record class.
int	type()
XrActionCreateInfo	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$actionName

public static final MemoryLayout.PathElement PATH$actionName

PATH$actionType

public static final MemoryLayout.PathElement PATH$actionType

PATH$countSubactionPaths

public static final MemoryLayout.PathElement PATH$countSubactionPaths

PATH$subactionPaths

public static final MemoryLayout.PathElement PATH$subactionPaths

PATH$localizedActionName

public static final MemoryLayout.PathElement PATH$localizedActionName

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$actionName

public static final SequenceLayout LAYOUT$actionName

LAYOUT$actionType

public static final ValueLayout.OfInt LAYOUT$actionType

LAYOUT$countSubactionPaths

public static final ValueLayout.OfInt LAYOUT$countSubactionPaths

LAYOUT$subactionPaths

public static final AddressLayout LAYOUT$subactionPaths

LAYOUT$localizedActionName

public static final SequenceLayout LAYOUT$localizedActionName

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$actionName

public static final long SIZE$actionName

SIZE$actionType

public static final long SIZE$actionType

SIZE$countSubactionPaths

public static final long SIZE$countSubactionPaths

SIZE$subactionPaths

public static final long SIZE$subactionPaths

SIZE$localizedActionName

public static final long SIZE$localizedActionName

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$actionName

public static final long OFFSET$actionName

OFFSET$actionType

public static final long OFFSET$actionType

OFFSET$countSubactionPaths

public static final long OFFSET$countSubactionPaths

OFFSET$subactionPaths

public static final long OFFSET$subactionPaths

OFFSET$localizedActionName

public static final long OFFSET$localizedActionName

Constructor Details

XrActionCreateInfo

public XrActionCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrActionCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrActionCreateInfo allocate(Arena arena)

allocate

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

clone

public static XrActionCreateInfo clone(Arena arena,
 XrActionCreateInfo src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrActionCreateInfo next(@Nullable
 @Nullable IPointer pointer)

actionName

public BytePtr actionName()

actionName

public XrActionCreateInfo actionName(@NotNull
 @NotNull Consumer<BytePtr> consumer)

actionName

public XrActionCreateInfo actionName(BytePtr value)

actionNameRaw

@NotNull
public @NotNull MemorySegment actionNameRaw()

actionType

@EnumType(XrActionType.class)
public int actionType()

actionType

public XrActionCreateInfo actionType(@EnumType(XrActionType.class)
 int value)

countSubactionPaths

@Unsigned
public int countSubactionPaths()

countSubactionPaths

public XrActionCreateInfo countSubactionPaths(@Unsigned
 int value)

subactionPaths

@Nullable
@Pointer(comment="XrPath")
@Unsigned
public @Nullable LongPtr subactionPaths()

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

subactionPaths

public XrActionCreateInfo subactionPaths(@Nullable @Pointer(comment="XrPath") @Unsigned
 @Nullable LongPtr value)

subactionPathsRaw

@Pointer(comment="uint64_t*")
@NotNull
public @NotNull MemorySegment subactionPathsRaw()

subactionPathsRaw

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

localizedActionName

public BytePtr localizedActionName()

localizedActionName

public XrActionCreateInfo localizedActionName(@NotNull
 @NotNull Consumer<BytePtr> consumer)

localizedActionName

public XrActionCreateInfo localizedActionName(BytePtr value)

localizedActionNameRaw

@NotNull
public @NotNull MemorySegment localizedActionNameRaw()

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