Record Class VkSurfacePresentModeEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSurfacePresentModeEXT

All Implemented Interfaces:

IPointer, IVkSurfacePresentModeEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkSurfacePresentModeEXT(@NotNull MemorySegment segment)
extends Record
implements IVkSurfacePresentModeEXT

Represents a pointer to a VkSurfacePresentModeEXT structure in native memory.

Structure

typedef struct VkSurfacePresentModeEXT {
    VkStructureType sType;
    void* pNext; // optional
    VkPresentModeKHR presentMode;
} VkSurfacePresentModeEXT;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SURFACE_PRESENT_MODE_EXT

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:

• VkSurfacePresentModeEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$presentMode

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$presentMode

public static final ValueLayout.OfInt LAYOUT$presentMode

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$presentMode

public static final long SIZE$presentMode

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$presentMode

public static final long OFFSET$presentMode

Constructor Details

VkSurfacePresentModeEXT

public VkSurfacePresentModeEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSurfacePresentModeEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSurfacePresentModeEXT allocate(Arena arena)

allocate

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

clone

public static VkSurfacePresentModeEXT clone(Arena arena,
 VkSurfacePresentModeEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSurfacePresentModeEXT pNext(@Nullable
 @Nullable IPointer pointer)

presentMode

@EnumType(VkPresentModeKHR.class)
public int presentMode()

presentMode

public VkSurfacePresentModeEXT presentMode(@EnumType(VkPresentModeKHR.class)
 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