Record Class VkRenderingAreaInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkRenderingAreaInfo

All Implemented Interfaces:

IPointer, IVkRenderingAreaInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkRenderingAreaInfo(@NotNull MemorySegment segment)
extends Record
implements IVkRenderingAreaInfo

Represents a pointer to a VkRenderingAreaInfo structure in native memory.

Structure

typedef struct VkRenderingAreaInfo {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t viewMask;
    uint32_t colorAttachmentCount; // optional
    VkFormat const* pColorAttachmentFormats; // optional
    VkFormat depthAttachmentFormat;
    VkFormat stencilAttachmentFormat;
} VkRenderingAreaInfo;

Auto initialization

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

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

• VkRenderingAreaInfo

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderingAreaInfo	allocate(Arena arena)
static VkRenderingAreaInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkRenderingAreaInfo	clone(Arena arena, VkRenderingAreaInfo src)
int	colorAttachmentCount()
VkRenderingAreaInfo	colorAttachmentCount(int value)
int	depthAttachmentFormat()
VkRenderingAreaInfo	depthAttachmentFormat(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	pColorAttachmentFormats()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkRenderingAreaInfo	pColorAttachmentFormats(@Nullable IntPtr value)
@NotNull MemorySegment	pColorAttachmentFormatsRaw()
void	pColorAttachmentFormatsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkRenderingAreaInfo	pNext(@Nullable IPointer pointer)
VkRenderingAreaInfo	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	stencilAttachmentFormat()
VkRenderingAreaInfo	stencilAttachmentFormat(int value)
int	sType()
VkRenderingAreaInfo	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	viewMask()
VkRenderingAreaInfo	viewMask(int value)

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

public static final MemoryLayout.PathElement PATH$viewMask

PATH$colorAttachmentCount

public static final MemoryLayout.PathElement PATH$colorAttachmentCount

PATH$pColorAttachmentFormats

public static final MemoryLayout.PathElement PATH$pColorAttachmentFormats

PATH$depthAttachmentFormat

public static final MemoryLayout.PathElement PATH$depthAttachmentFormat

PATH$stencilAttachmentFormat

public static final MemoryLayout.PathElement PATH$stencilAttachmentFormat

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$viewMask

public static final ValueLayout.OfInt LAYOUT$viewMask

LAYOUT$colorAttachmentCount

public static final ValueLayout.OfInt LAYOUT$colorAttachmentCount

LAYOUT$pColorAttachmentFormats

public static final AddressLayout LAYOUT$pColorAttachmentFormats

LAYOUT$depthAttachmentFormat

public static final ValueLayout.OfInt LAYOUT$depthAttachmentFormat

LAYOUT$stencilAttachmentFormat

public static final ValueLayout.OfInt LAYOUT$stencilAttachmentFormat

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$viewMask

public static final long SIZE$viewMask

SIZE$colorAttachmentCount

public static final long SIZE$colorAttachmentCount

SIZE$pColorAttachmentFormats

public static final long SIZE$pColorAttachmentFormats

SIZE$depthAttachmentFormat

public static final long SIZE$depthAttachmentFormat

SIZE$stencilAttachmentFormat

public static final long SIZE$stencilAttachmentFormat

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$viewMask

public static final long OFFSET$viewMask

OFFSET$colorAttachmentCount

public static final long OFFSET$colorAttachmentCount

OFFSET$pColorAttachmentFormats

public static final long OFFSET$pColorAttachmentFormats

OFFSET$depthAttachmentFormat

public static final long OFFSET$depthAttachmentFormat

OFFSET$stencilAttachmentFormat

public static final long OFFSET$stencilAttachmentFormat

Constructor Details

VkRenderingAreaInfo

public VkRenderingAreaInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkRenderingAreaInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkRenderingAreaInfo allocate(Arena arena)

allocate

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

clone

public static VkRenderingAreaInfo clone(Arena arena,
 VkRenderingAreaInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkRenderingAreaInfo pNext(@Nullable
 @Nullable IPointer pointer)

viewMask

@Unsigned
public int viewMask()

viewMask

public VkRenderingAreaInfo viewMask(@Unsigned
 int value)

colorAttachmentCount

@Unsigned
public int colorAttachmentCount()

colorAttachmentCount

public VkRenderingAreaInfo colorAttachmentCount(@Unsigned
 int value)

pColorAttachmentFormats

@Nullable
@EnumType(VkFormat.class)
public @Nullable IntPtr pColorAttachmentFormats()

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 fro or writing to the buffer.

pColorAttachmentFormats

public VkRenderingAreaInfo pColorAttachmentFormats(@Nullable @EnumType(VkFormat.class)
 @Nullable IntPtr value)

pColorAttachmentFormatsRaw

@Pointer(target=VkFormat.class)
@NotNull
public @NotNull MemorySegment pColorAttachmentFormatsRaw()

pColorAttachmentFormatsRaw

public void pColorAttachmentFormatsRaw(@Pointer(target=VkFormat.class) @NotNull
 @NotNull MemorySegment value)

depthAttachmentFormat

@EnumType(VkFormat.class)
public int depthAttachmentFormat()

depthAttachmentFormat

public VkRenderingAreaInfo depthAttachmentFormat(@EnumType(VkFormat.class)
 int value)

stencilAttachmentFormat

@EnumType(VkFormat.class)
public int stencilAttachmentFormat()

stencilAttachmentFormat

public VkRenderingAreaInfo stencilAttachmentFormat(@EnumType(VkFormat.class)
 int 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