Record Class VkRenderPassBeginInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkRenderPassBeginInfo

All Implemented Interfaces:

IPointer, IVkRenderPassBeginInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkRenderPassBeginInfo(@NotNull MemorySegment segment)
extends Record
implements IVkRenderPassBeginInfo

Represents a pointer to a VkRenderPassBeginInfo structure in native memory.

Structure

typedef struct VkRenderPassBeginInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkRenderPass renderPass;
    VkFramebuffer framebuffer;
    VkRect2D renderArea;
    uint32_t clearValueCount; // optional
    VkClearValue const* pClearValues; // optional
} VkRenderPassBeginInfo;

Auto initialization

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

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

• VkRenderPassBeginInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkRenderPassBeginInfo.Ptr	Represents a pointer to / an array of VkRenderPassBeginInfo 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$clearValueCount
static final AddressLayout	LAYOUT$framebuffer
static final AddressLayout	LAYOUT$pClearValues
static final AddressLayout	LAYOUT$pNext
static final StructLayout	LAYOUT$renderArea
static final AddressLayout	LAYOUT$renderPass
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$clearValueCount
static final long	OFFSET$framebuffer
static final long	OFFSET$pClearValues
static final long	OFFSET$pNext
static final long	OFFSET$renderArea
static final long	OFFSET$renderPass
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$clearValueCount
static final MemoryLayout.PathElement	PATH$framebuffer
static final MemoryLayout.PathElement	PATH$pClearValues
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$renderArea
static final MemoryLayout.PathElement	PATH$renderPass
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$clearValueCount
static final long	SIZE$framebuffer
static final long	SIZE$pClearValues
static final long	SIZE$pNext
static final long	SIZE$renderArea
static final long	SIZE$renderPass
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkRenderPassBeginInfo	allocate(Arena arena)
static VkRenderPassBeginInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
int	clearValueCount()
VkRenderPassBeginInfo	clearValueCount(int value)
static VkRenderPassBeginInfo	clone(Arena arena, VkRenderPassBeginInfo src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable VkFramebuffer	framebuffer()
VkRenderPassBeginInfo	framebuffer(@Nullable VkFramebuffer value)
final int	hashCode()	Returns a hash code value for this object.
@Nullable VkClearValue	pClearValues()
VkClearValue.Ptr	pClearValues(int assumedCount)
VkRenderPassBeginInfo	pClearValues(@Nullable IVkClearValue value)
@NotNull MemorySegment	pClearValuesRaw()
void	pClearValuesRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkRenderPassBeginInfo	pNext(@Nullable IPointer pointer)
VkRenderPassBeginInfo	pNext(@NotNull MemorySegment value)
@NotNull VkRect2D	renderArea()
VkRenderPassBeginInfo	renderArea(@NotNull VkRect2D value)
VkRenderPassBeginInfo	renderArea(Consumer<@NotNull VkRect2D> consumer)
@Nullable VkRenderPass	renderPass()
VkRenderPassBeginInfo	renderPass(@Nullable VkRenderPass value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkRenderPassBeginInfo	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$renderPass

public static final MemoryLayout.PathElement PATH$renderPass

PATH$framebuffer

public static final MemoryLayout.PathElement PATH$framebuffer

PATH$renderArea

public static final MemoryLayout.PathElement PATH$renderArea

PATH$clearValueCount

public static final MemoryLayout.PathElement PATH$clearValueCount

PATH$pClearValues

public static final MemoryLayout.PathElement PATH$pClearValues

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$renderPass

public static final AddressLayout LAYOUT$renderPass

LAYOUT$framebuffer

public static final AddressLayout LAYOUT$framebuffer

LAYOUT$renderArea

public static final StructLayout LAYOUT$renderArea

LAYOUT$clearValueCount

public static final ValueLayout.OfInt LAYOUT$clearValueCount

LAYOUT$pClearValues

public static final AddressLayout LAYOUT$pClearValues

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$renderPass

public static final long SIZE$renderPass

SIZE$framebuffer

public static final long SIZE$framebuffer

SIZE$renderArea

public static final long SIZE$renderArea

SIZE$clearValueCount

public static final long SIZE$clearValueCount

SIZE$pClearValues

public static final long SIZE$pClearValues

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$renderPass

public static final long OFFSET$renderPass

OFFSET$framebuffer

public static final long OFFSET$framebuffer

OFFSET$renderArea

public static final long OFFSET$renderArea

OFFSET$clearValueCount

public static final long OFFSET$clearValueCount

OFFSET$pClearValues

public static final long OFFSET$pClearValues

Constructor Details

VkRenderPassBeginInfo

public VkRenderPassBeginInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkRenderPassBeginInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkRenderPassBeginInfo allocate(Arena arena)

allocate

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

clone

public static VkRenderPassBeginInfo clone(Arena arena,
 VkRenderPassBeginInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkRenderPassBeginInfo pNext(@Nullable
 @Nullable IPointer pointer)

renderPass

@Nullable
public @Nullable VkRenderPass renderPass()

renderPass

public VkRenderPassBeginInfo renderPass(@Nullable
 @Nullable VkRenderPass value)

framebuffer

@Nullable
public @Nullable VkFramebuffer framebuffer()

framebuffer

public VkRenderPassBeginInfo framebuffer(@Nullable
 @Nullable VkFramebuffer value)

renderArea

@NotNull
public @NotNull VkRect2D renderArea()

renderArea

public VkRenderPassBeginInfo renderArea(@NotNull
 @NotNull VkRect2D value)

renderArea

public VkRenderPassBeginInfo renderArea(Consumer<@NotNull VkRect2D> consumer)

clearValueCount

@Unsigned
public int clearValueCount()

clearValueCount

public VkRenderPassBeginInfo clearValueCount(@Unsigned
 int value)

pClearValues

public VkRenderPassBeginInfo pClearValues(@Nullable
 @Nullable IVkClearValue value)

pClearValues

@Unsafe
@Nullable
public VkClearValue.Ptr pClearValues(int assumedCount)

pClearValues

@Nullable
public @Nullable VkClearValue pClearValues()

pClearValuesRaw

@Pointer(target=VkClearValue.class)
@NotNull
public @NotNull MemorySegment pClearValuesRaw()

pClearValuesRaw

public void pClearValuesRaw(@Pointer(target=VkClearValue.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