Record Class VkPhysicalDeviceSurfaceInfo2KHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceSurfaceInfo2KHR

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceSurfaceInfo2KHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceSurfaceInfo2KHR(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceSurfaceInfo2KHR

Represents a pointer to a VkPhysicalDeviceSurfaceInfo2KHR structure in native memory.

Structure

typedef struct VkPhysicalDeviceSurfaceInfo2KHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkSurfaceKHR surface; // optional
} VkPhysicalDeviceSurfaceInfo2KHR;

Auto initialization

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

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

• VkPhysicalDeviceSurfaceInfo2KHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$surface

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$surface

public static final AddressLayout LAYOUT$surface

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$surface

public static final long SIZE$surface

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$surface

public static final long OFFSET$surface

Constructor Details

VkPhysicalDeviceSurfaceInfo2KHR

public VkPhysicalDeviceSurfaceInfo2KHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceSurfaceInfo2KHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceSurfaceInfo2KHR allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceSurfaceInfo2KHR clone(Arena arena,
 VkPhysicalDeviceSurfaceInfo2KHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDeviceSurfaceInfo2KHR pNext(@Nullable
 @Nullable IPointer pointer)

surface

@Nullable
public @Nullable VkSurfaceKHR surface()

surface

public VkPhysicalDeviceSurfaceInfo2KHR surface(@Nullable
 @Nullable VkSurfaceKHR 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