Record Class VkApplicationInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkApplicationInfo

All Implemented Interfaces:

IPointer, IVkApplicationInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkApplicationInfo(@NotNull MemorySegment segment)
extends Record
implements IVkApplicationInfo

Represents a pointer to a VkApplicationInfo structure in native memory.

Structure

typedef struct VkApplicationInfo {
    VkStructureType sType;
    void const* pNext; // optional
    char const* pApplicationName; // optional
    uint32_t applicationVersion;
    char const* pEngineName; // optional
    uint32_t engineVersion;
    uint32_t apiVersion;
} VkApplicationInfo;

Auto initialization

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

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

• VkApplicationInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkApplicationInfo.Ptr	Represents a pointer to / an array of VkApplicationInfo 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$apiVersion
static final ValueLayout.OfInt	LAYOUT$applicationVersion
static final ValueLayout.OfInt	LAYOUT$engineVersion
static final AddressLayout	LAYOUT$pApplicationName
static final AddressLayout	LAYOUT$pEngineName
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$apiVersion
static final long	OFFSET$applicationVersion
static final long	OFFSET$engineVersion
static final long	OFFSET$pApplicationName
static final long	OFFSET$pEngineName
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$apiVersion
static final MemoryLayout.PathElement	PATH$applicationVersion
static final MemoryLayout.PathElement	PATH$engineVersion
static final MemoryLayout.PathElement	PATH$pApplicationName
static final MemoryLayout.PathElement	PATH$pEngineName
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$apiVersion
static final long	SIZE$applicationVersion
static final long	SIZE$engineVersion
static final long	SIZE$pApplicationName
static final long	SIZE$pEngineName
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkApplicationInfo	allocate(Arena arena)
static VkApplicationInfo.Ptr	allocate(Arena arena, long count)
int	apiVersion()
VkApplicationInfo	apiVersion(int value)
int	applicationVersion()
VkApplicationInfo	applicationVersion(int value)
void	autoInit()
static VkApplicationInfo	clone(Arena arena, VkApplicationInfo src)
int	engineVersion()
VkApplicationInfo	engineVersion(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.
@Nullable BytePtr	pApplicationName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
VkApplicationInfo	pApplicationName(@Nullable BytePtr value)
@NotNull MemorySegment	pApplicationNameRaw()
void	pApplicationNameRaw(@NotNull MemorySegment value)
@Nullable BytePtr	pEngineName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
VkApplicationInfo	pEngineName(@Nullable BytePtr value)
@NotNull MemorySegment	pEngineNameRaw()
void	pEngineNameRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkApplicationInfo	pNext(@Nullable IPointer pointer)
VkApplicationInfo	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkApplicationInfo	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$pApplicationName

public static final MemoryLayout.PathElement PATH$pApplicationName

PATH$applicationVersion

public static final MemoryLayout.PathElement PATH$applicationVersion

PATH$pEngineName

public static final MemoryLayout.PathElement PATH$pEngineName

PATH$engineVersion

public static final MemoryLayout.PathElement PATH$engineVersion

PATH$apiVersion

public static final MemoryLayout.PathElement PATH$apiVersion

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$pApplicationName

public static final AddressLayout LAYOUT$pApplicationName

LAYOUT$applicationVersion

public static final ValueLayout.OfInt LAYOUT$applicationVersion

LAYOUT$pEngineName

public static final AddressLayout LAYOUT$pEngineName

LAYOUT$engineVersion

public static final ValueLayout.OfInt LAYOUT$engineVersion

LAYOUT$apiVersion

public static final ValueLayout.OfInt LAYOUT$apiVersion

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$pApplicationName

public static final long SIZE$pApplicationName

SIZE$applicationVersion

public static final long SIZE$applicationVersion

SIZE$pEngineName

public static final long SIZE$pEngineName

SIZE$engineVersion

public static final long SIZE$engineVersion

SIZE$apiVersion

public static final long SIZE$apiVersion

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$pApplicationName

public static final long OFFSET$pApplicationName

OFFSET$applicationVersion

public static final long OFFSET$applicationVersion

OFFSET$pEngineName

public static final long OFFSET$pEngineName

OFFSET$engineVersion

public static final long OFFSET$engineVersion

OFFSET$apiVersion

public static final long OFFSET$apiVersion

Constructor Details

VkApplicationInfo

public VkApplicationInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkApplicationInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkApplicationInfo allocate(Arena arena)

allocate

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

clone

public static VkApplicationInfo clone(Arena arena,
 VkApplicationInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkApplicationInfo pNext(@Nullable
 @Nullable IPointer pointer)

pApplicationName

@Nullable
public @Nullable BytePtr pApplicationName()

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

pApplicationName

public VkApplicationInfo pApplicationName(@Nullable
 @Nullable BytePtr value)

pApplicationNameRaw

@Pointer(comment="int8_t*")
@NotNull
public @NotNull MemorySegment pApplicationNameRaw()

pApplicationNameRaw

public void pApplicationNameRaw(@Pointer(comment="int8_t*") @NotNull
 @NotNull MemorySegment value)

applicationVersion

@Unsigned
public int applicationVersion()

applicationVersion

public VkApplicationInfo applicationVersion(@Unsigned
 int value)

pEngineName

@Nullable
public @Nullable BytePtr pEngineName()

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

pEngineName

public VkApplicationInfo pEngineName(@Nullable
 @Nullable BytePtr value)

pEngineNameRaw

@Pointer(comment="int8_t*")
@NotNull
public @NotNull MemorySegment pEngineNameRaw()

pEngineNameRaw

public void pEngineNameRaw(@Pointer(comment="int8_t*") @NotNull
 @NotNull MemorySegment value)

engineVersion

@Unsigned
public int engineVersion()

engineVersion

public VkApplicationInfo engineVersion(@Unsigned
 int value)

apiVersion

@Unsigned
public int apiVersion()

apiVersion

public VkApplicationInfo apiVersion(@Unsigned
 int 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