Record Class VkPipelineLibraryCreateInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPipelineLibraryCreateInfoKHR

All Implemented Interfaces:

IPointer, IVkPipelineLibraryCreateInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPipelineLibraryCreateInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPipelineLibraryCreateInfoKHR

Represents a pointer to a VkPipelineLibraryCreateInfoKHR structure in native memory.

Structure

typedef struct VkPipelineLibraryCreateInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t libraryCount; // optional
    VkPipeline const* pLibraries;
} VkPipelineLibraryCreateInfoKHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_PIPELINE_LIBRARY_CREATE_INFO_KHR

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:

• VkPipelineLibraryCreateInfoKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPipelineLibraryCreateInfoKHR	allocate(Arena arena)
static VkPipelineLibraryCreateInfoKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPipelineLibraryCreateInfoKHR	clone(Arena arena, VkPipelineLibraryCreateInfoKHR src)
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.
int	libraryCount()
VkPipelineLibraryCreateInfoKHR	libraryCount(int value)
VkPipeline.Ptr	pLibraries()	Note: the returned VkPipeline.Ptr does not have correct VkPipeline.Ptr.size() property.
VkPipelineLibraryCreateInfoKHR	pLibraries(VkPipeline.Ptr value)
MemorySegment	pLibrariesRaw()
void	pLibrariesRaw(MemorySegment value)
MemorySegment	pNext()
VkPipelineLibraryCreateInfoKHR	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkPipelineLibraryCreateInfoKHR	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$libraryCount

public static final MemoryLayout.PathElement PATH$libraryCount

PATH$pLibraries

public static final MemoryLayout.PathElement PATH$pLibraries

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$libraryCount

public static final ValueLayout.OfInt LAYOUT$libraryCount

LAYOUT$pLibraries

public static final AddressLayout LAYOUT$pLibraries

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$libraryCount

public static final long SIZE$libraryCount

SIZE$pLibraries

public static final long SIZE$pLibraries

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$libraryCount

public static final long OFFSET$libraryCount

OFFSET$pLibraries

public static final long OFFSET$pLibraries

Constructor Details

VkPipelineLibraryCreateInfoKHR

public VkPipelineLibraryCreateInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPipelineLibraryCreateInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPipelineLibraryCreateInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkPipelineLibraryCreateInfoKHR clone(Arena arena,
 VkPipelineLibraryCreateInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPipelineLibraryCreateInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

libraryCount

@Unsigned
public int libraryCount()

libraryCount

public VkPipelineLibraryCreateInfoKHR libraryCount(@Unsigned
 int value)

pLibraries

@Nullable
public VkPipeline.Ptr pLibraries()

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

pLibraries

public VkPipelineLibraryCreateInfoKHR pLibraries(@Nullable
 VkPipeline.Ptr value)

pLibrariesRaw

@Pointer(target=VkPipeline.class)
public MemorySegment pLibrariesRaw()

pLibrariesRaw

public void pLibrariesRaw(@Pointer(target=VkPipeline.class)
 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