Record Class VkLayerSettingEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkLayerSettingEXT

All Implemented Interfaces:

IPointer, IVkLayerSettingEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkLayerSettingEXT(@NotNull MemorySegment segment)
extends Record
implements IVkLayerSettingEXT

Represents a pointer to a VkLayerSettingEXT structure in native memory.

Structure

typedef struct VkLayerSettingEXT {
    char const* pLayerName;
    char const* pSettingName;
    VkLayerSettingTypeEXT type;
    uint32_t valueCount; // optional
    void const* pValues; // optional
} VkLayerSettingEXT;

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:

• VkLayerSettingEXT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkLayerSettingEXT.Ptr	Represents a pointer to / an array of VkLayerSettingEXT 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$pLayerName
static final AddressLayout	LAYOUT$pSettingName
static final AddressLayout	LAYOUT$pValues
static final ValueLayout.OfInt	LAYOUT$type
static final ValueLayout.OfInt	LAYOUT$valueCount
static final long	OFFSET$pLayerName
static final long	OFFSET$pSettingName
static final long	OFFSET$pValues
static final long	OFFSET$type
static final long	OFFSET$valueCount
static final MemoryLayout.PathElement	PATH$pLayerName
static final MemoryLayout.PathElement	PATH$pSettingName
static final MemoryLayout.PathElement	PATH$pValues
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$valueCount
static final long	SIZE$pLayerName
static final long	SIZE$pSettingName
static final long	SIZE$pValues
static final long	SIZE$type
static final long	SIZE$valueCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkLayerSettingEXT	allocate(Arena arena)
static VkLayerSettingEXT.Ptr	allocate(Arena arena, long count)
static VkLayerSettingEXT	clone(Arena arena, VkLayerSettingEXT 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.
@Nullable BytePtr	pLayerName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
VkLayerSettingEXT	pLayerName(@Nullable BytePtr value)
@NotNull MemorySegment	pLayerNameRaw()
void	pLayerNameRaw(@NotNull MemorySegment value)
@Nullable BytePtr	pSettingName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
VkLayerSettingEXT	pSettingName(@Nullable BytePtr value)
@NotNull MemorySegment	pSettingNameRaw()
void	pSettingNameRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	pValues()
VkLayerSettingEXT	pValues(@Nullable IPointer pointer)
VkLayerSettingEXT	pValues(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
VkLayerSettingEXT	type(int value)
int	valueCount()
VkLayerSettingEXT	valueCount(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$pLayerName

public static final MemoryLayout.PathElement PATH$pLayerName

PATH$pSettingName

public static final MemoryLayout.PathElement PATH$pSettingName

PATH$type

public static final MemoryLayout.PathElement PATH$type

PATH$valueCount

public static final MemoryLayout.PathElement PATH$valueCount

PATH$pValues

public static final MemoryLayout.PathElement PATH$pValues

LAYOUT$pLayerName

public static final AddressLayout LAYOUT$pLayerName

LAYOUT$pSettingName

public static final AddressLayout LAYOUT$pSettingName

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$valueCount

public static final ValueLayout.OfInt LAYOUT$valueCount

LAYOUT$pValues

public static final AddressLayout LAYOUT$pValues

SIZE$pLayerName

public static final long SIZE$pLayerName

SIZE$pSettingName

public static final long SIZE$pSettingName

SIZE$type

public static final long SIZE$type

SIZE$valueCount

public static final long SIZE$valueCount

SIZE$pValues

public static final long SIZE$pValues

OFFSET$pLayerName

public static final long OFFSET$pLayerName

OFFSET$pSettingName

public static final long OFFSET$pSettingName

OFFSET$type

public static final long OFFSET$type

OFFSET$valueCount

public static final long OFFSET$valueCount

OFFSET$pValues

public static final long OFFSET$pValues

Constructor Details

VkLayerSettingEXT

public VkLayerSettingEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkLayerSettingEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkLayerSettingEXT allocate(Arena arena)

allocate

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

clone

public static VkLayerSettingEXT clone(Arena arena,
 VkLayerSettingEXT src)

pLayerName

@Nullable
public @Nullable BytePtr pLayerName()

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.

pLayerName

public VkLayerSettingEXT pLayerName(@Nullable
 @Nullable BytePtr value)

pLayerNameRaw

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

pLayerNameRaw

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

pSettingName

@Nullable
public @Nullable BytePtr pSettingName()

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.

pSettingName

public VkLayerSettingEXT pSettingName(@Nullable
 @Nullable BytePtr value)

pSettingNameRaw

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

pSettingNameRaw

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

type

@EnumType(VkLayerSettingTypeEXT.class)
public int type()

type

public VkLayerSettingEXT type(@EnumType(VkLayerSettingTypeEXT.class)
 int value)

valueCount

@Unsigned
public int valueCount()

valueCount

public VkLayerSettingEXT valueCount(@Unsigned
 int value)

pValues

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

pValues

public VkLayerSettingEXT pValues(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pValues

public VkLayerSettingEXT pValues(@Nullable
 @Nullable IPointer pointer)

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