Record Class VkMemoryDedicatedRequirements

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkMemoryDedicatedRequirements

All Implemented Interfaces:

IPointer, IVkMemoryDedicatedRequirements

@ValueBasedCandidate
@UnsafeConstructor
public record VkMemoryDedicatedRequirements(@NotNull MemorySegment segment)
extends Record
implements IVkMemoryDedicatedRequirements

Represents a pointer to a VkMemoryDedicatedRequirements structure in native memory.

Structure

typedef struct VkMemoryDedicatedRequirements {
    VkStructureType sType;
    void* pNext; // optional
    VkBool32 prefersDedicatedAllocation;
    VkBool32 requiresDedicatedAllocation;
} VkMemoryDedicatedRequirements;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_MEMORY_DEDICATED_REQUIREMENTS

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:

• VkMemoryDedicatedRequirements

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$prefersDedicatedAllocation

PATH$requiresDedicatedAllocation

public static final MemoryLayout.PathElement PATH$requiresDedicatedAllocation

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$prefersDedicatedAllocation

public static final ValueLayout.OfInt LAYOUT$prefersDedicatedAllocation

LAYOUT$requiresDedicatedAllocation

public static final ValueLayout.OfInt LAYOUT$requiresDedicatedAllocation

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$prefersDedicatedAllocation

public static final long SIZE$prefersDedicatedAllocation

SIZE$requiresDedicatedAllocation

public static final long SIZE$requiresDedicatedAllocation

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$prefersDedicatedAllocation

public static final long OFFSET$prefersDedicatedAllocation

OFFSET$requiresDedicatedAllocation

public static final long OFFSET$requiresDedicatedAllocation

Constructor Details

VkMemoryDedicatedRequirements

public VkMemoryDedicatedRequirements(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkMemoryDedicatedRequirements record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkMemoryDedicatedRequirements allocate(Arena arena)

allocate

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

clone

public static VkMemoryDedicatedRequirements clone(Arena arena,
 VkMemoryDedicatedRequirements src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkMemoryDedicatedRequirements pNext(@Nullable
 @Nullable IPointer pointer)

prefersDedicatedAllocation

@NativeType("VkBool32")
@Unsigned
public int prefersDedicatedAllocation()

prefersDedicatedAllocation

public VkMemoryDedicatedRequirements prefersDedicatedAllocation(@NativeType("VkBool32") @Unsigned
 int value)

requiresDedicatedAllocation

@NativeType("VkBool32")
@Unsigned
public int requiresDedicatedAllocation()

requiresDedicatedAllocation

public VkMemoryDedicatedRequirements requiresDedicatedAllocation(@NativeType("VkBool32") @Unsigned
 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