Record Class VkBufferMemoryRequirementsInfo2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBufferMemoryRequirementsInfo2

All Implemented Interfaces:

IPointer, IVkBufferMemoryRequirementsInfo2

@ValueBasedCandidate
@UnsafeConstructor
public record VkBufferMemoryRequirementsInfo2(@NotNull MemorySegment segment)
extends Record
implements IVkBufferMemoryRequirementsInfo2

Represents a pointer to a VkBufferMemoryRequirementsInfo2 structure in native memory.

Structure

typedef struct VkBufferMemoryRequirementsInfo2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkBuffer buffer;
} VkBufferMemoryRequirementsInfo2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_BUFFER_MEMORY_REQUIREMENTS_INFO_2

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:

• VkBufferMemoryRequirementsInfo2

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBufferMemoryRequirementsInfo2	allocate(Arena arena)
static VkBufferMemoryRequirementsInfo2.Ptr	allocate(Arena arena, long count)
void	autoInit()
@Nullable VkBuffer	buffer()
VkBufferMemoryRequirementsInfo2	buffer(@Nullable VkBuffer value)
static VkBufferMemoryRequirementsInfo2	clone(Arena arena, VkBufferMemoryRequirementsInfo2 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	pNext()
VkBufferMemoryRequirementsInfo2	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkBufferMemoryRequirementsInfo2	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$buffer

public static final MemoryLayout.PathElement PATH$buffer

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$buffer

public static final long SIZE$buffer

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$buffer

public static final long OFFSET$buffer

Constructor Details

VkBufferMemoryRequirementsInfo2

public VkBufferMemoryRequirementsInfo2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBufferMemoryRequirementsInfo2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBufferMemoryRequirementsInfo2 allocate(Arena arena)

allocate

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

clone

public static VkBufferMemoryRequirementsInfo2 clone(Arena arena,
 VkBufferMemoryRequirementsInfo2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBufferMemoryRequirementsInfo2 pNext(@Nullable
 @Nullable IPointer pointer)

buffer

@Nullable
public @Nullable VkBuffer buffer()

buffer

public VkBufferMemoryRequirementsInfo2 buffer(@Nullable
 @Nullable VkBuffer 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