Record Class VkRenderingAttachmentLocationInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkRenderingAttachmentLocationInfo

All Implemented Interfaces:

IPointer, IVkRenderingAttachmentLocationInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkRenderingAttachmentLocationInfo(@NotNull MemorySegment segment)
extends Record
implements IVkRenderingAttachmentLocationInfo

Represents a pointer to a VkRenderingAttachmentLocationInfo structure in native memory.

Structure

typedef struct VkRenderingAttachmentLocationInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t colorAttachmentCount; // optional
    uint32_t const* pColorAttachmentLocations; // optional
} VkRenderingAttachmentLocationInfo;

Auto initialization

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

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

• VkRenderingAttachmentLocationInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$pColorAttachmentLocations

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

public static final AddressLayout LAYOUT$pColorAttachmentLocations

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

public static final long SIZE$pColorAttachmentLocations

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

public static final long OFFSET$pColorAttachmentLocations

Constructor Details

VkRenderingAttachmentLocationInfo

public VkRenderingAttachmentLocationInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkRenderingAttachmentLocationInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkRenderingAttachmentLocationInfo allocate(Arena arena)

allocate

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

clone

public static VkRenderingAttachmentLocationInfo clone(Arena arena,
 VkRenderingAttachmentLocationInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkRenderingAttachmentLocationInfo pNext(@Nullable
 @Nullable IPointer pointer)

colorAttachmentCount

@Unsigned
public int colorAttachmentCount()

colorAttachmentCount

public VkRenderingAttachmentLocationInfo colorAttachmentCount(@Unsigned
 int value)

pColorAttachmentLocations

@Nullable
@Unsigned
public @Nullable IntPtr pColorAttachmentLocations()

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.

pColorAttachmentLocations

public VkRenderingAttachmentLocationInfo pColorAttachmentLocations(@Nullable @Unsigned
 @Nullable IntPtr value)

pColorAttachmentLocationsRaw

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

pColorAttachmentLocationsRaw

public void pColorAttachmentLocationsRaw(@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