Record Class VkCopyMemoryToMicromapInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCopyMemoryToMicromapInfoEXT

All Implemented Interfaces:

IPointer, IVkCopyMemoryToMicromapInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkCopyMemoryToMicromapInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkCopyMemoryToMicromapInfoEXT

Represents a pointer to a VkCopyMemoryToMicromapInfoEXT structure in native memory.

Structure

typedef struct VkCopyMemoryToMicromapInfoEXT {
    VkStructureType sType;
    void const* pNext; // optional
    VkDeviceOrHostAddressConstKHR src;
    VkMicromapEXT dst;
    VkCopyMicromapModeEXT mode;
} VkCopyMemoryToMicromapInfoEXT;

Auto initialization

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

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

• VkCopyMemoryToMicromapInfoEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyMemoryToMicromapInfoEXT	allocate(Arena arena)
static VkCopyMemoryToMicromapInfoEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkCopyMemoryToMicromapInfoEXT	clone(Arena arena, VkCopyMemoryToMicromapInfoEXT src)
@Nullable VkMicromapEXT	dst()
VkCopyMemoryToMicromapInfoEXT	dst(@Nullable VkMicromapEXT value)
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	mode()
VkCopyMemoryToMicromapInfoEXT	mode(int value)
MemorySegment	pNext()
VkCopyMemoryToMicromapInfoEXT	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull VkDeviceOrHostAddressConstKHR	src()
VkCopyMemoryToMicromapInfoEXT	src(@NotNull VkDeviceOrHostAddressConstKHR value)
VkCopyMemoryToMicromapInfoEXT	src(Consumer<@NotNull VkDeviceOrHostAddressConstKHR> consumer)
int	sType()
VkCopyMemoryToMicromapInfoEXT	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$src

public static final MemoryLayout.PathElement PATH$src

PATH$dst

public static final MemoryLayout.PathElement PATH$dst

PATH$mode

public static final MemoryLayout.PathElement PATH$mode

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$src

public static final UnionLayout LAYOUT$src

LAYOUT$dst

public static final AddressLayout LAYOUT$dst

LAYOUT$mode

public static final ValueLayout.OfInt LAYOUT$mode

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$src

public static final long SIZE$src

SIZE$dst

public static final long SIZE$dst

SIZE$mode

public static final long SIZE$mode

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$src

public static final long OFFSET$src

OFFSET$dst

public static final long OFFSET$dst

OFFSET$mode

public static final long OFFSET$mode

Constructor Details

VkCopyMemoryToMicromapInfoEXT

public VkCopyMemoryToMicromapInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCopyMemoryToMicromapInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCopyMemoryToMicromapInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkCopyMemoryToMicromapInfoEXT clone(Arena arena,
 VkCopyMemoryToMicromapInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkCopyMemoryToMicromapInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

src

@NotNull
public @NotNull VkDeviceOrHostAddressConstKHR src()

src

public VkCopyMemoryToMicromapInfoEXT src(@NotNull
 @NotNull VkDeviceOrHostAddressConstKHR value)

src

public VkCopyMemoryToMicromapInfoEXT src(Consumer<@NotNull VkDeviceOrHostAddressConstKHR> consumer)

dst

@Nullable
public @Nullable VkMicromapEXT dst()

dst

public VkCopyMemoryToMicromapInfoEXT dst(@Nullable
 @Nullable VkMicromapEXT value)

mode

@EnumType(VkCopyMicromapModeEXT.class)
public int mode()

mode

public VkCopyMemoryToMicromapInfoEXT mode(@EnumType(VkCopyMicromapModeEXT.class)
 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