Record Class VkImageSubresource2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageSubresource2

All Implemented Interfaces:

IPointer, IVkImageSubresource2

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageSubresource2(@NotNull MemorySegment segment)
extends Record
implements IVkImageSubresource2

Represents a pointer to a VkImageSubresource2 structure in native memory.

Structure

typedef struct VkImageSubresource2 {
    VkStructureType sType;
    void* pNext; // optional
    VkImageSubresource imageSubresource;
} VkImageSubresource2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_IMAGE_SUBRESOURCE_2

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:

• VkImageSubresource2

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$imageSubresource

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$imageSubresource

public static final StructLayout LAYOUT$imageSubresource

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$imageSubresource

public static final long SIZE$imageSubresource

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$imageSubresource

public static final long OFFSET$imageSubresource

Constructor Details

VkImageSubresource2

public VkImageSubresource2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageSubresource2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageSubresource2 allocate(Arena arena)

allocate

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

clone

public static VkImageSubresource2 clone(Arena arena,
 VkImageSubresource2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkImageSubresource2 pNext(@Nullable
 @Nullable IPointer pointer)

imageSubresource

@NotNull
public @NotNull VkImageSubresource imageSubresource()

imageSubresource

public VkImageSubresource2 imageSubresource(@NotNull
 @NotNull VkImageSubresource value)

imageSubresource

public VkImageSubresource2 imageSubresource(Consumer<@NotNull VkImageSubresource> consumer)

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