Record Class VkSubpassDescription

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubpassDescription

All Implemented Interfaces:

IPointer, IVkSubpassDescription

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubpassDescription(@NotNull MemorySegment segment)
extends Record
implements IVkSubpassDescription

Represents a pointer to a VkSubpassDescription structure in native memory.

Structure

typedef struct VkSubpassDescription {
    VkSubpassDescriptionFlags flags; // optional
    VkPipelineBindPoint pipelineBindPoint;
    uint32_t inputAttachmentCount; // optional
    VkAttachmentReference const* pInputAttachments; // optional
    uint32_t colorAttachmentCount; // optional
    VkAttachmentReference const* pColorAttachments; // optional
    VkAttachmentReference const* pResolveAttachments; // optional
    VkAttachmentReference const* pDepthStencilAttachment; // optional
    uint32_t preserveAttachmentCount; // optional
    uint32_t const* pPreserveAttachments; // optional
} VkSubpassDescription;

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:

• VkSubpassDescription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSubpassDescription.Ptr	Represents a pointer to / an array of VkSubpassDescription 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$flags
static final ValueLayout.OfInt	LAYOUT$inputAttachmentCount
static final AddressLayout	LAYOUT$pColorAttachments
static final AddressLayout	LAYOUT$pDepthStencilAttachment
static final AddressLayout	LAYOUT$pInputAttachments
static final ValueLayout.OfInt	LAYOUT$pipelineBindPoint
static final AddressLayout	LAYOUT$pPreserveAttachments
static final ValueLayout.OfInt	LAYOUT$preserveAttachmentCount
static final AddressLayout	LAYOUT$pResolveAttachments
static final long	OFFSET$colorAttachmentCount
static final long	OFFSET$flags
static final long	OFFSET$inputAttachmentCount
static final long	OFFSET$pColorAttachments
static final long	OFFSET$pDepthStencilAttachment
static final long	OFFSET$pInputAttachments
static final long	OFFSET$pipelineBindPoint
static final long	OFFSET$pPreserveAttachments
static final long	OFFSET$preserveAttachmentCount
static final long	OFFSET$pResolveAttachments
static final MemoryLayout.PathElement	PATH$colorAttachmentCount
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$inputAttachmentCount
static final MemoryLayout.PathElement	PATH$pColorAttachments
static final MemoryLayout.PathElement	PATH$pDepthStencilAttachment
static final MemoryLayout.PathElement	PATH$pInputAttachments
static final MemoryLayout.PathElement	PATH$pipelineBindPoint
static final MemoryLayout.PathElement	PATH$pPreserveAttachments
static final MemoryLayout.PathElement	PATH$preserveAttachmentCount
static final MemoryLayout.PathElement	PATH$pResolveAttachments
static final long	SIZE$colorAttachmentCount
static final long	SIZE$flags
static final long	SIZE$inputAttachmentCount
static final long	SIZE$pColorAttachments
static final long	SIZE$pDepthStencilAttachment
static final long	SIZE$pInputAttachments
static final long	SIZE$pipelineBindPoint
static final long	SIZE$pPreserveAttachments
static final long	SIZE$preserveAttachmentCount
static final long	SIZE$pResolveAttachments

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubpassDescription	allocate(Arena arena)
static VkSubpassDescription.Ptr	allocate(Arena arena, long count)
static VkSubpassDescription	clone(Arena arena, VkSubpassDescription src)
int	colorAttachmentCount()
VkSubpassDescription	colorAttachmentCount(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
VkSubpassDescription	flags(int value)
final int	hashCode()	Returns a hash code value for this object.
int	inputAttachmentCount()
VkSubpassDescription	inputAttachmentCount(int value)
@Nullable VkAttachmentReference	pColorAttachments()
VkAttachmentReference.Ptr	pColorAttachments(int assumedCount)
VkSubpassDescription	pColorAttachments(@Nullable IVkAttachmentReference value)
@NotNull MemorySegment	pColorAttachmentsRaw()
void	pColorAttachmentsRaw(@NotNull MemorySegment value)
@Nullable VkAttachmentReference	pDepthStencilAttachment()
VkAttachmentReference.Ptr	pDepthStencilAttachment(int assumedCount)
VkSubpassDescription	pDepthStencilAttachment(@Nullable IVkAttachmentReference value)
@NotNull MemorySegment	pDepthStencilAttachmentRaw()
void	pDepthStencilAttachmentRaw(@NotNull MemorySegment value)
@Nullable VkAttachmentReference	pInputAttachments()
VkAttachmentReference.Ptr	pInputAttachments(int assumedCount)
VkSubpassDescription	pInputAttachments(@Nullable IVkAttachmentReference value)
@NotNull MemorySegment	pInputAttachmentsRaw()
void	pInputAttachmentsRaw(@NotNull MemorySegment value)
int	pipelineBindPoint()
VkSubpassDescription	pipelineBindPoint(int value)
@Nullable IntPtr	pPreserveAttachments()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkSubpassDescription	pPreserveAttachments(@Nullable IntPtr value)
@NotNull MemorySegment	pPreserveAttachmentsRaw()
void	pPreserveAttachmentsRaw(@NotNull MemorySegment value)
int	preserveAttachmentCount()
VkSubpassDescription	preserveAttachmentCount(int value)
@Nullable VkAttachmentReference	pResolveAttachments()
VkAttachmentReference.Ptr	pResolveAttachments(int assumedCount)
VkSubpassDescription	pResolveAttachments(@Nullable IVkAttachmentReference value)
@NotNull MemorySegment	pResolveAttachmentsRaw()
void	pResolveAttachmentsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$pipelineBindPoint

public static final MemoryLayout.PathElement PATH$pipelineBindPoint

PATH$inputAttachmentCount

public static final MemoryLayout.PathElement PATH$inputAttachmentCount

PATH$pInputAttachments

public static final MemoryLayout.PathElement PATH$pInputAttachments

PATH$colorAttachmentCount

public static final MemoryLayout.PathElement PATH$colorAttachmentCount

PATH$pColorAttachments

public static final MemoryLayout.PathElement PATH$pColorAttachments

PATH$pResolveAttachments

public static final MemoryLayout.PathElement PATH$pResolveAttachments

PATH$pDepthStencilAttachment

public static final MemoryLayout.PathElement PATH$pDepthStencilAttachment

PATH$preserveAttachmentCount

public static final MemoryLayout.PathElement PATH$preserveAttachmentCount

PATH$pPreserveAttachments

public static final MemoryLayout.PathElement PATH$pPreserveAttachments

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$pipelineBindPoint

public static final ValueLayout.OfInt LAYOUT$pipelineBindPoint

LAYOUT$inputAttachmentCount

public static final ValueLayout.OfInt LAYOUT$inputAttachmentCount

LAYOUT$pInputAttachments

public static final AddressLayout LAYOUT$pInputAttachments

LAYOUT$colorAttachmentCount

public static final ValueLayout.OfInt LAYOUT$colorAttachmentCount

LAYOUT$pColorAttachments

public static final AddressLayout LAYOUT$pColorAttachments

LAYOUT$pResolveAttachments

public static final AddressLayout LAYOUT$pResolveAttachments

LAYOUT$pDepthStencilAttachment

public static final AddressLayout LAYOUT$pDepthStencilAttachment

LAYOUT$preserveAttachmentCount

public static final ValueLayout.OfInt LAYOUT$preserveAttachmentCount

LAYOUT$pPreserveAttachments

public static final AddressLayout LAYOUT$pPreserveAttachments

SIZE$flags

public static final long SIZE$flags

SIZE$pipelineBindPoint

public static final long SIZE$pipelineBindPoint

SIZE$inputAttachmentCount

public static final long SIZE$inputAttachmentCount

SIZE$pInputAttachments

public static final long SIZE$pInputAttachments

SIZE$colorAttachmentCount

public static final long SIZE$colorAttachmentCount

SIZE$pColorAttachments

public static final long SIZE$pColorAttachments

SIZE$pResolveAttachments

public static final long SIZE$pResolveAttachments

SIZE$pDepthStencilAttachment

public static final long SIZE$pDepthStencilAttachment

SIZE$preserveAttachmentCount

public static final long SIZE$preserveAttachmentCount

SIZE$pPreserveAttachments

public static final long SIZE$pPreserveAttachments

OFFSET$flags

public static final long OFFSET$flags

OFFSET$pipelineBindPoint

public static final long OFFSET$pipelineBindPoint

OFFSET$inputAttachmentCount

public static final long OFFSET$inputAttachmentCount

OFFSET$pInputAttachments

public static final long OFFSET$pInputAttachments

OFFSET$colorAttachmentCount

public static final long OFFSET$colorAttachmentCount

OFFSET$pColorAttachments

public static final long OFFSET$pColorAttachments

OFFSET$pResolveAttachments

public static final long OFFSET$pResolveAttachments

OFFSET$pDepthStencilAttachment

public static final long OFFSET$pDepthStencilAttachment

OFFSET$preserveAttachmentCount

public static final long OFFSET$preserveAttachmentCount

OFFSET$pPreserveAttachments

public static final long OFFSET$pPreserveAttachments

Constructor Details

VkSubpassDescription

public VkSubpassDescription(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubpassDescription record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubpassDescription allocate(Arena arena)

allocate

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

clone

public static VkSubpassDescription clone(Arena arena,
 VkSubpassDescription src)

flags

@Bitmask(VkSubpassDescriptionFlags.class)
public int flags()

flags

public VkSubpassDescription flags(@Bitmask(VkSubpassDescriptionFlags.class)
 int value)

pipelineBindPoint

@EnumType(VkPipelineBindPoint.class)
public int pipelineBindPoint()

pipelineBindPoint

public VkSubpassDescription pipelineBindPoint(@EnumType(VkPipelineBindPoint.class)
 int value)

inputAttachmentCount

@Unsigned
public int inputAttachmentCount()

inputAttachmentCount

public VkSubpassDescription inputAttachmentCount(@Unsigned
 int value)

pInputAttachments

public VkSubpassDescription pInputAttachments(@Nullable
 @Nullable IVkAttachmentReference value)

pInputAttachments

@Unsafe
@Nullable
public VkAttachmentReference.Ptr pInputAttachments(int assumedCount)

pInputAttachments

@Nullable
public @Nullable VkAttachmentReference pInputAttachments()

pInputAttachmentsRaw

@Pointer(target=VkAttachmentReference.class)
@NotNull
public @NotNull MemorySegment pInputAttachmentsRaw()

pInputAttachmentsRaw

public void pInputAttachmentsRaw(@Pointer(target=VkAttachmentReference.class) @NotNull
 @NotNull MemorySegment value)

colorAttachmentCount

@Unsigned
public int colorAttachmentCount()

colorAttachmentCount

public VkSubpassDescription colorAttachmentCount(@Unsigned
 int value)

pColorAttachments

public VkSubpassDescription pColorAttachments(@Nullable
 @Nullable IVkAttachmentReference value)

pColorAttachments

@Unsafe
@Nullable
public VkAttachmentReference.Ptr pColorAttachments(int assumedCount)

pColorAttachments

@Nullable
public @Nullable VkAttachmentReference pColorAttachments()

pColorAttachmentsRaw

@Pointer(target=VkAttachmentReference.class)
@NotNull
public @NotNull MemorySegment pColorAttachmentsRaw()

pColorAttachmentsRaw

public void pColorAttachmentsRaw(@Pointer(target=VkAttachmentReference.class) @NotNull
 @NotNull MemorySegment value)

pResolveAttachments

public VkSubpassDescription pResolveAttachments(@Nullable
 @Nullable IVkAttachmentReference value)

pResolveAttachments

@Unsafe
@Nullable
public VkAttachmentReference.Ptr pResolveAttachments(int assumedCount)

pResolveAttachments

@Nullable
public @Nullable VkAttachmentReference pResolveAttachments()

pResolveAttachmentsRaw

@Pointer(target=VkAttachmentReference.class)
@NotNull
public @NotNull MemorySegment pResolveAttachmentsRaw()

pResolveAttachmentsRaw

public void pResolveAttachmentsRaw(@Pointer(target=VkAttachmentReference.class) @NotNull
 @NotNull MemorySegment value)

pDepthStencilAttachment

public VkSubpassDescription pDepthStencilAttachment(@Nullable
 @Nullable IVkAttachmentReference value)

pDepthStencilAttachment

@Unsafe
@Nullable
public VkAttachmentReference.Ptr pDepthStencilAttachment(int assumedCount)

pDepthStencilAttachment

@Nullable
public @Nullable VkAttachmentReference pDepthStencilAttachment()

pDepthStencilAttachmentRaw

@Pointer(target=VkAttachmentReference.class)
@NotNull
public @NotNull MemorySegment pDepthStencilAttachmentRaw()

pDepthStencilAttachmentRaw

public void pDepthStencilAttachmentRaw(@Pointer(target=VkAttachmentReference.class) @NotNull
 @NotNull MemorySegment value)

preserveAttachmentCount

@Unsigned
public int preserveAttachmentCount()

preserveAttachmentCount

public VkSubpassDescription preserveAttachmentCount(@Unsigned
 int value)

pPreserveAttachments

@Nullable
@Unsigned
public @Nullable IntPtr pPreserveAttachments()

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.

pPreserveAttachments

public VkSubpassDescription pPreserveAttachments(@Nullable @Unsigned
 @Nullable IntPtr value)

pPreserveAttachmentsRaw

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

pPreserveAttachmentsRaw

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