Record Class XrSwapchainImageVulkan2KHR

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSwapchainImageVulkan2KHR

All Implemented Interfaces:

IPointer, IXrSwapchainImageVulkan2KHR

@ValueBasedCandidate
@UnsafeConstructor
public record XrSwapchainImageVulkan2KHR(@NotNull MemorySegment segment)
extends Record
implements IXrSwapchainImageVulkan2KHR

Represents a pointer to a XrSwapchainImageVulkan2KHR structure in native memory.

Structure

typedef struct XrSwapchainImageVulkan2KHR {
    XrStructureType type;
    void* next;
    VkImage image;
} XrSwapchainImageVulkan2KHR;

Auto initialization

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

• type = XR_TYPE_SWAPCHAIN_IMAGE_VULKAN_KHR

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:

• XrSwapchainImageVulkan2KHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$image
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$image
static final long	OFFSET$next
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$image
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$image
static final long	SIZE$next
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSwapchainImageVulkan2KHR	allocate(Arena arena)
static XrSwapchainImageVulkan2KHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSwapchainImageVulkan2KHR	clone(Arena arena, XrSwapchainImageVulkan2KHR src)
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.
@Nullable VkImage	image()
XrSwapchainImageVulkan2KHR	image(@Nullable VkImage value)
@NotNull MemorySegment	next()
XrSwapchainImageVulkan2KHR	next(@Nullable IPointer pointer)
XrSwapchainImageVulkan2KHR	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()
XrSwapchainImageVulkan2KHR	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$image

public static final MemoryLayout.PathElement PATH$image

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$image

public static final AddressLayout LAYOUT$image

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$image

public static final long SIZE$image

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$image

public static final long OFFSET$image

Constructor Details

XrSwapchainImageVulkan2KHR

public XrSwapchainImageVulkan2KHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSwapchainImageVulkan2KHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSwapchainImageVulkan2KHR allocate(Arena arena)

allocate

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

clone

public static XrSwapchainImageVulkan2KHR clone(Arena arena,
 XrSwapchainImageVulkan2KHR src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSwapchainImageVulkan2KHR next(@Nullable
 @Nullable IPointer pointer)

image

@Nullable
public @Nullable VkImage image()

image

public XrSwapchainImageVulkan2KHR image(@Nullable
 @Nullable VkImage 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