Record Class XrGraphicsBindingVulkan2KHR

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrGraphicsBindingVulkan2KHR

All Implemented Interfaces:

IPointer, IXrGraphicsBindingVulkan2KHR

@ValueBasedCandidate
@UnsafeConstructor
public record XrGraphicsBindingVulkan2KHR(@NotNull MemorySegment segment)
extends Record
implements IXrGraphicsBindingVulkan2KHR

Represents a pointer to a XrGraphicsBindingVulkan2KHR structure in native memory.

Structure

typedef struct XrGraphicsBindingVulkan2KHR {
    XrStructureType type;
    void const* next;
    VkInstance instance;
    VkPhysicalDevice physicalDevice;
    VkDevice device;
    uint32_t queueFamilyIndex;
    uint32_t queueIndex;
} XrGraphicsBindingVulkan2KHR;

Auto initialization

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

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

• XrGraphicsBindingVulkan2KHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrGraphicsBindingVulkan2KHR.Ptr	Represents a pointer to / an array of XrGraphicsBindingVulkan2KHR 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$device
static final AddressLayout	LAYOUT$instance
static final AddressLayout	LAYOUT$next
static final AddressLayout	LAYOUT$physicalDevice
static final ValueLayout.OfInt	LAYOUT$queueFamilyIndex
static final ValueLayout.OfInt	LAYOUT$queueIndex
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$device
static final long	OFFSET$instance
static final long	OFFSET$next
static final long	OFFSET$physicalDevice
static final long	OFFSET$queueFamilyIndex
static final long	OFFSET$queueIndex
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$device
static final MemoryLayout.PathElement	PATH$instance
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$physicalDevice
static final MemoryLayout.PathElement	PATH$queueFamilyIndex
static final MemoryLayout.PathElement	PATH$queueIndex
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$device
static final long	SIZE$instance
static final long	SIZE$next
static final long	SIZE$physicalDevice
static final long	SIZE$queueFamilyIndex
static final long	SIZE$queueIndex
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrGraphicsBindingVulkan2KHR	allocate(Arena arena)
static XrGraphicsBindingVulkan2KHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrGraphicsBindingVulkan2KHR	clone(Arena arena, XrGraphicsBindingVulkan2KHR src)
@Nullable VkDevice	device()
XrGraphicsBindingVulkan2KHR	device(@Nullable VkDevice 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.
@Nullable VkInstance	instance()
XrGraphicsBindingVulkan2KHR	instance(@Nullable VkInstance value)
@NotNull MemorySegment	next()
XrGraphicsBindingVulkan2KHR	next(@Nullable IPointer pointer)
XrGraphicsBindingVulkan2KHR	next(@NotNull MemorySegment value)
@Nullable VkPhysicalDevice	physicalDevice()
XrGraphicsBindingVulkan2KHR	physicalDevice(@Nullable VkPhysicalDevice value)
int	queueFamilyIndex()
XrGraphicsBindingVulkan2KHR	queueFamilyIndex(int value)
int	queueIndex()
XrGraphicsBindingVulkan2KHR	queueIndex(int 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()
XrGraphicsBindingVulkan2KHR	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$instance

public static final MemoryLayout.PathElement PATH$instance

PATH$physicalDevice

public static final MemoryLayout.PathElement PATH$physicalDevice

PATH$device

public static final MemoryLayout.PathElement PATH$device

PATH$queueFamilyIndex

public static final MemoryLayout.PathElement PATH$queueFamilyIndex

PATH$queueIndex

public static final MemoryLayout.PathElement PATH$queueIndex

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$instance

public static final AddressLayout LAYOUT$instance

LAYOUT$physicalDevice

public static final AddressLayout LAYOUT$physicalDevice

LAYOUT$device

public static final AddressLayout LAYOUT$device

LAYOUT$queueFamilyIndex

public static final ValueLayout.OfInt LAYOUT$queueFamilyIndex

LAYOUT$queueIndex

public static final ValueLayout.OfInt LAYOUT$queueIndex

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$instance

public static final long SIZE$instance

SIZE$physicalDevice

public static final long SIZE$physicalDevice

SIZE$device

public static final long SIZE$device

SIZE$queueFamilyIndex

public static final long SIZE$queueFamilyIndex

SIZE$queueIndex

public static final long SIZE$queueIndex

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$instance

public static final long OFFSET$instance

OFFSET$physicalDevice

public static final long OFFSET$physicalDevice

OFFSET$device

public static final long OFFSET$device

OFFSET$queueFamilyIndex

public static final long OFFSET$queueFamilyIndex

OFFSET$queueIndex

public static final long OFFSET$queueIndex

Constructor Details

XrGraphicsBindingVulkan2KHR

public XrGraphicsBindingVulkan2KHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrGraphicsBindingVulkan2KHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrGraphicsBindingVulkan2KHR allocate(Arena arena)

allocate

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

clone

public static XrGraphicsBindingVulkan2KHR clone(Arena arena,
 XrGraphicsBindingVulkan2KHR src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrGraphicsBindingVulkan2KHR next(@Nullable
 @Nullable IPointer pointer)

instance

@Nullable
public @Nullable VkInstance instance()

instance

public XrGraphicsBindingVulkan2KHR instance(@Nullable
 @Nullable VkInstance value)

physicalDevice

@Nullable
public @Nullable VkPhysicalDevice physicalDevice()

physicalDevice

public XrGraphicsBindingVulkan2KHR physicalDevice(@Nullable
 @Nullable VkPhysicalDevice value)

device

@Nullable
public @Nullable VkDevice device()

device

public XrGraphicsBindingVulkan2KHR device(@Nullable
 @Nullable VkDevice value)

queueFamilyIndex

@Unsigned
public int queueFamilyIndex()

queueFamilyIndex

public XrGraphicsBindingVulkan2KHR queueFamilyIndex(@Unsigned
 int value)

queueIndex

@Unsigned
public int queueIndex()

queueIndex

public XrGraphicsBindingVulkan2KHR queueIndex(@Unsigned
 int 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