Record Class VkCudaLaunchInfoNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCudaLaunchInfoNV

All Implemented Interfaces:

IPointer, IVkCudaLaunchInfoNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkCudaLaunchInfoNV(@NotNull MemorySegment segment)
extends Record
implements IVkCudaLaunchInfoNV

Represents a pointer to a VkCudaLaunchInfoNV structure in native memory.

Structure

typedef struct VkCudaLaunchInfoNV {
    VkStructureType sType;
    void const* pNext; // optional
    VkCudaFunctionNV function;
    uint32_t gridDimX;
    uint32_t gridDimY;
    uint32_t gridDimZ;
    uint32_t blockDimX;
    uint32_t blockDimY;
    uint32_t blockDimZ;
    uint32_t sharedMemBytes;
    size_t paramCount; // optional
    void const* pParams; // optional
    size_t extraCount; // optional
    void const* pExtras; // optional
} VkCudaLaunchInfoNV;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_CUDA_LAUNCH_INFO_NV

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:

• VkCudaLaunchInfoNV

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkCudaLaunchInfoNV.Ptr	Represents a pointer to / an array of VkCudaLaunchInfoNV 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$blockDimX
static final ValueLayout.OfInt	LAYOUT$blockDimY
static final ValueLayout.OfInt	LAYOUT$blockDimZ
static final AddressLayout	LAYOUT$function
static final ValueLayout.OfInt	LAYOUT$gridDimX
static final ValueLayout.OfInt	LAYOUT$gridDimY
static final ValueLayout.OfInt	LAYOUT$gridDimZ
static final AddressLayout	LAYOUT$pExtras
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pParams
static final ValueLayout.OfInt	LAYOUT$sharedMemBytes
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$blockDimX
static final long	OFFSET$blockDimY
static final long	OFFSET$blockDimZ
static final long	OFFSET$extraCount
static final long	OFFSET$function
static final long	OFFSET$gridDimX
static final long	OFFSET$gridDimY
static final long	OFFSET$gridDimZ
static final long	OFFSET$paramCount
static final long	OFFSET$pExtras
static final long	OFFSET$pNext
static final long	OFFSET$pParams
static final long	OFFSET$sharedMemBytes
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$blockDimX
static final MemoryLayout.PathElement	PATH$blockDimY
static final MemoryLayout.PathElement	PATH$blockDimZ
static final MemoryLayout.PathElement	PATH$extraCount
static final MemoryLayout.PathElement	PATH$function
static final MemoryLayout.PathElement	PATH$gridDimX
static final MemoryLayout.PathElement	PATH$gridDimY
static final MemoryLayout.PathElement	PATH$gridDimZ
static final MemoryLayout.PathElement	PATH$paramCount
static final MemoryLayout.PathElement	PATH$pExtras
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pParams
static final MemoryLayout.PathElement	PATH$sharedMemBytes
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$blockDimX
static final long	SIZE$blockDimY
static final long	SIZE$blockDimZ
static final long	SIZE$extraCount
static final long	SIZE$function
static final long	SIZE$gridDimX
static final long	SIZE$gridDimY
static final long	SIZE$gridDimZ
static final long	SIZE$paramCount
static final long	SIZE$pExtras
static final long	SIZE$pNext
static final long	SIZE$pParams
static final long	SIZE$sharedMemBytes
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCudaLaunchInfoNV	allocate(Arena arena)
static VkCudaLaunchInfoNV.Ptr	allocate(Arena arena, long count)
void	autoInit()
int	blockDimX()
VkCudaLaunchInfoNV	blockDimX(int value)
int	blockDimY()
VkCudaLaunchInfoNV	blockDimY(int value)
int	blockDimZ()
VkCudaLaunchInfoNV	blockDimZ(int value)
static VkCudaLaunchInfoNV	clone(Arena arena, VkCudaLaunchInfoNV src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	extraCount()
VkCudaLaunchInfoNV	extraCount(long value)
@Nullable VkCudaFunctionNV	function()
VkCudaLaunchInfoNV	function(@Nullable VkCudaFunctionNV value)
int	gridDimX()
VkCudaLaunchInfoNV	gridDimX(int value)
int	gridDimY()
VkCudaLaunchInfoNV	gridDimY(int value)
int	gridDimZ()
VkCudaLaunchInfoNV	gridDimZ(int value)
final int	hashCode()	Returns a hash code value for this object.
long	paramCount()
VkCudaLaunchInfoNV	paramCount(long value)
@NotNull MemorySegment	pExtras()
VkCudaLaunchInfoNV	pExtras(@Nullable IPointer pointer)
VkCudaLaunchInfoNV	pExtras(@NotNull MemorySegment value)
@NotNull MemorySegment	pNext()
VkCudaLaunchInfoNV	pNext(@Nullable IPointer pointer)
VkCudaLaunchInfoNV	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	pParams()
VkCudaLaunchInfoNV	pParams(@Nullable IPointer pointer)
VkCudaLaunchInfoNV	pParams(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sharedMemBytes()
VkCudaLaunchInfoNV	sharedMemBytes(int value)
int	sType()
VkCudaLaunchInfoNV	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$function

public static final MemoryLayout.PathElement PATH$function

PATH$gridDimX

public static final MemoryLayout.PathElement PATH$gridDimX

PATH$gridDimY

public static final MemoryLayout.PathElement PATH$gridDimY

PATH$gridDimZ

public static final MemoryLayout.PathElement PATH$gridDimZ

PATH$blockDimX

public static final MemoryLayout.PathElement PATH$blockDimX

PATH$blockDimY

public static final MemoryLayout.PathElement PATH$blockDimY

PATH$blockDimZ

public static final MemoryLayout.PathElement PATH$blockDimZ

PATH$sharedMemBytes

public static final MemoryLayout.PathElement PATH$sharedMemBytes

PATH$paramCount

public static final MemoryLayout.PathElement PATH$paramCount

PATH$pParams

public static final MemoryLayout.PathElement PATH$pParams

PATH$extraCount

public static final MemoryLayout.PathElement PATH$extraCount

PATH$pExtras

public static final MemoryLayout.PathElement PATH$pExtras

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$function

public static final AddressLayout LAYOUT$function

LAYOUT$gridDimX

public static final ValueLayout.OfInt LAYOUT$gridDimX

LAYOUT$gridDimY

public static final ValueLayout.OfInt LAYOUT$gridDimY

LAYOUT$gridDimZ

public static final ValueLayout.OfInt LAYOUT$gridDimZ

LAYOUT$blockDimX

public static final ValueLayout.OfInt LAYOUT$blockDimX

LAYOUT$blockDimY

public static final ValueLayout.OfInt LAYOUT$blockDimY

LAYOUT$blockDimZ

public static final ValueLayout.OfInt LAYOUT$blockDimZ

LAYOUT$sharedMemBytes

public static final ValueLayout.OfInt LAYOUT$sharedMemBytes

LAYOUT$pParams

public static final AddressLayout LAYOUT$pParams

LAYOUT$pExtras

public static final AddressLayout LAYOUT$pExtras

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$function

public static final long SIZE$function

SIZE$gridDimX

public static final long SIZE$gridDimX

SIZE$gridDimY

public static final long SIZE$gridDimY

SIZE$gridDimZ

public static final long SIZE$gridDimZ

SIZE$blockDimX

public static final long SIZE$blockDimX

SIZE$blockDimY

public static final long SIZE$blockDimY

SIZE$blockDimZ

public static final long SIZE$blockDimZ

SIZE$sharedMemBytes

public static final long SIZE$sharedMemBytes

SIZE$paramCount

public static final long SIZE$paramCount

SIZE$pParams

public static final long SIZE$pParams

SIZE$extraCount

public static final long SIZE$extraCount

SIZE$pExtras

public static final long SIZE$pExtras

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$function

public static final long OFFSET$function

OFFSET$gridDimX

public static final long OFFSET$gridDimX

OFFSET$gridDimY

public static final long OFFSET$gridDimY

OFFSET$gridDimZ

public static final long OFFSET$gridDimZ

OFFSET$blockDimX

public static final long OFFSET$blockDimX

OFFSET$blockDimY

public static final long OFFSET$blockDimY

OFFSET$blockDimZ

public static final long OFFSET$blockDimZ

OFFSET$sharedMemBytes

public static final long OFFSET$sharedMemBytes

OFFSET$paramCount

public static final long OFFSET$paramCount

OFFSET$pParams

public static final long OFFSET$pParams

OFFSET$extraCount

public static final long OFFSET$extraCount

OFFSET$pExtras

public static final long OFFSET$pExtras

Constructor Details

VkCudaLaunchInfoNV

public VkCudaLaunchInfoNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCudaLaunchInfoNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCudaLaunchInfoNV allocate(Arena arena)

allocate

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

clone

public static VkCudaLaunchInfoNV clone(Arena arena,
 VkCudaLaunchInfoNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkCudaLaunchInfoNV pNext(@Nullable
 @Nullable IPointer pointer)

function

@Nullable
public @Nullable VkCudaFunctionNV function()

function

public VkCudaLaunchInfoNV function(@Nullable
 @Nullable VkCudaFunctionNV value)

gridDimX

@Unsigned
public int gridDimX()

gridDimX

public VkCudaLaunchInfoNV gridDimX(@Unsigned
 int value)

gridDimY

@Unsigned
public int gridDimY()

gridDimY

public VkCudaLaunchInfoNV gridDimY(@Unsigned
 int value)

gridDimZ

@Unsigned
public int gridDimZ()

gridDimZ

public VkCudaLaunchInfoNV gridDimZ(@Unsigned
 int value)

blockDimX

@Unsigned
public int blockDimX()

blockDimX

public VkCudaLaunchInfoNV blockDimX(@Unsigned
 int value)

blockDimY

@Unsigned
public int blockDimY()

blockDimY

public VkCudaLaunchInfoNV blockDimY(@Unsigned
 int value)

blockDimZ

@Unsigned
public int blockDimZ()

blockDimZ

public VkCudaLaunchInfoNV blockDimZ(@Unsigned
 int value)

sharedMemBytes

@Unsigned
public int sharedMemBytes()

sharedMemBytes

public VkCudaLaunchInfoNV sharedMemBytes(@Unsigned
 int value)

paramCount

@Unsigned
public long paramCount()

paramCount

public VkCudaLaunchInfoNV paramCount(@Unsigned
 long value)

pParams

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

pParams

public VkCudaLaunchInfoNV pParams(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pParams

public VkCudaLaunchInfoNV pParams(@Nullable
 @Nullable IPointer pointer)

extraCount

@Unsigned
public long extraCount()

extraCount

public VkCudaLaunchInfoNV extraCount(@Unsigned
 long value)

pExtras

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

pExtras

public VkCudaLaunchInfoNV pExtras(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pExtras

public VkCudaLaunchInfoNV pExtras(@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