Record Class VkSubpassDependency2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubpassDependency2

All Implemented Interfaces:

IPointer, IVkSubpassDependency2

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubpassDependency2(@NotNull MemorySegment segment)
extends Record
implements IVkSubpassDependency2

Represents a pointer to a VkSubpassDependency2 structure in native memory.

Structure

typedef struct VkSubpassDependency2 {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t srcSubpass;
    uint32_t dstSubpass;
    VkPipelineStageFlags srcStageMask; // optional
    VkPipelineStageFlags dstStageMask; // optional
    VkAccessFlags srcAccessMask; // optional
    VkAccessFlags dstAccessMask; // optional
    VkDependencyFlags dependencyFlags; // optional
    int32_t viewOffset;
} VkSubpassDependency2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2

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:

• VkSubpassDependency2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSubpassDependency2.Ptr	Represents a pointer to / an array of VkSubpassDependency2 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$dependencyFlags
static final ValueLayout.OfInt	LAYOUT$dstAccessMask
static final ValueLayout.OfInt	LAYOUT$dstStageMask
static final ValueLayout.OfInt	LAYOUT$dstSubpass
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$srcAccessMask
static final ValueLayout.OfInt	LAYOUT$srcStageMask
static final ValueLayout.OfInt	LAYOUT$srcSubpass
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$viewOffset
static final long	OFFSET$dependencyFlags
static final long	OFFSET$dstAccessMask
static final long	OFFSET$dstStageMask
static final long	OFFSET$dstSubpass
static final long	OFFSET$pNext
static final long	OFFSET$srcAccessMask
static final long	OFFSET$srcStageMask
static final long	OFFSET$srcSubpass
static final long	OFFSET$sType
static final long	OFFSET$viewOffset
static final MemoryLayout.PathElement	PATH$dependencyFlags
static final MemoryLayout.PathElement	PATH$dstAccessMask
static final MemoryLayout.PathElement	PATH$dstStageMask
static final MemoryLayout.PathElement	PATH$dstSubpass
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$srcAccessMask
static final MemoryLayout.PathElement	PATH$srcStageMask
static final MemoryLayout.PathElement	PATH$srcSubpass
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$viewOffset
static final long	SIZE$dependencyFlags
static final long	SIZE$dstAccessMask
static final long	SIZE$dstStageMask
static final long	SIZE$dstSubpass
static final long	SIZE$pNext
static final long	SIZE$srcAccessMask
static final long	SIZE$srcStageMask
static final long	SIZE$srcSubpass
static final long	SIZE$sType
static final long	SIZE$viewOffset

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubpassDependency2	allocate(Arena arena)
static VkSubpassDependency2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSubpassDependency2	clone(Arena arena, VkSubpassDependency2 src)
int	dependencyFlags()
VkSubpassDependency2	dependencyFlags(int value)
int	dstAccessMask()
VkSubpassDependency2	dstAccessMask(int value)
int	dstStageMask()
VkSubpassDependency2	dstStageMask(int value)
int	dstSubpass()
VkSubpassDependency2	dstSubpass(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.
MemorySegment	pNext()
VkSubpassDependency2	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	srcAccessMask()
VkSubpassDependency2	srcAccessMask(int value)
int	srcStageMask()
VkSubpassDependency2	srcStageMask(int value)
int	srcSubpass()
VkSubpassDependency2	srcSubpass(int value)
int	sType()
VkSubpassDependency2	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	viewOffset()
VkSubpassDependency2	viewOffset(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$srcSubpass

public static final MemoryLayout.PathElement PATH$srcSubpass

PATH$dstSubpass

public static final MemoryLayout.PathElement PATH$dstSubpass

PATH$srcStageMask

public static final MemoryLayout.PathElement PATH$srcStageMask

PATH$dstStageMask

public static final MemoryLayout.PathElement PATH$dstStageMask

PATH$srcAccessMask

public static final MemoryLayout.PathElement PATH$srcAccessMask

PATH$dstAccessMask

public static final MemoryLayout.PathElement PATH$dstAccessMask

PATH$dependencyFlags

public static final MemoryLayout.PathElement PATH$dependencyFlags

PATH$viewOffset

public static final MemoryLayout.PathElement PATH$viewOffset

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcSubpass

public static final ValueLayout.OfInt LAYOUT$srcSubpass

LAYOUT$dstSubpass

public static final ValueLayout.OfInt LAYOUT$dstSubpass

LAYOUT$srcStageMask

public static final ValueLayout.OfInt LAYOUT$srcStageMask

LAYOUT$dstStageMask

public static final ValueLayout.OfInt LAYOUT$dstStageMask

LAYOUT$srcAccessMask

public static final ValueLayout.OfInt LAYOUT$srcAccessMask

LAYOUT$dstAccessMask

public static final ValueLayout.OfInt LAYOUT$dstAccessMask

LAYOUT$dependencyFlags

public static final ValueLayout.OfInt LAYOUT$dependencyFlags

LAYOUT$viewOffset

public static final ValueLayout.OfInt LAYOUT$viewOffset

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcSubpass

public static final long SIZE$srcSubpass

SIZE$dstSubpass

public static final long SIZE$dstSubpass

SIZE$srcStageMask

public static final long SIZE$srcStageMask

SIZE$dstStageMask

public static final long SIZE$dstStageMask

SIZE$srcAccessMask

public static final long SIZE$srcAccessMask

SIZE$dstAccessMask

public static final long SIZE$dstAccessMask

SIZE$dependencyFlags

public static final long SIZE$dependencyFlags

SIZE$viewOffset

public static final long SIZE$viewOffset

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcSubpass

public static final long OFFSET$srcSubpass

OFFSET$dstSubpass

public static final long OFFSET$dstSubpass

OFFSET$srcStageMask

public static final long OFFSET$srcStageMask

OFFSET$dstStageMask

public static final long OFFSET$dstStageMask

OFFSET$srcAccessMask

public static final long OFFSET$srcAccessMask

OFFSET$dstAccessMask

public static final long OFFSET$dstAccessMask

OFFSET$dependencyFlags

public static final long OFFSET$dependencyFlags

OFFSET$viewOffset

public static final long OFFSET$viewOffset

Constructor Details

VkSubpassDependency2

public VkSubpassDependency2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubpassDependency2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubpassDependency2 allocate(Arena arena)

allocate

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

clone

public static VkSubpassDependency2 clone(Arena arena,
 VkSubpassDependency2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSubpassDependency2 pNext(@Nullable
 @Nullable IPointer pointer)

srcSubpass

@Unsigned
public int srcSubpass()

srcSubpass

public VkSubpassDependency2 srcSubpass(@Unsigned
 int value)

dstSubpass

@Unsigned
public int dstSubpass()

dstSubpass

public VkSubpassDependency2 dstSubpass(@Unsigned
 int value)

srcStageMask

@EnumType(VkPipelineStageFlags.class)
public int srcStageMask()

srcStageMask

public VkSubpassDependency2 srcStageMask(@EnumType(VkPipelineStageFlags.class)
 int value)

dstStageMask

@EnumType(VkPipelineStageFlags.class)
public int dstStageMask()

dstStageMask

public VkSubpassDependency2 dstStageMask(@EnumType(VkPipelineStageFlags.class)
 int value)

srcAccessMask

@EnumType(VkAccessFlags.class)
public int srcAccessMask()

srcAccessMask

public VkSubpassDependency2 srcAccessMask(@EnumType(VkAccessFlags.class)
 int value)

dstAccessMask

@EnumType(VkAccessFlags.class)
public int dstAccessMask()

dstAccessMask

public VkSubpassDependency2 dstAccessMask(@EnumType(VkAccessFlags.class)
 int value)

dependencyFlags

@EnumType(VkDependencyFlags.class)
public int dependencyFlags()

dependencyFlags

public VkSubpassDependency2 dependencyFlags(@EnumType(VkDependencyFlags.class)
 int value)

viewOffset

public int viewOffset()

viewOffset

public VkSubpassDependency2 viewOffset(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