Record Class VkBindImageMemoryDeviceGroupInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBindImageMemoryDeviceGroupInfo

All Implemented Interfaces:

IPointer, IVkBindImageMemoryDeviceGroupInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkBindImageMemoryDeviceGroupInfo(@NotNull MemorySegment segment)
extends Record
implements IVkBindImageMemoryDeviceGroupInfo

Represents a pointer to a VkBindImageMemoryDeviceGroupInfo structure in native memory.

Structure

typedef struct VkBindImageMemoryDeviceGroupInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t deviceIndexCount; // optional
    uint32_t const* pDeviceIndices;
    uint32_t splitInstanceBindRegionCount; // optional
    VkRect2D const* pSplitInstanceBindRegions;
} VkBindImageMemoryDeviceGroupInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO

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:

• VkBindImageMemoryDeviceGroupInfo

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$deviceIndexCount
static final AddressLayout	LAYOUT$pDeviceIndices
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pSplitInstanceBindRegions
static final ValueLayout.OfInt	LAYOUT$splitInstanceBindRegionCount
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$deviceIndexCount
static final long	OFFSET$pDeviceIndices
static final long	OFFSET$pNext
static final long	OFFSET$pSplitInstanceBindRegions
static final long	OFFSET$splitInstanceBindRegionCount
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$deviceIndexCount
static final MemoryLayout.PathElement	PATH$pDeviceIndices
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pSplitInstanceBindRegions
static final MemoryLayout.PathElement	PATH$splitInstanceBindRegionCount
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$deviceIndexCount
static final long	SIZE$pDeviceIndices
static final long	SIZE$pNext
static final long	SIZE$pSplitInstanceBindRegions
static final long	SIZE$splitInstanceBindRegionCount
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBindImageMemoryDeviceGroupInfo	allocate(Arena arena)
static VkBindImageMemoryDeviceGroupInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkBindImageMemoryDeviceGroupInfo	clone(Arena arena, VkBindImageMemoryDeviceGroupInfo src)
int	deviceIndexCount()
VkBindImageMemoryDeviceGroupInfo	deviceIndexCount(int value)
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.
@Nullable IntPtr	pDeviceIndices()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkBindImageMemoryDeviceGroupInfo	pDeviceIndices(@Nullable IntPtr value)
MemorySegment	pDeviceIndicesRaw()
void	pDeviceIndicesRaw(MemorySegment value)
MemorySegment	pNext()
VkBindImageMemoryDeviceGroupInfo	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@Nullable VkRect2D	pSplitInstanceBindRegions()
VkRect2D.Ptr	pSplitInstanceBindRegions(int assumedCount)
VkBindImageMemoryDeviceGroupInfo	pSplitInstanceBindRegions(@Nullable IVkRect2D value)
MemorySegment	pSplitInstanceBindRegionsRaw()
void	pSplitInstanceBindRegionsRaw(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	splitInstanceBindRegionCount()
VkBindImageMemoryDeviceGroupInfo	splitInstanceBindRegionCount(int value)
int	sType()
VkBindImageMemoryDeviceGroupInfo	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$deviceIndexCount

public static final MemoryLayout.PathElement PATH$deviceIndexCount

PATH$pDeviceIndices

public static final MemoryLayout.PathElement PATH$pDeviceIndices

PATH$splitInstanceBindRegionCount

public static final MemoryLayout.PathElement PATH$splitInstanceBindRegionCount

PATH$pSplitInstanceBindRegions

public static final MemoryLayout.PathElement PATH$pSplitInstanceBindRegions

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$deviceIndexCount

public static final ValueLayout.OfInt LAYOUT$deviceIndexCount

LAYOUT$pDeviceIndices

public static final AddressLayout LAYOUT$pDeviceIndices

LAYOUT$splitInstanceBindRegionCount

public static final ValueLayout.OfInt LAYOUT$splitInstanceBindRegionCount

LAYOUT$pSplitInstanceBindRegions

public static final AddressLayout LAYOUT$pSplitInstanceBindRegions

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$deviceIndexCount

public static final long SIZE$deviceIndexCount

SIZE$pDeviceIndices

public static final long SIZE$pDeviceIndices

SIZE$splitInstanceBindRegionCount

public static final long SIZE$splitInstanceBindRegionCount

SIZE$pSplitInstanceBindRegions

public static final long SIZE$pSplitInstanceBindRegions

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$deviceIndexCount

public static final long OFFSET$deviceIndexCount

OFFSET$pDeviceIndices

public static final long OFFSET$pDeviceIndices

OFFSET$splitInstanceBindRegionCount

public static final long OFFSET$splitInstanceBindRegionCount

OFFSET$pSplitInstanceBindRegions

public static final long OFFSET$pSplitInstanceBindRegions

Constructor Details

VkBindImageMemoryDeviceGroupInfo

public VkBindImageMemoryDeviceGroupInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBindImageMemoryDeviceGroupInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBindImageMemoryDeviceGroupInfo allocate(Arena arena)

allocate

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

clone

public static VkBindImageMemoryDeviceGroupInfo clone(Arena arena,
 VkBindImageMemoryDeviceGroupInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBindImageMemoryDeviceGroupInfo pNext(@Nullable
 @Nullable IPointer pointer)

deviceIndexCount

@Unsigned
public int deviceIndexCount()

deviceIndexCount

public VkBindImageMemoryDeviceGroupInfo deviceIndexCount(@Unsigned
 int value)

pDeviceIndices

@Nullable
@Unsigned
public @Nullable IntPtr pDeviceIndices()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pDeviceIndices

public VkBindImageMemoryDeviceGroupInfo pDeviceIndices(@Nullable @Unsigned
 @Nullable IntPtr value)

pDeviceIndicesRaw

@Pointer(comment="uint32_t*")
public MemorySegment pDeviceIndicesRaw()

pDeviceIndicesRaw

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

splitInstanceBindRegionCount

@Unsigned
public int splitInstanceBindRegionCount()

splitInstanceBindRegionCount

public VkBindImageMemoryDeviceGroupInfo splitInstanceBindRegionCount(@Unsigned
 int value)

pSplitInstanceBindRegions

public VkBindImageMemoryDeviceGroupInfo pSplitInstanceBindRegions(@Nullable
 @Nullable IVkRect2D value)

pSplitInstanceBindRegions

@Unsafe
@Nullable
public VkRect2D.Ptr pSplitInstanceBindRegions(int assumedCount)

pSplitInstanceBindRegions

@Nullable
public @Nullable VkRect2D pSplitInstanceBindRegions()

pSplitInstanceBindRegionsRaw

@Pointer(target=VkRect2D.class)
public MemorySegment pSplitInstanceBindRegionsRaw()

pSplitInstanceBindRegionsRaw

public void pSplitInstanceBindRegionsRaw(@Pointer(target=VkRect2D.class)
 MemorySegment 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