Record Class VkPhysicalDevicePipelineBinaryPropertiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDevicePipelineBinaryPropertiesKHR

All Implemented Interfaces:

IPointer, IVkPhysicalDevicePipelineBinaryPropertiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDevicePipelineBinaryPropertiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDevicePipelineBinaryPropertiesKHR

Represents a pointer to a VkPhysicalDevicePipelineBinaryPropertiesKHR structure in native memory.

Structure

typedef struct VkPhysicalDevicePipelineBinaryPropertiesKHR {
    VkStructureType sType;
    void* pNext; // optional
    VkBool32 pipelineBinaryInternalCache;
    VkBool32 pipelineBinaryInternalCacheControl;
    VkBool32 pipelineBinaryPrefersInternalCache;
    VkBool32 pipelineBinaryPrecompiledInternalCache;
    VkBool32 pipelineBinaryCompressedData;
} VkPhysicalDevicePipelineBinaryPropertiesKHR;

Auto initialization

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

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

• VkPhysicalDevicePipelineBinaryPropertiesKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDevicePipelineBinaryPropertiesKHR	allocate(Arena arena)
static VkPhysicalDevicePipelineBinaryPropertiesKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPhysicalDevicePipelineBinaryPropertiesKHR	clone(Arena arena, VkPhysicalDevicePipelineBinaryPropertiesKHR 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	pipelineBinaryCompressedData()
VkPhysicalDevicePipelineBinaryPropertiesKHR	pipelineBinaryCompressedData(int value)
int	pipelineBinaryInternalCache()
VkPhysicalDevicePipelineBinaryPropertiesKHR	pipelineBinaryInternalCache(int value)
int	pipelineBinaryInternalCacheControl()
VkPhysicalDevicePipelineBinaryPropertiesKHR	pipelineBinaryInternalCacheControl(int value)
int	pipelineBinaryPrecompiledInternalCache()
VkPhysicalDevicePipelineBinaryPropertiesKHR	pipelineBinaryPrecompiledInternalCache(int value)
int	pipelineBinaryPrefersInternalCache()
VkPhysicalDevicePipelineBinaryPropertiesKHR	pipelineBinaryPrefersInternalCache(int value)
MemorySegment	pNext()
VkPhysicalDevicePipelineBinaryPropertiesKHR	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkPhysicalDevicePipelineBinaryPropertiesKHR	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$pipelineBinaryInternalCache

public static final MemoryLayout.PathElement PATH$pipelineBinaryInternalCache

PATH$pipelineBinaryInternalCacheControl

public static final MemoryLayout.PathElement PATH$pipelineBinaryInternalCacheControl

PATH$pipelineBinaryPrefersInternalCache

public static final MemoryLayout.PathElement PATH$pipelineBinaryPrefersInternalCache

PATH$pipelineBinaryPrecompiledInternalCache

public static final MemoryLayout.PathElement PATH$pipelineBinaryPrecompiledInternalCache

PATH$pipelineBinaryCompressedData

public static final MemoryLayout.PathElement PATH$pipelineBinaryCompressedData

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$pipelineBinaryInternalCache

public static final ValueLayout.OfInt LAYOUT$pipelineBinaryInternalCache

LAYOUT$pipelineBinaryInternalCacheControl

public static final ValueLayout.OfInt LAYOUT$pipelineBinaryInternalCacheControl

LAYOUT$pipelineBinaryPrefersInternalCache

public static final ValueLayout.OfInt LAYOUT$pipelineBinaryPrefersInternalCache

LAYOUT$pipelineBinaryPrecompiledInternalCache

public static final ValueLayout.OfInt LAYOUT$pipelineBinaryPrecompiledInternalCache

LAYOUT$pipelineBinaryCompressedData

public static final ValueLayout.OfInt LAYOUT$pipelineBinaryCompressedData

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$pipelineBinaryInternalCache

public static final long SIZE$pipelineBinaryInternalCache

SIZE$pipelineBinaryInternalCacheControl

public static final long SIZE$pipelineBinaryInternalCacheControl

SIZE$pipelineBinaryPrefersInternalCache

public static final long SIZE$pipelineBinaryPrefersInternalCache

SIZE$pipelineBinaryPrecompiledInternalCache

public static final long SIZE$pipelineBinaryPrecompiledInternalCache

SIZE$pipelineBinaryCompressedData

public static final long SIZE$pipelineBinaryCompressedData

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$pipelineBinaryInternalCache

public static final long OFFSET$pipelineBinaryInternalCache

OFFSET$pipelineBinaryInternalCacheControl

public static final long OFFSET$pipelineBinaryInternalCacheControl

OFFSET$pipelineBinaryPrefersInternalCache

public static final long OFFSET$pipelineBinaryPrefersInternalCache

OFFSET$pipelineBinaryPrecompiledInternalCache

public static final long OFFSET$pipelineBinaryPrecompiledInternalCache

OFFSET$pipelineBinaryCompressedData

public static final long OFFSET$pipelineBinaryCompressedData

Constructor Details

VkPhysicalDevicePipelineBinaryPropertiesKHR

public VkPhysicalDevicePipelineBinaryPropertiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDevicePipelineBinaryPropertiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDevicePipelineBinaryPropertiesKHR allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDevicePipelineBinaryPropertiesKHR clone(Arena arena,
 VkPhysicalDevicePipelineBinaryPropertiesKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDevicePipelineBinaryPropertiesKHR pNext(@Nullable
 @Nullable IPointer pointer)

pipelineBinaryInternalCache

@NativeType("VkBool32")
@Unsigned
public int pipelineBinaryInternalCache()

pipelineBinaryInternalCache

public VkPhysicalDevicePipelineBinaryPropertiesKHR pipelineBinaryInternalCache(@NativeType("VkBool32") @Unsigned
 int value)

pipelineBinaryInternalCacheControl

@NativeType("VkBool32")
@Unsigned
public int pipelineBinaryInternalCacheControl()

pipelineBinaryInternalCacheControl

public VkPhysicalDevicePipelineBinaryPropertiesKHR pipelineBinaryInternalCacheControl(@NativeType("VkBool32") @Unsigned
 int value)

pipelineBinaryPrefersInternalCache

@NativeType("VkBool32")
@Unsigned
public int pipelineBinaryPrefersInternalCache()

pipelineBinaryPrefersInternalCache

public VkPhysicalDevicePipelineBinaryPropertiesKHR pipelineBinaryPrefersInternalCache(@NativeType("VkBool32") @Unsigned
 int value)

pipelineBinaryPrecompiledInternalCache

@NativeType("VkBool32")
@Unsigned
public int pipelineBinaryPrecompiledInternalCache()

pipelineBinaryPrecompiledInternalCache

public VkPhysicalDevicePipelineBinaryPropertiesKHR pipelineBinaryPrecompiledInternalCache(@NativeType("VkBool32") @Unsigned
 int value)

pipelineBinaryCompressedData

@NativeType("VkBool32")
@Unsigned
public int pipelineBinaryCompressedData()

pipelineBinaryCompressedData

public VkPhysicalDevicePipelineBinaryPropertiesKHR pipelineBinaryCompressedData(@NativeType("VkBool32") @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