Record Class VkDisplayPresentInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDisplayPresentInfoKHR

All Implemented Interfaces:

IPointer, IVkDisplayPresentInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkDisplayPresentInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkDisplayPresentInfoKHR

Represents a pointer to a VkDisplayPresentInfoKHR structure in native memory.

Structure

typedef struct VkDisplayPresentInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkRect2D srcRect;
    VkRect2D dstRect;
    VkBool32 persistent;
} VkDisplayPresentInfoKHR;

Auto initialization

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

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

• VkDisplayPresentInfoKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDisplayPresentInfoKHR.Ptr	Represents a pointer to / an array of VkDisplayPresentInfoKHR structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$dstRect
static final ValueLayout.OfInt	LAYOUT$persistent
static final AddressLayout	LAYOUT$pNext
static final StructLayout	LAYOUT$srcRect
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$dstRect
static final long	OFFSET$persistent
static final long	OFFSET$pNext
static final long	OFFSET$srcRect
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$dstRect
static final MemoryLayout.PathElement	PATH$persistent
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$srcRect
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$dstRect
static final long	SIZE$persistent
static final long	SIZE$pNext
static final long	SIZE$srcRect
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$srcRect

PATH$dstRect

public static final MemoryLayout.PathElement PATH$dstRect

PATH$persistent

public static final MemoryLayout.PathElement PATH$persistent

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcRect

public static final StructLayout LAYOUT$srcRect

LAYOUT$dstRect

public static final StructLayout LAYOUT$dstRect

LAYOUT$persistent

public static final ValueLayout.OfInt LAYOUT$persistent

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcRect

public static final long SIZE$srcRect

SIZE$dstRect

public static final long SIZE$dstRect

SIZE$persistent

public static final long SIZE$persistent

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcRect

public static final long OFFSET$srcRect

OFFSET$dstRect

public static final long OFFSET$dstRect

OFFSET$persistent

public static final long OFFSET$persistent

Constructor Details

VkDisplayPresentInfoKHR

public VkDisplayPresentInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDisplayPresentInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDisplayPresentInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkDisplayPresentInfoKHR clone(Arena arena,
 VkDisplayPresentInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDisplayPresentInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

srcRect

@NotNull
public @NotNull VkRect2D srcRect()

srcRect

public VkDisplayPresentInfoKHR srcRect(@NotNull
 @NotNull VkRect2D value)

srcRect

public VkDisplayPresentInfoKHR srcRect(Consumer<@NotNull VkRect2D> consumer)

dstRect

@NotNull
public @NotNull VkRect2D dstRect()

dstRect

public VkDisplayPresentInfoKHR dstRect(@NotNull
 @NotNull VkRect2D value)

dstRect

public VkDisplayPresentInfoKHR dstRect(Consumer<@NotNull VkRect2D> consumer)

persistent

@NativeType("VkBool32")
@Unsigned
public int persistent()

persistent

public VkDisplayPresentInfoKHR persistent(@NativeType("VkBool32") @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