Record Class VkDebugMarkerMarkerInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDebugMarkerMarkerInfoEXT

All Implemented Interfaces:

IPointer, IVkDebugMarkerMarkerInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkDebugMarkerMarkerInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkDebugMarkerMarkerInfoEXT

Represents a pointer to a VkDebugMarkerMarkerInfoEXT structure in native memory.

Structure

typedef struct VkDebugMarkerMarkerInfoEXT {
    VkStructureType sType;
    void const* pNext; // optional
    char const* pMarkerName;
    float[4] color;
} VkDebugMarkerMarkerInfoEXT;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT

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:

• VkDebugMarkerMarkerInfoEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final SequenceLayout	LAYOUT$color
static final AddressLayout	LAYOUT$pMarkerName
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$color
static final long	OFFSET$pMarkerName
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$color
static final MemoryLayout.PathElement	PATH$pMarkerName
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$color
static final long	SIZE$pMarkerName
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$pMarkerName

PATH$color

public static final MemoryLayout.PathElement PATH$color

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$pMarkerName

public static final AddressLayout LAYOUT$pMarkerName

LAYOUT$color

public static final SequenceLayout LAYOUT$color

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$pMarkerName

public static final long SIZE$pMarkerName

SIZE$color

public static final long SIZE$color

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$pMarkerName

public static final long OFFSET$pMarkerName

OFFSET$color

public static final long OFFSET$color

Constructor Details

VkDebugMarkerMarkerInfoEXT

public VkDebugMarkerMarkerInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDebugMarkerMarkerInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDebugMarkerMarkerInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkDebugMarkerMarkerInfoEXT clone(Arena arena,
 VkDebugMarkerMarkerInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkDebugMarkerMarkerInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

pMarkerName

@Nullable
public @Nullable BytePtr pMarkerName()

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.

pMarkerName

public VkDebugMarkerMarkerInfoEXT pMarkerName(@Nullable
 @Nullable BytePtr value)

pMarkerNameRaw

@Pointer(comment="int8_t*")
public MemorySegment pMarkerNameRaw()

pMarkerNameRaw

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

color

public FloatPtr color()

color

public VkDebugMarkerMarkerInfoEXT color(FloatPtr value)

colorRaw

public MemorySegment colorRaw()

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