Record Class VkBindImageMemoryInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBindImageMemoryInfo

All Implemented Interfaces:

IPointer, IVkBindImageMemoryInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkBindImageMemoryInfo(@NotNull MemorySegment segment)
extends Record
implements IVkBindImageMemoryInfo

Represents a pointer to a VkBindImageMemoryInfo structure in native memory.

Structure

typedef struct VkBindImageMemoryInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkImage image;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
} VkBindImageMemoryInfo;

Auto initialization

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

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

• VkBindImageMemoryInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$image

PATH$memory

public static final MemoryLayout.PathElement PATH$memory

PATH$memoryOffset

public static final MemoryLayout.PathElement PATH$memoryOffset

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$image

public static final AddressLayout LAYOUT$image

LAYOUT$memory

public static final AddressLayout LAYOUT$memory

LAYOUT$memoryOffset

public static final ValueLayout.OfLong LAYOUT$memoryOffset

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$image

public static final long SIZE$image

SIZE$memory

public static final long SIZE$memory

SIZE$memoryOffset

public static final long SIZE$memoryOffset

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$image

public static final long OFFSET$image

OFFSET$memory

public static final long OFFSET$memory

OFFSET$memoryOffset

public static final long OFFSET$memoryOffset

Constructor Details

VkBindImageMemoryInfo

public VkBindImageMemoryInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBindImageMemoryInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBindImageMemoryInfo allocate(Arena arena)

allocate

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

clone

public static VkBindImageMemoryInfo clone(Arena arena,
 VkBindImageMemoryInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBindImageMemoryInfo pNext(@Nullable
 @Nullable IPointer pointer)

image

@Nullable
public @Nullable VkImage image()

image

public VkBindImageMemoryInfo image(@Nullable
 @Nullable VkImage value)

memory

@Nullable
public @Nullable VkDeviceMemory memory()

memory

public VkBindImageMemoryInfo memory(@Nullable
 @Nullable VkDeviceMemory value)

memoryOffset

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

memoryOffset

public VkBindImageMemoryInfo memoryOffset(@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