Record Class VkSetPresentConfigNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSetPresentConfigNV

All Implemented Interfaces:

IPointer, IVkSetPresentConfigNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkSetPresentConfigNV(@NotNull MemorySegment segment)
extends Record
implements IVkSetPresentConfigNV

Represents a pointer to a VkSetPresentConfigNV structure in native memory.

Structure

typedef struct VkSetPresentConfigNV {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t numFramesPerBatch;
    uint32_t presentConfigFeedback;
} VkSetPresentConfigNV;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SET_PRESENT_CONFIG_NV

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:

• VkSetPresentConfigNV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$numFramesPerBatch

PATH$presentConfigFeedback

public static final MemoryLayout.PathElement PATH$presentConfigFeedback

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$numFramesPerBatch

public static final ValueLayout.OfInt LAYOUT$numFramesPerBatch

LAYOUT$presentConfigFeedback

public static final ValueLayout.OfInt LAYOUT$presentConfigFeedback

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$numFramesPerBatch

public static final long SIZE$numFramesPerBatch

SIZE$presentConfigFeedback

public static final long SIZE$presentConfigFeedback

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$numFramesPerBatch

public static final long OFFSET$numFramesPerBatch

OFFSET$presentConfigFeedback

public static final long OFFSET$presentConfigFeedback

Constructor Details

VkSetPresentConfigNV

public VkSetPresentConfigNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSetPresentConfigNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSetPresentConfigNV allocate(Arena arena)

allocate

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

clone

public static VkSetPresentConfigNV clone(Arena arena,
 VkSetPresentConfigNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSetPresentConfigNV pNext(@Nullable
 @Nullable IPointer pointer)

numFramesPerBatch

@Unsigned
public int numFramesPerBatch()

numFramesPerBatch

public VkSetPresentConfigNV numFramesPerBatch(@Unsigned
 int value)

presentConfigFeedback

@Unsigned
public int presentConfigFeedback()

presentConfigFeedback

public VkSetPresentConfigNV presentConfigFeedback(@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