Record Class VkMemoryMapInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkMemoryMapInfo

All Implemented Interfaces:

IPointer, IVkMemoryMapInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkMemoryMapInfo(@NotNull MemorySegment segment)
extends Record
implements IVkMemoryMapInfo

Represents a pointer to a VkMemoryMapInfo structure in native memory.

Structure

typedef struct VkMemoryMapInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkMemoryMapFlags flags; // optional
    VkDeviceMemory memory;
    VkDeviceSize offset;
    VkDeviceSize size;
} VkMemoryMapInfo;

Auto initialization

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

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

• VkMemoryMapInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$flags

PATH$memory

public static final MemoryLayout.PathElement PATH$memory

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$size

public static final MemoryLayout.PathElement PATH$size

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$memory

public static final AddressLayout LAYOUT$memory

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$flags

public static final long SIZE$flags

SIZE$memory

public static final long SIZE$memory

SIZE$offset

public static final long SIZE$offset

SIZE$size

public static final long SIZE$size

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$flags

public static final long OFFSET$flags

OFFSET$memory

public static final long OFFSET$memory

OFFSET$offset

public static final long OFFSET$offset

OFFSET$size

public static final long OFFSET$size

Constructor Details

VkMemoryMapInfo

public VkMemoryMapInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkMemoryMapInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkMemoryMapInfo allocate(Arena arena)

allocate

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

clone

public static VkMemoryMapInfo clone(Arena arena,
 VkMemoryMapInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkMemoryMapInfo pNext(@Nullable
 @Nullable IPointer pointer)

flags

@EnumType(VkMemoryMapFlags.class)
public int flags()

flags

public VkMemoryMapInfo flags(@EnumType(VkMemoryMapFlags.class)
 int value)

memory

@Nullable
public @Nullable VkDeviceMemory memory()

memory

public VkMemoryMapInfo memory(@Nullable
 @Nullable VkDeviceMemory value)

offset

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

offset

public VkMemoryMapInfo offset(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

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

size

public VkMemoryMapInfo size(@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