Record Class VkDescriptorAddressInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDescriptorAddressInfoEXT

All Implemented Interfaces:

IPointer, IVkDescriptorAddressInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkDescriptorAddressInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkDescriptorAddressInfoEXT

Represents a pointer to a VkDescriptorAddressInfoEXT structure in native memory.

Structure

typedef struct VkDescriptorAddressInfoEXT {
    VkStructureType sType;
    void* pNext; // optional
    VkDeviceAddress address;
    VkDeviceSize range;
    VkFormat format;
} VkDescriptorAddressInfoEXT;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_DESCRIPTOR_ADDRESS_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:

• VkDescriptorAddressInfoEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$address

PATH$range

public static final MemoryLayout.PathElement PATH$range

PATH$format

public static final MemoryLayout.PathElement PATH$format

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$address

public static final ValueLayout.OfLong LAYOUT$address

LAYOUT$range

public static final ValueLayout.OfLong LAYOUT$range

LAYOUT$format

public static final ValueLayout.OfInt LAYOUT$format

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$address

public static final long SIZE$address

SIZE$range

public static final long SIZE$range

SIZE$format

public static final long SIZE$format

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$address

public static final long OFFSET$address

OFFSET$range

public static final long OFFSET$range

OFFSET$format

public static final long OFFSET$format

Constructor Details

VkDescriptorAddressInfoEXT

public VkDescriptorAddressInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDescriptorAddressInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDescriptorAddressInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkDescriptorAddressInfoEXT clone(Arena arena,
 VkDescriptorAddressInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDescriptorAddressInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

address

@NativeType("VkDeviceAddress")
@Unsigned
public long address()

address

public VkDescriptorAddressInfoEXT address(@NativeType("VkDeviceAddress") @Unsigned
 long value)

range

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

range

public VkDescriptorAddressInfoEXT range(@NativeType("VkDeviceSize") @Unsigned
 long value)

format

@EnumType(VkFormat.class)
public int format()

format

public VkDescriptorAddressInfoEXT format(@EnumType(VkFormat.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