Record Class VkAcquireNextImageInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAcquireNextImageInfoKHR

All Implemented Interfaces:

IPointer, IVkAcquireNextImageInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkAcquireNextImageInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkAcquireNextImageInfoKHR

Represents a pointer to a VkAcquireNextImageInfoKHR structure in native memory.

Structure

typedef struct VkAcquireNextImageInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkSwapchainKHR swapchain;
    uint64_t timeout;
    VkSemaphore semaphore; // optional
    VkFence fence; // optional
    uint32_t deviceMask;
} VkAcquireNextImageInfoKHR;

Auto initialization

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

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

• VkAcquireNextImageInfoKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$deviceMask
static final AddressLayout	LAYOUT$fence
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$semaphore
static final ValueLayout.OfInt	LAYOUT$sType
static final AddressLayout	LAYOUT$swapchain
static final ValueLayout.OfLong	LAYOUT$timeout
static final long	OFFSET$deviceMask
static final long	OFFSET$fence
static final long	OFFSET$pNext
static final long	OFFSET$semaphore
static final long	OFFSET$sType
static final long	OFFSET$swapchain
static final long	OFFSET$timeout
static final MemoryLayout.PathElement	PATH$deviceMask
static final MemoryLayout.PathElement	PATH$fence
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$semaphore
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$swapchain
static final MemoryLayout.PathElement	PATH$timeout
static final long	SIZE$deviceMask
static final long	SIZE$fence
static final long	SIZE$pNext
static final long	SIZE$semaphore
static final long	SIZE$sType
static final long	SIZE$swapchain
static final long	SIZE$timeout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkAcquireNextImageInfoKHR	allocate(Arena arena)
static VkAcquireNextImageInfoKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkAcquireNextImageInfoKHR	clone(Arena arena, VkAcquireNextImageInfoKHR src)
int	deviceMask()
VkAcquireNextImageInfoKHR	deviceMask(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable VkFence	fence()
VkAcquireNextImageInfoKHR	fence(@Nullable VkFence value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	pNext()
VkAcquireNextImageInfoKHR	pNext(@Nullable IPointer pointer)
VkAcquireNextImageInfoKHR	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable VkSemaphore	semaphore()
VkAcquireNextImageInfoKHR	semaphore(@Nullable VkSemaphore value)
int	sType()
VkAcquireNextImageInfoKHR	sType(int value)
@Nullable VkSwapchainKHR	swapchain()
VkAcquireNextImageInfoKHR	swapchain(@Nullable VkSwapchainKHR value)
long	timeout()
VkAcquireNextImageInfoKHR	timeout(long 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$swapchain

public static final MemoryLayout.PathElement PATH$swapchain

PATH$timeout

public static final MemoryLayout.PathElement PATH$timeout

PATH$semaphore

public static final MemoryLayout.PathElement PATH$semaphore

PATH$fence

public static final MemoryLayout.PathElement PATH$fence

PATH$deviceMask

public static final MemoryLayout.PathElement PATH$deviceMask

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$swapchain

public static final AddressLayout LAYOUT$swapchain

LAYOUT$timeout

public static final ValueLayout.OfLong LAYOUT$timeout

LAYOUT$semaphore

public static final AddressLayout LAYOUT$semaphore

LAYOUT$fence

public static final AddressLayout LAYOUT$fence

LAYOUT$deviceMask

public static final ValueLayout.OfInt LAYOUT$deviceMask

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$swapchain

public static final long SIZE$swapchain

SIZE$timeout

public static final long SIZE$timeout

SIZE$semaphore

public static final long SIZE$semaphore

SIZE$fence

public static final long SIZE$fence

SIZE$deviceMask

public static final long SIZE$deviceMask

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$swapchain

public static final long OFFSET$swapchain

OFFSET$timeout

public static final long OFFSET$timeout

OFFSET$semaphore

public static final long OFFSET$semaphore

OFFSET$fence

public static final long OFFSET$fence

OFFSET$deviceMask

public static final long OFFSET$deviceMask

Constructor Details

VkAcquireNextImageInfoKHR

public VkAcquireNextImageInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAcquireNextImageInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAcquireNextImageInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkAcquireNextImageInfoKHR clone(Arena arena,
 VkAcquireNextImageInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkAcquireNextImageInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

swapchain

@Nullable
public @Nullable VkSwapchainKHR swapchain()

swapchain

public VkAcquireNextImageInfoKHR swapchain(@Nullable
 @Nullable VkSwapchainKHR value)

timeout

@Unsigned
public long timeout()

timeout

public VkAcquireNextImageInfoKHR timeout(@Unsigned
 long value)

semaphore

@Nullable
public @Nullable VkSemaphore semaphore()

semaphore

public VkAcquireNextImageInfoKHR semaphore(@Nullable
 @Nullable VkSemaphore value)

fence

@Nullable
public @Nullable VkFence fence()

fence

public VkAcquireNextImageInfoKHR fence(@Nullable
 @Nullable VkFence value)

deviceMask

@Unsigned
public int deviceMask()

deviceMask

public VkAcquireNextImageInfoKHR deviceMask(@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