Record Class VkRenderingInputAttachmentIndexInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkRenderingInputAttachmentIndexInfo

All Implemented Interfaces:

IPointer, IVkRenderingInputAttachmentIndexInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkRenderingInputAttachmentIndexInfo(@NotNull MemorySegment segment)
extends Record
implements IVkRenderingInputAttachmentIndexInfo

Represents a pointer to a VkRenderingInputAttachmentIndexInfo structure in native memory.

Structure

typedef struct VkRenderingInputAttachmentIndexInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t colorAttachmentCount; // optional
    uint32_t const* pColorAttachmentInputIndices; // optional
    uint32_t const* pDepthInputAttachmentIndex; // optional
    uint32_t const* pStencilInputAttachmentIndex; // optional
} VkRenderingInputAttachmentIndexInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO

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:

• VkRenderingInputAttachmentIndexInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderingInputAttachmentIndexInfo	allocate(Arena arena)
static VkRenderingInputAttachmentIndexInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkRenderingInputAttachmentIndexInfo	clone(Arena arena, VkRenderingInputAttachmentIndexInfo src)
int	colorAttachmentCount()
VkRenderingInputAttachmentIndexInfo	colorAttachmentCount(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 IntPtr	pColorAttachmentInputIndices()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderingInputAttachmentIndexInfo	pColorAttachmentInputIndices(@Nullable IntPtr value)
@NotNull MemorySegment	pColorAttachmentInputIndicesRaw()
void	pColorAttachmentInputIndicesRaw(@NotNull MemorySegment value)
@Nullable IntPtr	pDepthInputAttachmentIndex()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderingInputAttachmentIndexInfo	pDepthInputAttachmentIndex(@Nullable IntPtr value)
@NotNull MemorySegment	pDepthInputAttachmentIndexRaw()
void	pDepthInputAttachmentIndexRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkRenderingInputAttachmentIndexInfo	pNext(@Nullable IPointer pointer)
VkRenderingInputAttachmentIndexInfo	pNext(@NotNull MemorySegment value)
@Nullable IntPtr	pStencilInputAttachmentIndex()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderingInputAttachmentIndexInfo	pStencilInputAttachmentIndex(@Nullable IntPtr value)
@NotNull MemorySegment	pStencilInputAttachmentIndexRaw()
void	pStencilInputAttachmentIndexRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkRenderingInputAttachmentIndexInfo	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$colorAttachmentCount

public static final MemoryLayout.PathElement PATH$colorAttachmentCount

PATH$pColorAttachmentInputIndices

public static final MemoryLayout.PathElement PATH$pColorAttachmentInputIndices

PATH$pDepthInputAttachmentIndex

public static final MemoryLayout.PathElement PATH$pDepthInputAttachmentIndex

PATH$pStencilInputAttachmentIndex

public static final MemoryLayout.PathElement PATH$pStencilInputAttachmentIndex

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$colorAttachmentCount

public static final ValueLayout.OfInt LAYOUT$colorAttachmentCount

LAYOUT$pColorAttachmentInputIndices

public static final AddressLayout LAYOUT$pColorAttachmentInputIndices

LAYOUT$pDepthInputAttachmentIndex

public static final AddressLayout LAYOUT$pDepthInputAttachmentIndex

LAYOUT$pStencilInputAttachmentIndex

public static final AddressLayout LAYOUT$pStencilInputAttachmentIndex

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$colorAttachmentCount

public static final long SIZE$colorAttachmentCount

SIZE$pColorAttachmentInputIndices

public static final long SIZE$pColorAttachmentInputIndices

SIZE$pDepthInputAttachmentIndex

public static final long SIZE$pDepthInputAttachmentIndex

SIZE$pStencilInputAttachmentIndex

public static final long SIZE$pStencilInputAttachmentIndex

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$colorAttachmentCount

public static final long OFFSET$colorAttachmentCount

OFFSET$pColorAttachmentInputIndices

public static final long OFFSET$pColorAttachmentInputIndices

OFFSET$pDepthInputAttachmentIndex

public static final long OFFSET$pDepthInputAttachmentIndex

OFFSET$pStencilInputAttachmentIndex

public static final long OFFSET$pStencilInputAttachmentIndex

Constructor Details

VkRenderingInputAttachmentIndexInfo

public VkRenderingInputAttachmentIndexInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkRenderingInputAttachmentIndexInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkRenderingInputAttachmentIndexInfo allocate(Arena arena)

allocate

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

clone

public static VkRenderingInputAttachmentIndexInfo clone(Arena arena,
 VkRenderingInputAttachmentIndexInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkRenderingInputAttachmentIndexInfo pNext(@Nullable
 @Nullable IPointer pointer)

colorAttachmentCount

@Unsigned
public int colorAttachmentCount()

colorAttachmentCount

public VkRenderingInputAttachmentIndexInfo colorAttachmentCount(@Unsigned
 int value)

pColorAttachmentInputIndices

@Nullable
@Unsigned
public @Nullable IntPtr pColorAttachmentInputIndices()

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.

pColorAttachmentInputIndices

public VkRenderingInputAttachmentIndexInfo pColorAttachmentInputIndices(@Nullable @Unsigned
 @Nullable IntPtr value)

pColorAttachmentInputIndicesRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment pColorAttachmentInputIndicesRaw()

pColorAttachmentInputIndicesRaw

public void pColorAttachmentInputIndicesRaw(@Pointer(comment="uint32_t*") @NotNull
 @NotNull MemorySegment value)

pDepthInputAttachmentIndex

@Nullable
@Unsigned
public @Nullable IntPtr pDepthInputAttachmentIndex()

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.

pDepthInputAttachmentIndex

public VkRenderingInputAttachmentIndexInfo pDepthInputAttachmentIndex(@Nullable @Unsigned
 @Nullable IntPtr value)

pDepthInputAttachmentIndexRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment pDepthInputAttachmentIndexRaw()

pDepthInputAttachmentIndexRaw

public void pDepthInputAttachmentIndexRaw(@Pointer(comment="uint32_t*") @NotNull
 @NotNull MemorySegment value)

pStencilInputAttachmentIndex

@Nullable
@Unsigned
public @Nullable IntPtr pStencilInputAttachmentIndex()

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.

pStencilInputAttachmentIndex

public VkRenderingInputAttachmentIndexInfo pStencilInputAttachmentIndex(@Nullable @Unsigned
 @Nullable IntPtr value)

pStencilInputAttachmentIndexRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment pStencilInputAttachmentIndexRaw()

pStencilInputAttachmentIndexRaw

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