Record Class VkDeviceGroupRenderPassBeginInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDeviceGroupRenderPassBeginInfo

All Implemented Interfaces:

IPointer, IVkDeviceGroupRenderPassBeginInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkDeviceGroupRenderPassBeginInfo(@NotNull MemorySegment segment)
extends Record
implements IVkDeviceGroupRenderPassBeginInfo

Represents a pointer to a VkDeviceGroupRenderPassBeginInfo structure in native memory.

Structure

typedef struct VkDeviceGroupRenderPassBeginInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t deviceMask;
    uint32_t deviceRenderAreaCount; // optional
    VkRect2D const* pDeviceRenderAreas; // optional
} VkDeviceGroupRenderPassBeginInfo;

Auto initialization

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

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

• VkDeviceGroupRenderPassBeginInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceGroupRenderPassBeginInfo	allocate(Arena arena)
static VkDeviceGroupRenderPassBeginInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkDeviceGroupRenderPassBeginInfo	clone(Arena arena, VkDeviceGroupRenderPassBeginInfo src)
int	deviceMask()
VkDeviceGroupRenderPassBeginInfo	deviceMask(int value)
int	deviceRenderAreaCount()
VkDeviceGroupRenderPassBeginInfo	deviceRenderAreaCount(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 VkRect2D	pDeviceRenderAreas()
VkRect2D.Ptr	pDeviceRenderAreas(int assumedCount)
VkDeviceGroupRenderPassBeginInfo	pDeviceRenderAreas(@Nullable IVkRect2D value)
@NotNull MemorySegment	pDeviceRenderAreasRaw()
void	pDeviceRenderAreasRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkDeviceGroupRenderPassBeginInfo	pNext(@Nullable IPointer pointer)
VkDeviceGroupRenderPassBeginInfo	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkDeviceGroupRenderPassBeginInfo	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$deviceMask

public static final MemoryLayout.PathElement PATH$deviceMask

PATH$deviceRenderAreaCount

public static final MemoryLayout.PathElement PATH$deviceRenderAreaCount

PATH$pDeviceRenderAreas

public static final MemoryLayout.PathElement PATH$pDeviceRenderAreas

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$deviceMask

public static final ValueLayout.OfInt LAYOUT$deviceMask

LAYOUT$deviceRenderAreaCount

public static final ValueLayout.OfInt LAYOUT$deviceRenderAreaCount

LAYOUT$pDeviceRenderAreas

public static final AddressLayout LAYOUT$pDeviceRenderAreas

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$deviceMask

public static final long SIZE$deviceMask

SIZE$deviceRenderAreaCount

public static final long SIZE$deviceRenderAreaCount

SIZE$pDeviceRenderAreas

public static final long SIZE$pDeviceRenderAreas

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$deviceMask

public static final long OFFSET$deviceMask

OFFSET$deviceRenderAreaCount

public static final long OFFSET$deviceRenderAreaCount

OFFSET$pDeviceRenderAreas

public static final long OFFSET$pDeviceRenderAreas

Constructor Details

VkDeviceGroupRenderPassBeginInfo

public VkDeviceGroupRenderPassBeginInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDeviceGroupRenderPassBeginInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDeviceGroupRenderPassBeginInfo allocate(Arena arena)

allocate

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

clone

public static VkDeviceGroupRenderPassBeginInfo clone(Arena arena,
 VkDeviceGroupRenderPassBeginInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDeviceGroupRenderPassBeginInfo pNext(@Nullable
 @Nullable IPointer pointer)

deviceMask

@Unsigned
public int deviceMask()

deviceMask

public VkDeviceGroupRenderPassBeginInfo deviceMask(@Unsigned
 int value)

deviceRenderAreaCount

@Unsigned
public int deviceRenderAreaCount()

deviceRenderAreaCount

public VkDeviceGroupRenderPassBeginInfo deviceRenderAreaCount(@Unsigned
 int value)

pDeviceRenderAreas

public VkDeviceGroupRenderPassBeginInfo pDeviceRenderAreas(@Nullable
 @Nullable IVkRect2D value)

pDeviceRenderAreas

@Unsafe
@Nullable
public VkRect2D.Ptr pDeviceRenderAreas(int assumedCount)

pDeviceRenderAreas

@Nullable
public @Nullable VkRect2D pDeviceRenderAreas()

pDeviceRenderAreasRaw

@Pointer(target=VkRect2D.class)
@NotNull
public @NotNull MemorySegment pDeviceRenderAreasRaw()

pDeviceRenderAreasRaw

public void pDeviceRenderAreasRaw(@Pointer(target=VkRect2D.class) @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