Record Class VkReleaseSwapchainImagesInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkReleaseSwapchainImagesInfoEXT

All Implemented Interfaces:

IPointer, IVkReleaseSwapchainImagesInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkReleaseSwapchainImagesInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkReleaseSwapchainImagesInfoEXT

Represents a pointer to a VkReleaseSwapchainImagesInfoEXT structure in native memory.

Structure

typedef struct VkReleaseSwapchainImagesInfoEXT {
    VkStructureType sType;
    void const* pNext; // optional
    VkSwapchainKHR swapchain;
    uint32_t imageIndexCount;
    uint32_t const* pImageIndices;
} VkReleaseSwapchainImagesInfoEXT;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_RELEASE_SWAPCHAIN_IMAGES_INFO_EXT

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:

• VkReleaseSwapchainImagesInfoEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkReleaseSwapchainImagesInfoEXT	allocate(Arena arena)
static VkReleaseSwapchainImagesInfoEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkReleaseSwapchainImagesInfoEXT	clone(Arena arena, VkReleaseSwapchainImagesInfoEXT 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.
int	imageIndexCount()
VkReleaseSwapchainImagesInfoEXT	imageIndexCount(int value)
@Nullable IntPtr	pImageIndices()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkReleaseSwapchainImagesInfoEXT	pImageIndices(@Nullable IntPtr value)
MemorySegment	pImageIndicesRaw()
void	pImageIndicesRaw(MemorySegment value)
MemorySegment	pNext()
VkReleaseSwapchainImagesInfoEXT	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkReleaseSwapchainImagesInfoEXT	sType(int value)
@Nullable VkSwapchainKHR	swapchain()
VkReleaseSwapchainImagesInfoEXT	swapchain(@Nullable VkSwapchainKHR 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$imageIndexCount

public static final MemoryLayout.PathElement PATH$imageIndexCount

PATH$pImageIndices

public static final MemoryLayout.PathElement PATH$pImageIndices

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$imageIndexCount

public static final ValueLayout.OfInt LAYOUT$imageIndexCount

LAYOUT$pImageIndices

public static final AddressLayout LAYOUT$pImageIndices

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$imageIndexCount

public static final long SIZE$imageIndexCount

SIZE$pImageIndices

public static final long SIZE$pImageIndices

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$imageIndexCount

public static final long OFFSET$imageIndexCount

OFFSET$pImageIndices

public static final long OFFSET$pImageIndices

Constructor Details

VkReleaseSwapchainImagesInfoEXT

public VkReleaseSwapchainImagesInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkReleaseSwapchainImagesInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkReleaseSwapchainImagesInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkReleaseSwapchainImagesInfoEXT clone(Arena arena,
 VkReleaseSwapchainImagesInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkReleaseSwapchainImagesInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

swapchain

@Nullable
public @Nullable VkSwapchainKHR swapchain()

swapchain

public VkReleaseSwapchainImagesInfoEXT swapchain(@Nullable
 @Nullable VkSwapchainKHR value)

imageIndexCount

@Unsigned
public int imageIndexCount()

imageIndexCount

public VkReleaseSwapchainImagesInfoEXT imageIndexCount(@Unsigned
 int value)

pImageIndices

@Nullable
@Unsigned
public @Nullable IntPtr pImageIndices()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pImageIndices

public VkReleaseSwapchainImagesInfoEXT pImageIndices(@Nullable @Unsigned
 @Nullable IntPtr value)

pImageIndicesRaw

@Pointer(comment="uint32_t*")
public MemorySegment pImageIndicesRaw()

pImageIndicesRaw

public void pImageIndicesRaw(@Pointer(comment="uint32_t*")
 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