Record Class VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

Represents a pointer to a VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR structure in native memory.

Structure

typedef struct VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR {
    VkStructureType sType;
    void* pNext; // optional
    VkBool32 workgroupMemoryExplicitLayout;
    VkBool32 workgroupMemoryExplicitLayoutScalarBlockLayout;
    VkBool32 workgroupMemoryExplicitLayout8BitAccess;
    VkBool32 workgroupMemoryExplicitLayout16BitAccess;
} VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR;

Auto initialization

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

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

• VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Ptr	Represents a pointer to / an array of VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$workgroupMemoryExplicitLayout
static final ValueLayout.OfInt	LAYOUT$workgroupMemoryExplicitLayout16BitAccess
static final ValueLayout.OfInt	LAYOUT$workgroupMemoryExplicitLayout8BitAccess
static final ValueLayout.OfInt	LAYOUT$workgroupMemoryExplicitLayoutScalarBlockLayout
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final long	OFFSET$workgroupMemoryExplicitLayout
static final long	OFFSET$workgroupMemoryExplicitLayout16BitAccess
static final long	OFFSET$workgroupMemoryExplicitLayout8BitAccess
static final long	OFFSET$workgroupMemoryExplicitLayoutScalarBlockLayout
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$workgroupMemoryExplicitLayout
static final MemoryLayout.PathElement	PATH$workgroupMemoryExplicitLayout16BitAccess
static final MemoryLayout.PathElement	PATH$workgroupMemoryExplicitLayout8BitAccess
static final MemoryLayout.PathElement	PATH$workgroupMemoryExplicitLayoutScalarBlockLayout
static final long	SIZE$pNext
static final long	SIZE$sType
static final long	SIZE$workgroupMemoryExplicitLayout
static final long	SIZE$workgroupMemoryExplicitLayout16BitAccess
static final long	SIZE$workgroupMemoryExplicitLayout8BitAccess
static final long	SIZE$workgroupMemoryExplicitLayoutScalarBlockLayout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	allocate(Arena arena)
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	clone(Arena arena, VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR 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.
MemorySegment	pNext()
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	workgroupMemoryExplicitLayout()
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayout(int value)
int	workgroupMemoryExplicitLayout16BitAccess()
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayout16BitAccess(int value)
int	workgroupMemoryExplicitLayout8BitAccess()
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayout8BitAccess(int value)
int	workgroupMemoryExplicitLayoutScalarBlockLayout()
VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR	workgroupMemoryExplicitLayoutScalarBlockLayout(int value)

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

public static final MemoryLayout.PathElement PATH$workgroupMemoryExplicitLayout

PATH$workgroupMemoryExplicitLayoutScalarBlockLayout

public static final MemoryLayout.PathElement PATH$workgroupMemoryExplicitLayoutScalarBlockLayout

PATH$workgroupMemoryExplicitLayout8BitAccess

public static final MemoryLayout.PathElement PATH$workgroupMemoryExplicitLayout8BitAccess

PATH$workgroupMemoryExplicitLayout16BitAccess

public static final MemoryLayout.PathElement PATH$workgroupMemoryExplicitLayout16BitAccess

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$workgroupMemoryExplicitLayout

public static final ValueLayout.OfInt LAYOUT$workgroupMemoryExplicitLayout

LAYOUT$workgroupMemoryExplicitLayoutScalarBlockLayout

public static final ValueLayout.OfInt LAYOUT$workgroupMemoryExplicitLayoutScalarBlockLayout

LAYOUT$workgroupMemoryExplicitLayout8BitAccess

public static final ValueLayout.OfInt LAYOUT$workgroupMemoryExplicitLayout8BitAccess

LAYOUT$workgroupMemoryExplicitLayout16BitAccess

public static final ValueLayout.OfInt LAYOUT$workgroupMemoryExplicitLayout16BitAccess

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$workgroupMemoryExplicitLayout

public static final long SIZE$workgroupMemoryExplicitLayout

SIZE$workgroupMemoryExplicitLayoutScalarBlockLayout

public static final long SIZE$workgroupMemoryExplicitLayoutScalarBlockLayout

SIZE$workgroupMemoryExplicitLayout8BitAccess

public static final long SIZE$workgroupMemoryExplicitLayout8BitAccess

SIZE$workgroupMemoryExplicitLayout16BitAccess

public static final long SIZE$workgroupMemoryExplicitLayout16BitAccess

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$workgroupMemoryExplicitLayout

public static final long OFFSET$workgroupMemoryExplicitLayout

OFFSET$workgroupMemoryExplicitLayoutScalarBlockLayout

public static final long OFFSET$workgroupMemoryExplicitLayoutScalarBlockLayout

OFFSET$workgroupMemoryExplicitLayout8BitAccess

public static final long OFFSET$workgroupMemoryExplicitLayout8BitAccess

OFFSET$workgroupMemoryExplicitLayout16BitAccess

public static final long OFFSET$workgroupMemoryExplicitLayout16BitAccess

Constructor Details

VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR clone(Arena arena,
 VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR pNext(@Nullable
 @Nullable IPointer pointer)

workgroupMemoryExplicitLayout

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

workgroupMemoryExplicitLayout

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayout(@NativeType("VkBool32") @Unsigned
 int value)

workgroupMemoryExplicitLayoutScalarBlockLayout

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

workgroupMemoryExplicitLayoutScalarBlockLayout

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayoutScalarBlockLayout(@NativeType("VkBool32") @Unsigned
 int value)

workgroupMemoryExplicitLayout8BitAccess

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

workgroupMemoryExplicitLayout8BitAccess

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayout8BitAccess(@NativeType("VkBool32") @Unsigned
 int value)

workgroupMemoryExplicitLayout16BitAccess

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

workgroupMemoryExplicitLayout16BitAccess

public VkPhysicalDeviceWorkgroupMemoryExplicitLayoutFeaturesKHR workgroupMemoryExplicitLayout16BitAccess(@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