Record Class VkInstanceCreateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkInstanceCreateInfo

All Implemented Interfaces:

IPointer, IVkInstanceCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkInstanceCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkInstanceCreateInfo

Represents a pointer to a VkInstanceCreateInfo structure in native memory.

Structure

typedef struct VkInstanceCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkInstanceCreateFlags flags; // optional
    VkApplicationInfo const* pApplicationInfo; // optional
    uint32_t enabledLayerCount; // optional
    char const* const* ppEnabledLayerNames;
    uint32_t enabledExtensionCount; // optional
    char const* const* ppEnabledExtensionNames;
} VkInstanceCreateInfo;

Auto initialization

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

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

• VkInstanceCreateInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkInstanceCreateInfo.Ptr	Represents a pointer to / an array of VkInstanceCreateInfo 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$enabledExtensionCount
static final ValueLayout.OfInt	LAYOUT$enabledLayerCount
static final ValueLayout.OfInt	LAYOUT$flags
static final AddressLayout	LAYOUT$pApplicationInfo
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$ppEnabledExtensionNames
static final AddressLayout	LAYOUT$ppEnabledLayerNames
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$enabledExtensionCount
static final long	OFFSET$enabledLayerCount
static final long	OFFSET$flags
static final long	OFFSET$pApplicationInfo
static final long	OFFSET$pNext
static final long	OFFSET$ppEnabledExtensionNames
static final long	OFFSET$ppEnabledLayerNames
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$enabledExtensionCount
static final MemoryLayout.PathElement	PATH$enabledLayerCount
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pApplicationInfo
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$ppEnabledExtensionNames
static final MemoryLayout.PathElement	PATH$ppEnabledLayerNames
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$enabledExtensionCount
static final long	SIZE$enabledLayerCount
static final long	SIZE$flags
static final long	SIZE$pApplicationInfo
static final long	SIZE$pNext
static final long	SIZE$ppEnabledExtensionNames
static final long	SIZE$ppEnabledLayerNames
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$pApplicationInfo

PATH$enabledLayerCount

public static final MemoryLayout.PathElement PATH$enabledLayerCount

PATH$ppEnabledLayerNames

public static final MemoryLayout.PathElement PATH$ppEnabledLayerNames

PATH$enabledExtensionCount

public static final MemoryLayout.PathElement PATH$enabledExtensionCount

PATH$ppEnabledExtensionNames

public static final MemoryLayout.PathElement PATH$ppEnabledExtensionNames

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

public static final AddressLayout LAYOUT$pApplicationInfo

LAYOUT$enabledLayerCount

public static final ValueLayout.OfInt LAYOUT$enabledLayerCount

LAYOUT$ppEnabledLayerNames

public static final AddressLayout LAYOUT$ppEnabledLayerNames

LAYOUT$enabledExtensionCount

public static final ValueLayout.OfInt LAYOUT$enabledExtensionCount

LAYOUT$ppEnabledExtensionNames

public static final AddressLayout LAYOUT$ppEnabledExtensionNames

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

public static final long SIZE$pApplicationInfo

SIZE$enabledLayerCount

public static final long SIZE$enabledLayerCount

SIZE$ppEnabledLayerNames

public static final long SIZE$ppEnabledLayerNames

SIZE$enabledExtensionCount

public static final long SIZE$enabledExtensionCount

SIZE$ppEnabledExtensionNames

public static final long SIZE$ppEnabledExtensionNames

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

public static final long OFFSET$pApplicationInfo

OFFSET$enabledLayerCount

public static final long OFFSET$enabledLayerCount

OFFSET$ppEnabledLayerNames

public static final long OFFSET$ppEnabledLayerNames

OFFSET$enabledExtensionCount

public static final long OFFSET$enabledExtensionCount

OFFSET$ppEnabledExtensionNames

public static final long OFFSET$ppEnabledExtensionNames

Constructor Details

VkInstanceCreateInfo

public VkInstanceCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkInstanceCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkInstanceCreateInfo allocate(Arena arena)

allocate

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

clone

public static VkInstanceCreateInfo clone(Arena arena,
 VkInstanceCreateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkInstanceCreateInfo pNext(@Nullable
 @Nullable IPointer pointer)

flags

@EnumType(VkInstanceCreateFlags.class)
public int flags()

flags

public VkInstanceCreateInfo flags(@EnumType(VkInstanceCreateFlags.class)
 int value)

pApplicationInfo

public VkInstanceCreateInfo pApplicationInfo(@Nullable
 @Nullable IVkApplicationInfo value)

pApplicationInfo

@Unsafe
@Nullable
public VkApplicationInfo.Ptr pApplicationInfo(int assumedCount)

pApplicationInfo

@Nullable
public @Nullable VkApplicationInfo pApplicationInfo()

pApplicationInfoRaw

@Pointer(target=VkApplicationInfo.class)
public MemorySegment pApplicationInfoRaw()

pApplicationInfoRaw

public void pApplicationInfoRaw(@Pointer(target=VkApplicationInfo.class)
 MemorySegment value)

enabledLayerCount

@Unsigned
public int enabledLayerCount()

enabledLayerCount

public VkInstanceCreateInfo enabledLayerCount(@Unsigned
 int value)

ppEnabledLayerNames

@Nullable
public @Nullable PointerPtr ppEnabledLayerNames()

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

ppEnabledLayerNames

public VkInstanceCreateInfo ppEnabledLayerNames(@Nullable
 @Nullable PointerPtr value)

ppEnabledLayerNamesRaw

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

ppEnabledLayerNamesRaw

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

enabledExtensionCount

@Unsigned
public int enabledExtensionCount()

enabledExtensionCount

public VkInstanceCreateInfo enabledExtensionCount(@Unsigned
 int value)

ppEnabledExtensionNames

@Nullable
public @Nullable PointerPtr ppEnabledExtensionNames()

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

ppEnabledExtensionNames

public VkInstanceCreateInfo ppEnabledExtensionNames(@Nullable
 @Nullable PointerPtr value)

ppEnabledExtensionNamesRaw

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

ppEnabledExtensionNamesRaw

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