Record Class VkBufferCreateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBufferCreateInfo

All Implemented Interfaces:

IPointer, IVkBufferCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkBufferCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkBufferCreateInfo

Represents a pointer to a VkBufferCreateInfo structure in native memory.

Structure

typedef struct VkBufferCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkBufferCreateFlags flags; // optional
    VkDeviceSize size;
    VkBufferUsageFlags usage;
    VkSharingMode sharingMode;
    uint32_t queueFamilyIndexCount; // optional
    uint32_t const* pQueueFamilyIndices; // optional
} VkBufferCreateInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO

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:

• VkBufferCreateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkBufferCreateInfo.Ptr	Represents a pointer to / an array of VkBufferCreateInfo 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$flags
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pQueueFamilyIndices
static final ValueLayout.OfInt	LAYOUT$queueFamilyIndexCount
static final ValueLayout.OfInt	LAYOUT$sharingMode
static final ValueLayout.OfLong	LAYOUT$size
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$usage
static final long	OFFSET$flags
static final long	OFFSET$pNext
static final long	OFFSET$pQueueFamilyIndices
static final long	OFFSET$queueFamilyIndexCount
static final long	OFFSET$sharingMode
static final long	OFFSET$size
static final long	OFFSET$sType
static final long	OFFSET$usage
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pQueueFamilyIndices
static final MemoryLayout.PathElement	PATH$queueFamilyIndexCount
static final MemoryLayout.PathElement	PATH$sharingMode
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$usage
static final long	SIZE$flags
static final long	SIZE$pNext
static final long	SIZE$pQueueFamilyIndices
static final long	SIZE$queueFamilyIndexCount
static final long	SIZE$sharingMode
static final long	SIZE$size
static final long	SIZE$sType
static final long	SIZE$usage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBufferCreateInfo	allocate(Arena arena)
static VkBufferCreateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkBufferCreateInfo	clone(Arena arena, VkBufferCreateInfo src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	flags()
VkBufferCreateInfo	flags(int value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	pNext()
VkBufferCreateInfo	pNext(@Nullable IPointer pointer)
VkBufferCreateInfo	pNext(@NotNull MemorySegment value)
@Nullable IntPtr	pQueueFamilyIndices()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkBufferCreateInfo	pQueueFamilyIndices(@Nullable IntPtr value)
@NotNull MemorySegment	pQueueFamilyIndicesRaw()
void	pQueueFamilyIndicesRaw(@NotNull MemorySegment value)
int	queueFamilyIndexCount()
VkBufferCreateInfo	queueFamilyIndexCount(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sharingMode()
VkBufferCreateInfo	sharingMode(int value)
long	size()
VkBufferCreateInfo	size(long value)
int	sType()
VkBufferCreateInfo	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	usage()
VkBufferCreateInfo	usage(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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$usage

public static final MemoryLayout.PathElement PATH$usage

PATH$sharingMode

public static final MemoryLayout.PathElement PATH$sharingMode

PATH$queueFamilyIndexCount

public static final MemoryLayout.PathElement PATH$queueFamilyIndexCount

PATH$pQueueFamilyIndices

public static final MemoryLayout.PathElement PATH$pQueueFamilyIndices

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

LAYOUT$usage

public static final ValueLayout.OfInt LAYOUT$usage

LAYOUT$sharingMode

public static final ValueLayout.OfInt LAYOUT$sharingMode

LAYOUT$queueFamilyIndexCount

public static final ValueLayout.OfInt LAYOUT$queueFamilyIndexCount

LAYOUT$pQueueFamilyIndices

public static final AddressLayout LAYOUT$pQueueFamilyIndices

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$flags

public static final long SIZE$flags

SIZE$size

public static final long SIZE$size

SIZE$usage

public static final long SIZE$usage

SIZE$sharingMode

public static final long SIZE$sharingMode

SIZE$queueFamilyIndexCount

public static final long SIZE$queueFamilyIndexCount

SIZE$pQueueFamilyIndices

public static final long SIZE$pQueueFamilyIndices

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$flags

public static final long OFFSET$flags

OFFSET$size

public static final long OFFSET$size

OFFSET$usage

public static final long OFFSET$usage

OFFSET$sharingMode

public static final long OFFSET$sharingMode

OFFSET$queueFamilyIndexCount

public static final long OFFSET$queueFamilyIndexCount

OFFSET$pQueueFamilyIndices

public static final long OFFSET$pQueueFamilyIndices

Constructor Details

VkBufferCreateInfo

public VkBufferCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBufferCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBufferCreateInfo allocate(Arena arena)

allocate

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

clone

public static VkBufferCreateInfo clone(Arena arena,
 VkBufferCreateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBufferCreateInfo pNext(@Nullable
 @Nullable IPointer pointer)

flags

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

flags

public VkBufferCreateInfo flags(@Bitmask(VkBufferCreateFlags.class)
 int value)

size

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

size

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

usage

@Bitmask(VkBufferUsageFlags.class)
public int usage()

usage

public VkBufferCreateInfo usage(@Bitmask(VkBufferUsageFlags.class)
 int value)

sharingMode

@EnumType(VkSharingMode.class)
public int sharingMode()

sharingMode

public VkBufferCreateInfo sharingMode(@EnumType(VkSharingMode.class)
 int value)

queueFamilyIndexCount

@Unsigned
public int queueFamilyIndexCount()

queueFamilyIndexCount

public VkBufferCreateInfo queueFamilyIndexCount(@Unsigned
 int value)

pQueueFamilyIndices

@Nullable
@Unsigned
public @Nullable IntPtr pQueueFamilyIndices()

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.

pQueueFamilyIndices

public VkBufferCreateInfo pQueueFamilyIndices(@Nullable @Unsigned
 @Nullable IntPtr value)

pQueueFamilyIndicesRaw

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

pQueueFamilyIndicesRaw

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