Record Class VkRenderPassMultiviewCreateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkRenderPassMultiviewCreateInfo

All Implemented Interfaces:

IPointer, IVkRenderPassMultiviewCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkRenderPassMultiviewCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkRenderPassMultiviewCreateInfo

Represents a pointer to a VkRenderPassMultiviewCreateInfo structure in native memory.

Structure

typedef struct VkRenderPassMultiviewCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t subpassCount; // optional
    uint32_t const* pViewMasks; // optional
    uint32_t dependencyCount; // optional
    int32_t const* pViewOffsets; // optional
    uint32_t correlationMaskCount; // optional
    uint32_t const* pCorrelationMasks; // optional
} VkRenderPassMultiviewCreateInfo;

Auto initialization

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

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

• VkRenderPassMultiviewCreateInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderPassMultiviewCreateInfo	allocate(Arena arena)
static VkRenderPassMultiviewCreateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkRenderPassMultiviewCreateInfo	clone(Arena arena, VkRenderPassMultiviewCreateInfo src)
int	correlationMaskCount()
VkRenderPassMultiviewCreateInfo	correlationMaskCount(int value)
int	dependencyCount()
VkRenderPassMultiviewCreateInfo	dependencyCount(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	pCorrelationMasks()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderPassMultiviewCreateInfo	pCorrelationMasks(@Nullable IntPtr value)
@NotNull MemorySegment	pCorrelationMasksRaw()
void	pCorrelationMasksRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkRenderPassMultiviewCreateInfo	pNext(@Nullable IPointer pointer)
VkRenderPassMultiviewCreateInfo	pNext(@NotNull MemorySegment value)
@Nullable IntPtr	pViewMasks()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderPassMultiviewCreateInfo	pViewMasks(@Nullable IntPtr value)
@NotNull MemorySegment	pViewMasksRaw()
void	pViewMasksRaw(@NotNull MemorySegment value)
@Nullable IntPtr	pViewOffsets()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderPassMultiviewCreateInfo	pViewOffsets(@Nullable IntPtr value)
@NotNull MemorySegment	pViewOffsetsRaw()
void	pViewOffsetsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkRenderPassMultiviewCreateInfo	sType(int value)
int	subpassCount()
VkRenderPassMultiviewCreateInfo	subpassCount(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$subpassCount

public static final MemoryLayout.PathElement PATH$subpassCount

PATH$pViewMasks

public static final MemoryLayout.PathElement PATH$pViewMasks

PATH$dependencyCount

public static final MemoryLayout.PathElement PATH$dependencyCount

PATH$pViewOffsets

public static final MemoryLayout.PathElement PATH$pViewOffsets

PATH$correlationMaskCount

public static final MemoryLayout.PathElement PATH$correlationMaskCount

PATH$pCorrelationMasks

public static final MemoryLayout.PathElement PATH$pCorrelationMasks

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$subpassCount

public static final ValueLayout.OfInt LAYOUT$subpassCount

LAYOUT$pViewMasks

public static final AddressLayout LAYOUT$pViewMasks

LAYOUT$dependencyCount

public static final ValueLayout.OfInt LAYOUT$dependencyCount

LAYOUT$pViewOffsets

public static final AddressLayout LAYOUT$pViewOffsets

LAYOUT$correlationMaskCount

public static final ValueLayout.OfInt LAYOUT$correlationMaskCount

LAYOUT$pCorrelationMasks

public static final AddressLayout LAYOUT$pCorrelationMasks

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$subpassCount

public static final long SIZE$subpassCount

SIZE$pViewMasks

public static final long SIZE$pViewMasks

SIZE$dependencyCount

public static final long SIZE$dependencyCount

SIZE$pViewOffsets

public static final long SIZE$pViewOffsets

SIZE$correlationMaskCount

public static final long SIZE$correlationMaskCount

SIZE$pCorrelationMasks

public static final long SIZE$pCorrelationMasks

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$subpassCount

public static final long OFFSET$subpassCount

OFFSET$pViewMasks

public static final long OFFSET$pViewMasks

OFFSET$dependencyCount

public static final long OFFSET$dependencyCount

OFFSET$pViewOffsets

public static final long OFFSET$pViewOffsets

OFFSET$correlationMaskCount

public static final long OFFSET$correlationMaskCount

OFFSET$pCorrelationMasks

public static final long OFFSET$pCorrelationMasks

Constructor Details

VkRenderPassMultiviewCreateInfo

public VkRenderPassMultiviewCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkRenderPassMultiviewCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkRenderPassMultiviewCreateInfo allocate(Arena arena)

allocate

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

clone

public static VkRenderPassMultiviewCreateInfo clone(Arena arena,
 VkRenderPassMultiviewCreateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkRenderPassMultiviewCreateInfo pNext(@Nullable
 @Nullable IPointer pointer)

subpassCount

@Unsigned
public int subpassCount()

subpassCount

public VkRenderPassMultiviewCreateInfo subpassCount(@Unsigned
 int value)

pViewMasks

@Nullable
@Unsigned
public @Nullable IntPtr pViewMasks()

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.

pViewMasks

public VkRenderPassMultiviewCreateInfo pViewMasks(@Nullable @Unsigned
 @Nullable IntPtr value)

pViewMasksRaw

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

pViewMasksRaw

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

dependencyCount

@Unsigned
public int dependencyCount()

dependencyCount

public VkRenderPassMultiviewCreateInfo dependencyCount(@Unsigned
 int value)

pViewOffsets

@Nullable
public @Nullable IntPtr pViewOffsets()

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.

pViewOffsets

public VkRenderPassMultiviewCreateInfo pViewOffsets(@Nullable
 @Nullable IntPtr value)

pViewOffsetsRaw

@Pointer(comment="int32_t*")
@NotNull
public @NotNull MemorySegment pViewOffsetsRaw()

pViewOffsetsRaw

public void pViewOffsetsRaw(@Pointer(comment="int32_t*") @NotNull
 @NotNull MemorySegment value)

correlationMaskCount

@Unsigned
public int correlationMaskCount()

correlationMaskCount

public VkRenderPassMultiviewCreateInfo correlationMaskCount(@Unsigned
 int value)

pCorrelationMasks

@Nullable
@Unsigned
public @Nullable IntPtr pCorrelationMasks()

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.

pCorrelationMasks

public VkRenderPassMultiviewCreateInfo pCorrelationMasks(@Nullable @Unsigned
 @Nullable IntPtr value)

pCorrelationMasksRaw

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

pCorrelationMasksRaw

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