Record Class VkSurfaceFormat2KHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSurfaceFormat2KHR

All Implemented Interfaces:

IPointer, IVkSurfaceFormat2KHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkSurfaceFormat2KHR(@NotNull MemorySegment segment)
extends Record
implements IVkSurfaceFormat2KHR

Represents a pointer to a VkSurfaceFormat2KHR structure in native memory.

Structure

typedef struct VkSurfaceFormat2KHR {
    VkStructureType sType;
    void* pNext; // optional
    VkSurfaceFormatKHR surfaceFormat;
} VkSurfaceFormat2KHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SURFACE_FORMAT_2_KHR

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:

• VkSurfaceFormat2KHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$surfaceFormat

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$surfaceFormat

public static final StructLayout LAYOUT$surfaceFormat

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$surfaceFormat

public static final long SIZE$surfaceFormat

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$surfaceFormat

public static final long OFFSET$surfaceFormat

Constructor Details

VkSurfaceFormat2KHR

public VkSurfaceFormat2KHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSurfaceFormat2KHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSurfaceFormat2KHR allocate(Arena arena)

allocate

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

clone

public static VkSurfaceFormat2KHR clone(Arena arena,
 VkSurfaceFormat2KHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSurfaceFormat2KHR pNext(@Nullable
 @Nullable IPointer pointer)

surfaceFormat

@NotNull
public @NotNull VkSurfaceFormatKHR surfaceFormat()

surfaceFormat

public VkSurfaceFormat2KHR surfaceFormat(@NotNull
 @NotNull VkSurfaceFormatKHR value)

surfaceFormat

public VkSurfaceFormat2KHR surfaceFormat(Consumer<@NotNull VkSurfaceFormatKHR> consumer)

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