Record Class VkBufferMemoryBarrier

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBufferMemoryBarrier

All Implemented Interfaces:

IPointer, IVkBufferMemoryBarrier

@ValueBasedCandidate
@UnsafeConstructor
public record VkBufferMemoryBarrier(@NotNull MemorySegment segment)
extends Record
implements IVkBufferMemoryBarrier

Represents a pointer to a VkBufferMemoryBarrier structure in native memory.

Structure

typedef struct VkBufferMemoryBarrier {
    VkStructureType sType;
    void const* pNext; // optional
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
    uint32_t srcQueueFamilyIndex;
    uint32_t dstQueueFamilyIndex;
    VkBuffer buffer;
    VkDeviceSize offset;
    VkDeviceSize size;
} VkBufferMemoryBarrier;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER

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:

• VkBufferMemoryBarrier

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$buffer
static final ValueLayout.OfInt	LAYOUT$dstAccessMask
static final ValueLayout.OfInt	LAYOUT$dstQueueFamilyIndex
static final ValueLayout.OfLong	LAYOUT$offset
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfLong	LAYOUT$size
static final ValueLayout.OfInt	LAYOUT$srcAccessMask
static final ValueLayout.OfInt	LAYOUT$srcQueueFamilyIndex
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$buffer
static final long	OFFSET$dstAccessMask
static final long	OFFSET$dstQueueFamilyIndex
static final long	OFFSET$offset
static final long	OFFSET$pNext
static final long	OFFSET$size
static final long	OFFSET$srcAccessMask
static final long	OFFSET$srcQueueFamilyIndex
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$dstAccessMask
static final MemoryLayout.PathElement	PATH$dstQueueFamilyIndex
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$srcAccessMask
static final MemoryLayout.PathElement	PATH$srcQueueFamilyIndex
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$buffer
static final long	SIZE$dstAccessMask
static final long	SIZE$dstQueueFamilyIndex
static final long	SIZE$offset
static final long	SIZE$pNext
static final long	SIZE$size
static final long	SIZE$srcAccessMask
static final long	SIZE$srcQueueFamilyIndex
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$srcAccessMask

PATH$dstAccessMask

public static final MemoryLayout.PathElement PATH$dstAccessMask

PATH$srcQueueFamilyIndex

public static final MemoryLayout.PathElement PATH$srcQueueFamilyIndex

PATH$dstQueueFamilyIndex

public static final MemoryLayout.PathElement PATH$dstQueueFamilyIndex

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$size

public static final MemoryLayout.PathElement PATH$size

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcAccessMask

public static final ValueLayout.OfInt LAYOUT$srcAccessMask

LAYOUT$dstAccessMask

public static final ValueLayout.OfInt LAYOUT$dstAccessMask

LAYOUT$srcQueueFamilyIndex

public static final ValueLayout.OfInt LAYOUT$srcQueueFamilyIndex

LAYOUT$dstQueueFamilyIndex

public static final ValueLayout.OfInt LAYOUT$dstQueueFamilyIndex

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcAccessMask

public static final long SIZE$srcAccessMask

SIZE$dstAccessMask

public static final long SIZE$dstAccessMask

SIZE$srcQueueFamilyIndex

public static final long SIZE$srcQueueFamilyIndex

SIZE$dstQueueFamilyIndex

public static final long SIZE$dstQueueFamilyIndex

SIZE$buffer

public static final long SIZE$buffer

SIZE$offset

public static final long SIZE$offset

SIZE$size

public static final long SIZE$size

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcAccessMask

public static final long OFFSET$srcAccessMask

OFFSET$dstAccessMask

public static final long OFFSET$dstAccessMask

OFFSET$srcQueueFamilyIndex

public static final long OFFSET$srcQueueFamilyIndex

OFFSET$dstQueueFamilyIndex

public static final long OFFSET$dstQueueFamilyIndex

OFFSET$buffer

public static final long OFFSET$buffer

OFFSET$offset

public static final long OFFSET$offset

OFFSET$size

public static final long OFFSET$size

Constructor Details

VkBufferMemoryBarrier

public VkBufferMemoryBarrier(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBufferMemoryBarrier record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBufferMemoryBarrier allocate(Arena arena)

allocate

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

clone

public static VkBufferMemoryBarrier clone(Arena arena,
 VkBufferMemoryBarrier src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBufferMemoryBarrier pNext(@Nullable
 @Nullable IPointer pointer)

srcAccessMask

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

srcAccessMask

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

dstAccessMask

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

dstAccessMask

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

srcQueueFamilyIndex

@Unsigned
public int srcQueueFamilyIndex()

srcQueueFamilyIndex

public VkBufferMemoryBarrier srcQueueFamilyIndex(@Unsigned
 int value)

dstQueueFamilyIndex

@Unsigned
public int dstQueueFamilyIndex()

dstQueueFamilyIndex

public VkBufferMemoryBarrier dstQueueFamilyIndex(@Unsigned
 int value)

buffer

@Nullable
public @Nullable VkBuffer buffer()

buffer

public VkBufferMemoryBarrier buffer(@Nullable
 @Nullable VkBuffer value)

offset

@NativeType("VkDeviceSize")
@Unsigned
public long offset()

offset

public VkBufferMemoryBarrier offset(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

@NativeType("VkDeviceSize")
@Unsigned
public long size()

size

public VkBufferMemoryBarrier size(@NativeType("VkDeviceSize") @Unsigned
 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