Record Class VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

Represents a pointer to a VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV structure in native memory.

Structure

typedef struct VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV {
    VkStructureType sType;
    void* pNext; // optional
    VkDeviceSize extendedSparseAddressSpaceSize;
    VkImageUsageFlags extendedSparseImageUsageFlags;
    VkBufferUsageFlags extendedSparseBufferUsageFlags;
} VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_EXTENDED_SPARSE_ADDRESS_SPACE_PROPERTIES_NV

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:

• VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	allocate(Arena arena)
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	clone(Arena arena, VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	extendedSparseAddressSpaceSize()
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	extendedSparseAddressSpaceSize(long value)
int	extendedSparseBufferUsageFlags()
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	extendedSparseBufferUsageFlags(int value)
int	extendedSparseImageUsageFlags()
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	extendedSparseImageUsageFlags(int value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	pNext()
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	pNext(@Nullable IPointer pointer)
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV	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$extendedSparseAddressSpaceSize

public static final MemoryLayout.PathElement PATH$extendedSparseAddressSpaceSize

PATH$extendedSparseImageUsageFlags

public static final MemoryLayout.PathElement PATH$extendedSparseImageUsageFlags

PATH$extendedSparseBufferUsageFlags

public static final MemoryLayout.PathElement PATH$extendedSparseBufferUsageFlags

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$extendedSparseAddressSpaceSize

public static final ValueLayout.OfLong LAYOUT$extendedSparseAddressSpaceSize

LAYOUT$extendedSparseImageUsageFlags

public static final ValueLayout.OfInt LAYOUT$extendedSparseImageUsageFlags

LAYOUT$extendedSparseBufferUsageFlags

public static final ValueLayout.OfInt LAYOUT$extendedSparseBufferUsageFlags

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$extendedSparseAddressSpaceSize

public static final long SIZE$extendedSparseAddressSpaceSize

SIZE$extendedSparseImageUsageFlags

public static final long SIZE$extendedSparseImageUsageFlags

SIZE$extendedSparseBufferUsageFlags

public static final long SIZE$extendedSparseBufferUsageFlags

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$extendedSparseAddressSpaceSize

public static final long OFFSET$extendedSparseAddressSpaceSize

OFFSET$extendedSparseImageUsageFlags

public static final long OFFSET$extendedSparseImageUsageFlags

OFFSET$extendedSparseBufferUsageFlags

public static final long OFFSET$extendedSparseBufferUsageFlags

Constructor Details

VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV clone(Arena arena,
 VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV pNext(@Nullable
 @Nullable IPointer pointer)

extendedSparseAddressSpaceSize

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

extendedSparseAddressSpaceSize

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV extendedSparseAddressSpaceSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

extendedSparseImageUsageFlags

@Bitmask(VkImageUsageFlags.class)
public int extendedSparseImageUsageFlags()

extendedSparseImageUsageFlags

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV extendedSparseImageUsageFlags(@Bitmask(VkImageUsageFlags.class)
 int value)

extendedSparseBufferUsageFlags

@Bitmask(VkBufferUsageFlags.class)
public int extendedSparseBufferUsageFlags()

extendedSparseBufferUsageFlags

public VkPhysicalDeviceExtendedSparseAddressSpacePropertiesNV extendedSparseBufferUsageFlags(@Bitmask(VkBufferUsageFlags.class)
 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