Record Class VkDeviceQueueCreateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDeviceQueueCreateInfo

All Implemented Interfaces:

IPointer, IVkDeviceQueueCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkDeviceQueueCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkDeviceQueueCreateInfo

Represents a pointer to a VkDeviceQueueCreateInfo structure in native memory.

Structure

typedef struct VkDeviceQueueCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkDeviceQueueCreateFlags flags; // optional
    uint32_t queueFamilyIndex;
    uint32_t queueCount;
    float const* pQueuePriorities;
} VkDeviceQueueCreateInfo;

Auto initialization

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

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

• VkDeviceQueueCreateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDeviceQueueCreateInfo.Ptr	Represents a pointer to / an array of VkDeviceQueueCreateInfo 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$pQueuePriorities
static final ValueLayout.OfInt	LAYOUT$queueCount
static final ValueLayout.OfInt	LAYOUT$queueFamilyIndex
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$flags
static final long	OFFSET$pNext
static final long	OFFSET$pQueuePriorities
static final long	OFFSET$queueCount
static final long	OFFSET$queueFamilyIndex
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pQueuePriorities
static final MemoryLayout.PathElement	PATH$queueCount
static final MemoryLayout.PathElement	PATH$queueFamilyIndex
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$flags
static final long	SIZE$pNext
static final long	SIZE$pQueuePriorities
static final long	SIZE$queueCount
static final long	SIZE$queueFamilyIndex
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$flags

PATH$queueFamilyIndex

public static final MemoryLayout.PathElement PATH$queueFamilyIndex

PATH$queueCount

public static final MemoryLayout.PathElement PATH$queueCount

PATH$pQueuePriorities

public static final MemoryLayout.PathElement PATH$pQueuePriorities

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$queueFamilyIndex

public static final ValueLayout.OfInt LAYOUT$queueFamilyIndex

LAYOUT$queueCount

public static final ValueLayout.OfInt LAYOUT$queueCount

LAYOUT$pQueuePriorities

public static final AddressLayout LAYOUT$pQueuePriorities

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$queueFamilyIndex

public static final long SIZE$queueFamilyIndex

SIZE$queueCount

public static final long SIZE$queueCount

SIZE$pQueuePriorities

public static final long SIZE$pQueuePriorities

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$queueFamilyIndex

public static final long OFFSET$queueFamilyIndex

OFFSET$queueCount

public static final long OFFSET$queueCount

OFFSET$pQueuePriorities

public static final long OFFSET$pQueuePriorities

Constructor Details

VkDeviceQueueCreateInfo

public VkDeviceQueueCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDeviceQueueCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDeviceQueueCreateInfo allocate(Arena arena)

allocate

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

clone

public static VkDeviceQueueCreateInfo clone(Arena arena,
 VkDeviceQueueCreateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDeviceQueueCreateInfo pNext(@Nullable
 @Nullable IPointer pointer)

flags

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

flags

public VkDeviceQueueCreateInfo flags(@Bitmask(VkDeviceQueueCreateFlags.class)
 int value)

queueFamilyIndex

@Unsigned
public int queueFamilyIndex()

queueFamilyIndex

public VkDeviceQueueCreateInfo queueFamilyIndex(@Unsigned
 int value)

queueCount

@Unsigned
public int queueCount()

queueCount

public VkDeviceQueueCreateInfo queueCount(@Unsigned
 int value)

pQueuePriorities

@Nullable
public @Nullable FloatPtr pQueuePriorities()

Note: the returned FloatPtr does not have correct FloatPtr.size() property. It's up to user to track the size of the buffer, and use FloatPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pQueuePriorities

public VkDeviceQueueCreateInfo pQueuePriorities(@Nullable
 @Nullable FloatPtr value)

pQueuePrioritiesRaw

@Pointer(comment="float*")
@NotNull
public @NotNull MemorySegment pQueuePrioritiesRaw()

pQueuePrioritiesRaw

public void pQueuePrioritiesRaw(@Pointer(comment="float*") @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