Record Class VkPresentRegionsKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPresentRegionsKHR

All Implemented Interfaces:

IPointer, IVkPresentRegionsKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPresentRegionsKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPresentRegionsKHR

Represents a pointer to a VkPresentRegionsKHR structure in native memory.

Structure

typedef struct VkPresentRegionsKHR {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t swapchainCount;
    VkPresentRegionKHR const* pRegions;
} VkPresentRegionsKHR;

Auto initialization

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

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

• VkPresentRegionsKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$swapchainCount

PATH$pRegions

public static final MemoryLayout.PathElement PATH$pRegions

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$swapchainCount

public static final ValueLayout.OfInt LAYOUT$swapchainCount

LAYOUT$pRegions

public static final AddressLayout LAYOUT$pRegions

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$swapchainCount

public static final long SIZE$swapchainCount

SIZE$pRegions

public static final long SIZE$pRegions

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$swapchainCount

public static final long OFFSET$swapchainCount

OFFSET$pRegions

public static final long OFFSET$pRegions

Constructor Details

VkPresentRegionsKHR

public VkPresentRegionsKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPresentRegionsKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPresentRegionsKHR allocate(Arena arena)

allocate

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

clone

public static VkPresentRegionsKHR clone(Arena arena,
 VkPresentRegionsKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPresentRegionsKHR pNext(@Nullable
 @Nullable IPointer pointer)

swapchainCount

@Unsigned
public int swapchainCount()

swapchainCount

public VkPresentRegionsKHR swapchainCount(@Unsigned
 int value)

pRegions

public VkPresentRegionsKHR pRegions(@Nullable
 @Nullable IVkPresentRegionKHR value)

pRegions

@Unsafe
@Nullable
public VkPresentRegionKHR.Ptr pRegions(int assumedCount)

pRegions

@Nullable
public @Nullable VkPresentRegionKHR pRegions()

pRegionsRaw

@Pointer(target=VkPresentRegionKHR.class)
@NotNull
public @NotNull MemorySegment pRegionsRaw()

pRegionsRaw

public void pRegionsRaw(@Pointer(target=VkPresentRegionKHR.class) @NotNull
 @NotNull MemorySegment 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