Record Class VkImageViewHandleInfoNVX

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageViewHandleInfoNVX

All Implemented Interfaces:

IPointer, IVkImageViewHandleInfoNVX

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageViewHandleInfoNVX(@NotNull MemorySegment segment)
extends Record
implements IVkImageViewHandleInfoNVX

Represents a pointer to a VkImageViewHandleInfoNVX structure in native memory.

Structure

typedef struct VkImageViewHandleInfoNVX {
    VkStructureType sType;
    void const* pNext; // optional
    VkImageView imageView;
    VkDescriptorType descriptorType;
    VkSampler sampler; // optional
} VkImageViewHandleInfoNVX;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_HANDLE_INFO_NVX

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:

• VkImageViewHandleInfoNVX

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageViewHandleInfoNVX	allocate(Arena arena)
static VkImageViewHandleInfoNVX.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkImageViewHandleInfoNVX	clone(Arena arena, VkImageViewHandleInfoNVX src)
int	descriptorType()
VkImageViewHandleInfoNVX	descriptorType(int value)
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.
@Nullable VkImageView	imageView()
VkImageViewHandleInfoNVX	imageView(@Nullable VkImageView value)
MemorySegment	pNext()
VkImageViewHandleInfoNVX	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@Nullable VkSampler	sampler()
VkImageViewHandleInfoNVX	sampler(@Nullable VkSampler value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkImageViewHandleInfoNVX	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$imageView

public static final MemoryLayout.PathElement PATH$imageView

PATH$descriptorType

public static final MemoryLayout.PathElement PATH$descriptorType

PATH$sampler

public static final MemoryLayout.PathElement PATH$sampler

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$imageView

public static final AddressLayout LAYOUT$imageView

LAYOUT$descriptorType

public static final ValueLayout.OfInt LAYOUT$descriptorType

LAYOUT$sampler

public static final AddressLayout LAYOUT$sampler

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$imageView

public static final long SIZE$imageView

SIZE$descriptorType

public static final long SIZE$descriptorType

SIZE$sampler

public static final long SIZE$sampler

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$imageView

public static final long OFFSET$imageView

OFFSET$descriptorType

public static final long OFFSET$descriptorType

OFFSET$sampler

public static final long OFFSET$sampler

Constructor Details

VkImageViewHandleInfoNVX

public VkImageViewHandleInfoNVX(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageViewHandleInfoNVX record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageViewHandleInfoNVX allocate(Arena arena)

allocate

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

clone

public static VkImageViewHandleInfoNVX clone(Arena arena,
 VkImageViewHandleInfoNVX src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkImageViewHandleInfoNVX pNext(@Nullable
 @Nullable IPointer pointer)

imageView

@Nullable
public @Nullable VkImageView imageView()

imageView

public VkImageViewHandleInfoNVX imageView(@Nullable
 @Nullable VkImageView value)

descriptorType

@EnumType(VkDescriptorType.class)
public int descriptorType()

descriptorType

public VkImageViewHandleInfoNVX descriptorType(@EnumType(VkDescriptorType.class)
 int value)

sampler

@Nullable
public @Nullable VkSampler sampler()

sampler

public VkImageViewHandleInfoNVX sampler(@Nullable
 @Nullable VkSampler 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