Record Class VkPhysicalDeviceMaintenance3Properties

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceMaintenance3Properties

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceMaintenance3Properties

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceMaintenance3Properties(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceMaintenance3Properties

Represents a pointer to a VkPhysicalDeviceMaintenance3Properties structure in native memory.

Structure

typedef struct VkPhysicalDeviceMaintenance3Properties {
    VkStructureType sType;
    void* pNext; // optional
    uint32_t maxPerSetDescriptors;
    VkDeviceSize maxMemoryAllocationSize;
} VkPhysicalDeviceMaintenance3Properties;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MAINTENANCE_3_PROPERTIES

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:

• VkPhysicalDeviceMaintenance3Properties

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$maxMemoryAllocationSize
static final ValueLayout.OfInt	LAYOUT$maxPerSetDescriptors
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$maxMemoryAllocationSize
static final long	OFFSET$maxPerSetDescriptors
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$maxMemoryAllocationSize
static final MemoryLayout.PathElement	PATH$maxPerSetDescriptors
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$maxMemoryAllocationSize
static final long	SIZE$maxPerSetDescriptors
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$maxPerSetDescriptors

PATH$maxMemoryAllocationSize

public static final MemoryLayout.PathElement PATH$maxMemoryAllocationSize

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$maxPerSetDescriptors

public static final ValueLayout.OfInt LAYOUT$maxPerSetDescriptors

LAYOUT$maxMemoryAllocationSize

public static final ValueLayout.OfLong LAYOUT$maxMemoryAllocationSize

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$maxPerSetDescriptors

public static final long SIZE$maxPerSetDescriptors

SIZE$maxMemoryAllocationSize

public static final long SIZE$maxMemoryAllocationSize

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$maxPerSetDescriptors

public static final long OFFSET$maxPerSetDescriptors

OFFSET$maxMemoryAllocationSize

public static final long OFFSET$maxMemoryAllocationSize

Constructor Details

VkPhysicalDeviceMaintenance3Properties

public VkPhysicalDeviceMaintenance3Properties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceMaintenance3Properties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceMaintenance3Properties allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceMaintenance3Properties clone(Arena arena,
 VkPhysicalDeviceMaintenance3Properties src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDeviceMaintenance3Properties pNext(@Nullable
 @Nullable IPointer pointer)

maxPerSetDescriptors

@Unsigned
public int maxPerSetDescriptors()

maxPerSetDescriptors

public VkPhysicalDeviceMaintenance3Properties maxPerSetDescriptors(@Unsigned
 int value)

maxMemoryAllocationSize

@NativeType("VkDeviceSize")
@Unsigned
public long maxMemoryAllocationSize()

maxMemoryAllocationSize

public VkPhysicalDeviceMaintenance3Properties maxMemoryAllocationSize(@NativeType("VkDeviceSize") @Unsigned
 long 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