Record Class VkMemoryBarrier2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkMemoryBarrier2

All Implemented Interfaces:

IPointer, IVkMemoryBarrier2

@ValueBasedCandidate
@UnsafeConstructor
public record VkMemoryBarrier2(@NotNull MemorySegment segment)
extends Record
implements IVkMemoryBarrier2

Represents a pointer to a VkMemoryBarrier2 structure in native memory.

Structure

typedef struct VkMemoryBarrier2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkPipelineStageFlags2 srcStageMask; // optional
    VkAccessFlags2 srcAccessMask; // optional
    VkPipelineStageFlags2 dstStageMask; // optional
    VkAccessFlags2 dstAccessMask; // optional
} VkMemoryBarrier2;

Auto initialization

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

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

• VkMemoryBarrier2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkMemoryBarrier2.Ptr	Represents a pointer to / an array of VkMemoryBarrier2 structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$dstAccessMask
static final ValueLayout.OfLong	LAYOUT$dstStageMask
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfLong	LAYOUT$srcAccessMask
static final ValueLayout.OfLong	LAYOUT$srcStageMask
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$dstAccessMask
static final long	OFFSET$dstStageMask
static final long	OFFSET$pNext
static final long	OFFSET$srcAccessMask
static final long	OFFSET$srcStageMask
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$dstAccessMask
static final MemoryLayout.PathElement	PATH$dstStageMask
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$srcAccessMask
static final MemoryLayout.PathElement	PATH$srcStageMask
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$dstAccessMask
static final long	SIZE$dstStageMask
static final long	SIZE$pNext
static final long	SIZE$srcAccessMask
static final long	SIZE$srcStageMask
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkMemoryBarrier2	allocate(Arena arena)
static VkMemoryBarrier2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkMemoryBarrier2	clone(Arena arena, VkMemoryBarrier2 src)
long	dstAccessMask()
VkMemoryBarrier2	dstAccessMask(long value)
long	dstStageMask()
VkMemoryBarrier2	dstStageMask(long 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()
VkMemoryBarrier2	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	srcAccessMask()
VkMemoryBarrier2	srcAccessMask(long value)
long	srcStageMask()
VkMemoryBarrier2	srcStageMask(long value)
int	sType()
VkMemoryBarrier2	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$srcStageMask

public static final MemoryLayout.PathElement PATH$srcStageMask

PATH$srcAccessMask

public static final MemoryLayout.PathElement PATH$srcAccessMask

PATH$dstStageMask

public static final MemoryLayout.PathElement PATH$dstStageMask

PATH$dstAccessMask

public static final MemoryLayout.PathElement PATH$dstAccessMask

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcStageMask

public static final ValueLayout.OfLong LAYOUT$srcStageMask

LAYOUT$srcAccessMask

public static final ValueLayout.OfLong LAYOUT$srcAccessMask

LAYOUT$dstStageMask

public static final ValueLayout.OfLong LAYOUT$dstStageMask

LAYOUT$dstAccessMask

public static final ValueLayout.OfLong LAYOUT$dstAccessMask

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcStageMask

public static final long SIZE$srcStageMask

SIZE$srcAccessMask

public static final long SIZE$srcAccessMask

SIZE$dstStageMask

public static final long SIZE$dstStageMask

SIZE$dstAccessMask

public static final long SIZE$dstAccessMask

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcStageMask

public static final long OFFSET$srcStageMask

OFFSET$srcAccessMask

public static final long OFFSET$srcAccessMask

OFFSET$dstStageMask

public static final long OFFSET$dstStageMask

OFFSET$dstAccessMask

public static final long OFFSET$dstAccessMask

Constructor Details

VkMemoryBarrier2

public VkMemoryBarrier2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkMemoryBarrier2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkMemoryBarrier2 allocate(Arena arena)

allocate

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

clone

public static VkMemoryBarrier2 clone(Arena arena,
 VkMemoryBarrier2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkMemoryBarrier2 pNext(@Nullable
 @Nullable IPointer pointer)

srcStageMask

@EnumType(VkPipelineStageFlags2.class)
public long srcStageMask()

srcStageMask

public VkMemoryBarrier2 srcStageMask(@EnumType(VkPipelineStageFlags2.class)
 long value)

srcAccessMask

@EnumType(VkAccessFlags2.class)
public long srcAccessMask()

srcAccessMask

public VkMemoryBarrier2 srcAccessMask(@EnumType(VkAccessFlags2.class)
 long value)

dstStageMask

@EnumType(VkPipelineStageFlags2.class)
public long dstStageMask()

dstStageMask

public VkMemoryBarrier2 dstStageMask(@EnumType(VkPipelineStageFlags2.class)
 long value)

dstAccessMask

@EnumType(VkAccessFlags2.class)
public long dstAccessMask()

dstAccessMask

public VkMemoryBarrier2 dstAccessMask(@EnumType(VkAccessFlags2.class)
 long 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