Record Class VkSubpassDependency

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubpassDependency

All Implemented Interfaces:

IPointer, IVkSubpassDependency

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubpassDependency(@NotNull MemorySegment segment)
extends Record
implements IVkSubpassDependency

Represents a pointer to a VkSubpassDependency structure in native memory.

Structure

typedef struct VkSubpassDependency {
    uint32_t srcSubpass;
    uint32_t dstSubpass;
    VkPipelineStageFlags srcStageMask; // optional
    VkPipelineStageFlags dstStageMask; // optional
    VkAccessFlags srcAccessMask; // optional
    VkAccessFlags dstAccessMask; // optional
    VkDependencyFlags dependencyFlags; // optional
} VkSubpassDependency;

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:

• VkSubpassDependency

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubpassDependency	allocate(Arena arena)
static VkSubpassDependency.Ptr	allocate(Arena arena, long count)
static VkSubpassDependency	clone(Arena arena, VkSubpassDependency src)
int	dependencyFlags()
VkSubpassDependency	dependencyFlags(int value)
int	dstAccessMask()
VkSubpassDependency	dstAccessMask(int value)
int	dstStageMask()
VkSubpassDependency	dstStageMask(int value)
int	dstSubpass()
VkSubpassDependency	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.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	srcAccessMask()
VkSubpassDependency	srcAccessMask(int value)
int	srcStageMask()
VkSubpassDependency	srcStageMask(int value)
int	srcSubpass()
VkSubpassDependency	srcSubpass(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$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

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

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

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

Constructor Details

VkSubpassDependency

public VkSubpassDependency(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubpassDependency record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubpassDependency allocate(Arena arena)

allocate

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

clone

public static VkSubpassDependency clone(Arena arena,
 VkSubpassDependency src)

srcSubpass

@Unsigned
public int srcSubpass()

srcSubpass

public VkSubpassDependency srcSubpass(@Unsigned
 int value)

dstSubpass

@Unsigned
public int dstSubpass()

dstSubpass

public VkSubpassDependency dstSubpass(@Unsigned
 int value)

srcStageMask

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

srcStageMask

public VkSubpassDependency srcStageMask(@Bitmask(VkPipelineStageFlags.class)
 int value)

dstStageMask

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

dstStageMask

public VkSubpassDependency dstStageMask(@Bitmask(VkPipelineStageFlags.class)
 int value)

srcAccessMask

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

srcAccessMask

public VkSubpassDependency srcAccessMask(@Bitmask(VkAccessFlags.class)
 int value)

dstAccessMask

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

dstAccessMask

public VkSubpassDependency dstAccessMask(@Bitmask(VkAccessFlags.class)
 int value)

dependencyFlags

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

dependencyFlags

public VkSubpassDependency dependencyFlags(@Bitmask(VkDependencyFlags.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