Record Class VkExportMetalCommandQueueInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkExportMetalCommandQueueInfoEXT

All Implemented Interfaces:

IPointer, IVkExportMetalCommandQueueInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkExportMetalCommandQueueInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkExportMetalCommandQueueInfoEXT

Represents a pointer to a VkExportMetalCommandQueueInfoEXT structure in native memory.

Structure

typedef struct VkExportMetalCommandQueueInfoEXT {
    VkStructureType sType;
    void const* pNext; // optional
    VkQueue queue;
    MTLCommandQueue_id mtlCommandQueue;
} VkExportMetalCommandQueueInfoEXT;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_EXPORT_METAL_COMMAND_QUEUE_INFO_EXT

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:

• VkExportMetalCommandQueueInfoEXT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkExportMetalCommandQueueInfoEXT.Ptr	Represents a pointer to / an array of VkExportMetalCommandQueueInfoEXT 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$mtlCommandQueue
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$queue
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$mtlCommandQueue
static final long	OFFSET$pNext
static final long	OFFSET$queue
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$mtlCommandQueue
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$queue
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$mtlCommandQueue
static final long	SIZE$pNext
static final long	SIZE$queue
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkExportMetalCommandQueueInfoEXT	allocate(Arena arena)
static VkExportMetalCommandQueueInfoEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkExportMetalCommandQueueInfoEXT	clone(Arena arena, VkExportMetalCommandQueueInfoEXT 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.
MemorySegment	mtlCommandQueue()
VkExportMetalCommandQueueInfoEXT	mtlCommandQueue(@Nullable IPointer pointer)
void	mtlCommandQueue(MemorySegment value)
MemorySegment	pNext()
VkExportMetalCommandQueueInfoEXT	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@Nullable VkQueue	queue()
VkExportMetalCommandQueueInfoEXT	queue(@Nullable VkQueue value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkExportMetalCommandQueueInfoEXT	sType(int value)
final String	toString()	Returns a string representation of this record class.

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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$queue

public static final MemoryLayout.PathElement PATH$queue

PATH$mtlCommandQueue

public static final MemoryLayout.PathElement PATH$mtlCommandQueue

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$queue

public static final AddressLayout LAYOUT$queue

LAYOUT$mtlCommandQueue

public static final AddressLayout LAYOUT$mtlCommandQueue

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$queue

public static final long SIZE$queue

SIZE$mtlCommandQueue

public static final long SIZE$mtlCommandQueue

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$queue

public static final long OFFSET$queue

OFFSET$mtlCommandQueue

public static final long OFFSET$mtlCommandQueue

Constructor Details

VkExportMetalCommandQueueInfoEXT

public VkExportMetalCommandQueueInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkExportMetalCommandQueueInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkExportMetalCommandQueueInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkExportMetalCommandQueueInfoEXT clone(Arena arena,
 VkExportMetalCommandQueueInfoEXT src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkExportMetalCommandQueueInfoEXT sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
public MemorySegment pNext()

pNext

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

pNext

public VkExportMetalCommandQueueInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

queue

@Nullable
public @Nullable VkQueue queue()

queue

public VkExportMetalCommandQueueInfoEXT queue(@Nullable
 @Nullable VkQueue value)

mtlCommandQueue

@Pointer(comment="MTLCommandQueue_id")
public MemorySegment mtlCommandQueue()

mtlCommandQueue

public void mtlCommandQueue(@Pointer(comment="MTLCommandQueue_id")
 MemorySegment value)

mtlCommandQueue

public VkExportMetalCommandQueueInfoEXT mtlCommandQueue(@Nullable
 @Nullable IPointer pointer)

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