Record Class VkGeneratedCommandsInfoNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkGeneratedCommandsInfoNV

All Implemented Interfaces:

IPointer, IVkGeneratedCommandsInfoNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkGeneratedCommandsInfoNV(@NotNull MemorySegment segment)
extends Record
implements IVkGeneratedCommandsInfoNV

Represents a pointer to a VkGeneratedCommandsInfoNV structure in native memory.

Structure

typedef struct VkGeneratedCommandsInfoNV {
    VkStructureType sType;
    void const* pNext; // optional
    VkPipelineBindPoint pipelineBindPoint;
    VkPipeline pipeline; // optional
    VkIndirectCommandsLayoutNV indirectCommandsLayout;
    uint32_t streamCount;
    VkIndirectCommandsStreamNV const* pStreams;
    uint32_t sequencesCount;
    VkBuffer preprocessBuffer;
    VkDeviceSize preprocessOffset;
    VkDeviceSize preprocessSize;
    VkBuffer sequencesCountBuffer; // optional
    VkDeviceSize sequencesCountOffset;
    VkBuffer sequencesIndexBuffer; // optional
    VkDeviceSize sequencesIndexOffset;
} VkGeneratedCommandsInfoNV;

Auto initialization

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

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

• VkGeneratedCommandsInfoNV

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkGeneratedCommandsInfoNV.Ptr	Represents a pointer to / an array of VkGeneratedCommandsInfoNV 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$indirectCommandsLayout
static final AddressLayout	LAYOUT$pipeline
static final ValueLayout.OfInt	LAYOUT$pipelineBindPoint
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$preprocessBuffer
static final ValueLayout.OfLong	LAYOUT$preprocessOffset
static final ValueLayout.OfLong	LAYOUT$preprocessSize
static final AddressLayout	LAYOUT$pStreams
static final ValueLayout.OfInt	LAYOUT$sequencesCount
static final AddressLayout	LAYOUT$sequencesCountBuffer
static final ValueLayout.OfLong	LAYOUT$sequencesCountOffset
static final AddressLayout	LAYOUT$sequencesIndexBuffer
static final ValueLayout.OfLong	LAYOUT$sequencesIndexOffset
static final ValueLayout.OfInt	LAYOUT$streamCount
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$indirectCommandsLayout
static final long	OFFSET$pipeline
static final long	OFFSET$pipelineBindPoint
static final long	OFFSET$pNext
static final long	OFFSET$preprocessBuffer
static final long	OFFSET$preprocessOffset
static final long	OFFSET$preprocessSize
static final long	OFFSET$pStreams
static final long	OFFSET$sequencesCount
static final long	OFFSET$sequencesCountBuffer
static final long	OFFSET$sequencesCountOffset
static final long	OFFSET$sequencesIndexBuffer
static final long	OFFSET$sequencesIndexOffset
static final long	OFFSET$streamCount
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$indirectCommandsLayout
static final MemoryLayout.PathElement	PATH$pipeline
static final MemoryLayout.PathElement	PATH$pipelineBindPoint
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$preprocessBuffer
static final MemoryLayout.PathElement	PATH$preprocessOffset
static final MemoryLayout.PathElement	PATH$preprocessSize
static final MemoryLayout.PathElement	PATH$pStreams
static final MemoryLayout.PathElement	PATH$sequencesCount
static final MemoryLayout.PathElement	PATH$sequencesCountBuffer
static final MemoryLayout.PathElement	PATH$sequencesCountOffset
static final MemoryLayout.PathElement	PATH$sequencesIndexBuffer
static final MemoryLayout.PathElement	PATH$sequencesIndexOffset
static final MemoryLayout.PathElement	PATH$streamCount
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$indirectCommandsLayout
static final long	SIZE$pipeline
static final long	SIZE$pipelineBindPoint
static final long	SIZE$pNext
static final long	SIZE$preprocessBuffer
static final long	SIZE$preprocessOffset
static final long	SIZE$preprocessSize
static final long	SIZE$pStreams
static final long	SIZE$sequencesCount
static final long	SIZE$sequencesCountBuffer
static final long	SIZE$sequencesCountOffset
static final long	SIZE$sequencesIndexBuffer
static final long	SIZE$sequencesIndexOffset
static final long	SIZE$streamCount
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkGeneratedCommandsInfoNV	allocate(Arena arena)
static VkGeneratedCommandsInfoNV.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkGeneratedCommandsInfoNV	clone(Arena arena, VkGeneratedCommandsInfoNV 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 VkIndirectCommandsLayoutNV	indirectCommandsLayout()
VkGeneratedCommandsInfoNV	indirectCommandsLayout(@Nullable VkIndirectCommandsLayoutNV value)
@Nullable VkPipeline	pipeline()
VkGeneratedCommandsInfoNV	pipeline(@Nullable VkPipeline value)
int	pipelineBindPoint()
VkGeneratedCommandsInfoNV	pipelineBindPoint(int value)
@NotNull MemorySegment	pNext()
VkGeneratedCommandsInfoNV	pNext(@Nullable IPointer pointer)
VkGeneratedCommandsInfoNV	pNext(@NotNull MemorySegment value)
@Nullable VkBuffer	preprocessBuffer()
VkGeneratedCommandsInfoNV	preprocessBuffer(@Nullable VkBuffer value)
long	preprocessOffset()
VkGeneratedCommandsInfoNV	preprocessOffset(long value)
long	preprocessSize()
VkGeneratedCommandsInfoNV	preprocessSize(long value)
@Nullable VkIndirectCommandsStreamNV	pStreams()
VkIndirectCommandsStreamNV.Ptr	pStreams(int assumedCount)
VkGeneratedCommandsInfoNV	pStreams(@Nullable IVkIndirectCommandsStreamNV value)
@NotNull MemorySegment	pStreamsRaw()
void	pStreamsRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sequencesCount()
VkGeneratedCommandsInfoNV	sequencesCount(int value)
@Nullable VkBuffer	sequencesCountBuffer()
VkGeneratedCommandsInfoNV	sequencesCountBuffer(@Nullable VkBuffer value)
long	sequencesCountOffset()
VkGeneratedCommandsInfoNV	sequencesCountOffset(long value)
@Nullable VkBuffer	sequencesIndexBuffer()
VkGeneratedCommandsInfoNV	sequencesIndexBuffer(@Nullable VkBuffer value)
long	sequencesIndexOffset()
VkGeneratedCommandsInfoNV	sequencesIndexOffset(long value)
int	streamCount()
VkGeneratedCommandsInfoNV	streamCount(int value)
int	sType()
VkGeneratedCommandsInfoNV	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$pipelineBindPoint

public static final MemoryLayout.PathElement PATH$pipelineBindPoint

PATH$pipeline

public static final MemoryLayout.PathElement PATH$pipeline

PATH$indirectCommandsLayout

public static final MemoryLayout.PathElement PATH$indirectCommandsLayout

PATH$streamCount

public static final MemoryLayout.PathElement PATH$streamCount

PATH$pStreams

public static final MemoryLayout.PathElement PATH$pStreams

PATH$sequencesCount

public static final MemoryLayout.PathElement PATH$sequencesCount

PATH$preprocessBuffer

public static final MemoryLayout.PathElement PATH$preprocessBuffer

PATH$preprocessOffset

public static final MemoryLayout.PathElement PATH$preprocessOffset

PATH$preprocessSize

public static final MemoryLayout.PathElement PATH$preprocessSize

PATH$sequencesCountBuffer

public static final MemoryLayout.PathElement PATH$sequencesCountBuffer

PATH$sequencesCountOffset

public static final MemoryLayout.PathElement PATH$sequencesCountOffset

PATH$sequencesIndexBuffer

public static final MemoryLayout.PathElement PATH$sequencesIndexBuffer

PATH$sequencesIndexOffset

public static final MemoryLayout.PathElement PATH$sequencesIndexOffset

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$pipelineBindPoint

public static final ValueLayout.OfInt LAYOUT$pipelineBindPoint

LAYOUT$pipeline

public static final AddressLayout LAYOUT$pipeline

LAYOUT$indirectCommandsLayout

public static final AddressLayout LAYOUT$indirectCommandsLayout

LAYOUT$streamCount

public static final ValueLayout.OfInt LAYOUT$streamCount

LAYOUT$pStreams

public static final AddressLayout LAYOUT$pStreams

LAYOUT$sequencesCount

public static final ValueLayout.OfInt LAYOUT$sequencesCount

LAYOUT$preprocessBuffer

public static final AddressLayout LAYOUT$preprocessBuffer

LAYOUT$preprocessOffset

public static final ValueLayout.OfLong LAYOUT$preprocessOffset

LAYOUT$preprocessSize

public static final ValueLayout.OfLong LAYOUT$preprocessSize

LAYOUT$sequencesCountBuffer

public static final AddressLayout LAYOUT$sequencesCountBuffer

LAYOUT$sequencesCountOffset

public static final ValueLayout.OfLong LAYOUT$sequencesCountOffset

LAYOUT$sequencesIndexBuffer

public static final AddressLayout LAYOUT$sequencesIndexBuffer

LAYOUT$sequencesIndexOffset

public static final ValueLayout.OfLong LAYOUT$sequencesIndexOffset

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$pipelineBindPoint

public static final long SIZE$pipelineBindPoint

SIZE$pipeline

public static final long SIZE$pipeline

SIZE$indirectCommandsLayout

public static final long SIZE$indirectCommandsLayout

SIZE$streamCount

public static final long SIZE$streamCount

SIZE$pStreams

public static final long SIZE$pStreams

SIZE$sequencesCount

public static final long SIZE$sequencesCount

SIZE$preprocessBuffer

public static final long SIZE$preprocessBuffer

SIZE$preprocessOffset

public static final long SIZE$preprocessOffset

SIZE$preprocessSize

public static final long SIZE$preprocessSize

SIZE$sequencesCountBuffer

public static final long SIZE$sequencesCountBuffer

SIZE$sequencesCountOffset

public static final long SIZE$sequencesCountOffset

SIZE$sequencesIndexBuffer

public static final long SIZE$sequencesIndexBuffer

SIZE$sequencesIndexOffset

public static final long SIZE$sequencesIndexOffset

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$pipelineBindPoint

public static final long OFFSET$pipelineBindPoint

OFFSET$pipeline

public static final long OFFSET$pipeline

OFFSET$indirectCommandsLayout

public static final long OFFSET$indirectCommandsLayout

OFFSET$streamCount

public static final long OFFSET$streamCount

OFFSET$pStreams

public static final long OFFSET$pStreams

OFFSET$sequencesCount

public static final long OFFSET$sequencesCount

OFFSET$preprocessBuffer

public static final long OFFSET$preprocessBuffer

OFFSET$preprocessOffset

public static final long OFFSET$preprocessOffset

OFFSET$preprocessSize

public static final long OFFSET$preprocessSize

OFFSET$sequencesCountBuffer

public static final long OFFSET$sequencesCountBuffer

OFFSET$sequencesCountOffset

public static final long OFFSET$sequencesCountOffset

OFFSET$sequencesIndexBuffer

public static final long OFFSET$sequencesIndexBuffer

OFFSET$sequencesIndexOffset

public static final long OFFSET$sequencesIndexOffset

Constructor Details

VkGeneratedCommandsInfoNV

public VkGeneratedCommandsInfoNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkGeneratedCommandsInfoNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkGeneratedCommandsInfoNV allocate(Arena arena)

allocate

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

clone

public static VkGeneratedCommandsInfoNV clone(Arena arena,
 VkGeneratedCommandsInfoNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkGeneratedCommandsInfoNV pNext(@Nullable
 @Nullable IPointer pointer)

pipelineBindPoint

@EnumType(VkPipelineBindPoint.class)
public int pipelineBindPoint()

pipelineBindPoint

public VkGeneratedCommandsInfoNV pipelineBindPoint(@EnumType(VkPipelineBindPoint.class)
 int value)

pipeline

@Nullable
public @Nullable VkPipeline pipeline()

pipeline

public VkGeneratedCommandsInfoNV pipeline(@Nullable
 @Nullable VkPipeline value)

indirectCommandsLayout

@Nullable
public @Nullable VkIndirectCommandsLayoutNV indirectCommandsLayout()

indirectCommandsLayout

public VkGeneratedCommandsInfoNV indirectCommandsLayout(@Nullable
 @Nullable VkIndirectCommandsLayoutNV value)

streamCount

@Unsigned
public int streamCount()

streamCount

public VkGeneratedCommandsInfoNV streamCount(@Unsigned
 int value)

pStreams

public VkGeneratedCommandsInfoNV pStreams(@Nullable
 @Nullable IVkIndirectCommandsStreamNV value)

pStreams

@Unsafe
@Nullable
public VkIndirectCommandsStreamNV.Ptr pStreams(int assumedCount)

pStreams

@Nullable
public @Nullable VkIndirectCommandsStreamNV pStreams()

pStreamsRaw

@Pointer(target=VkIndirectCommandsStreamNV.class)
@NotNull
public @NotNull MemorySegment pStreamsRaw()

pStreamsRaw

public void pStreamsRaw(@Pointer(target=VkIndirectCommandsStreamNV.class) @NotNull
 @NotNull MemorySegment value)

sequencesCount

@Unsigned
public int sequencesCount()

sequencesCount

public VkGeneratedCommandsInfoNV sequencesCount(@Unsigned
 int value)

preprocessBuffer

@Nullable
public @Nullable VkBuffer preprocessBuffer()

preprocessBuffer

public VkGeneratedCommandsInfoNV preprocessBuffer(@Nullable
 @Nullable VkBuffer value)

preprocessOffset

@NativeType("VkDeviceSize")
@Unsigned
public long preprocessOffset()

preprocessOffset

public VkGeneratedCommandsInfoNV preprocessOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

preprocessSize

@NativeType("VkDeviceSize")
@Unsigned
public long preprocessSize()

preprocessSize

public VkGeneratedCommandsInfoNV preprocessSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

sequencesCountBuffer

@Nullable
public @Nullable VkBuffer sequencesCountBuffer()

sequencesCountBuffer

public VkGeneratedCommandsInfoNV sequencesCountBuffer(@Nullable
 @Nullable VkBuffer value)

sequencesCountOffset

@NativeType("VkDeviceSize")
@Unsigned
public long sequencesCountOffset()

sequencesCountOffset

public VkGeneratedCommandsInfoNV sequencesCountOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

sequencesIndexBuffer

@Nullable
public @Nullable VkBuffer sequencesIndexBuffer()

sequencesIndexBuffer

public VkGeneratedCommandsInfoNV sequencesIndexBuffer(@Nullable
 @Nullable VkBuffer value)

sequencesIndexOffset

@NativeType("VkDeviceSize")
@Unsigned
public long sequencesIndexOffset()

sequencesIndexOffset

public VkGeneratedCommandsInfoNV sequencesIndexOffset(@NativeType("VkDeviceSize") @Unsigned
 long 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