Record Class VkGeneratedCommandsInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkGeneratedCommandsInfoEXT

All Implemented Interfaces:

IPointer, IVkGeneratedCommandsInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkGeneratedCommandsInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkGeneratedCommandsInfoEXT

Represents a pointer to a VkGeneratedCommandsInfoEXT structure in native memory.

Structure

typedef struct VkGeneratedCommandsInfoEXT {
    VkStructureType sType;
    void const* pNext; // optional
    VkShaderStageFlags shaderStages;
    VkIndirectExecutionSetEXT indirectExecutionSet; // optional
    VkIndirectCommandsLayoutEXT indirectCommandsLayout;
    VkDeviceAddress indirectAddress;
    VkDeviceSize indirectAddressSize;
    VkDeviceAddress preprocessAddress; // optional
    VkDeviceSize preprocessSize;
    uint32_t maxSequenceCount;
    VkDeviceAddress sequenceCountAddress; // optional
    uint32_t maxDrawCount;
} VkGeneratedCommandsInfoEXT;

Auto initialization

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

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

• VkGeneratedCommandsInfoEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$indirectAddress
static final ValueLayout.OfLong	LAYOUT$indirectAddressSize
static final AddressLayout	LAYOUT$indirectCommandsLayout
static final AddressLayout	LAYOUT$indirectExecutionSet
static final ValueLayout.OfInt	LAYOUT$maxDrawCount
static final ValueLayout.OfInt	LAYOUT$maxSequenceCount
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfLong	LAYOUT$preprocessAddress
static final ValueLayout.OfLong	LAYOUT$preprocessSize
static final ValueLayout.OfLong	LAYOUT$sequenceCountAddress
static final ValueLayout.OfInt	LAYOUT$shaderStages
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$indirectAddress
static final long	OFFSET$indirectAddressSize
static final long	OFFSET$indirectCommandsLayout
static final long	OFFSET$indirectExecutionSet
static final long	OFFSET$maxDrawCount
static final long	OFFSET$maxSequenceCount
static final long	OFFSET$pNext
static final long	OFFSET$preprocessAddress
static final long	OFFSET$preprocessSize
static final long	OFFSET$sequenceCountAddress
static final long	OFFSET$shaderStages
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$indirectAddress
static final MemoryLayout.PathElement	PATH$indirectAddressSize
static final MemoryLayout.PathElement	PATH$indirectCommandsLayout
static final MemoryLayout.PathElement	PATH$indirectExecutionSet
static final MemoryLayout.PathElement	PATH$maxDrawCount
static final MemoryLayout.PathElement	PATH$maxSequenceCount
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$preprocessAddress
static final MemoryLayout.PathElement	PATH$preprocessSize
static final MemoryLayout.PathElement	PATH$sequenceCountAddress
static final MemoryLayout.PathElement	PATH$shaderStages
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$indirectAddress
static final long	SIZE$indirectAddressSize
static final long	SIZE$indirectCommandsLayout
static final long	SIZE$indirectExecutionSet
static final long	SIZE$maxDrawCount
static final long	SIZE$maxSequenceCount
static final long	SIZE$pNext
static final long	SIZE$preprocessAddress
static final long	SIZE$preprocessSize
static final long	SIZE$sequenceCountAddress
static final long	SIZE$shaderStages
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkGeneratedCommandsInfoEXT	allocate(Arena arena)
static VkGeneratedCommandsInfoEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkGeneratedCommandsInfoEXT	clone(Arena arena, VkGeneratedCommandsInfoEXT 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.
long	indirectAddress()
VkGeneratedCommandsInfoEXT	indirectAddress(long value)
long	indirectAddressSize()
VkGeneratedCommandsInfoEXT	indirectAddressSize(long value)
@Nullable VkIndirectCommandsLayoutEXT	indirectCommandsLayout()
VkGeneratedCommandsInfoEXT	indirectCommandsLayout(@Nullable VkIndirectCommandsLayoutEXT value)
@Nullable VkIndirectExecutionSetEXT	indirectExecutionSet()
VkGeneratedCommandsInfoEXT	indirectExecutionSet(@Nullable VkIndirectExecutionSetEXT value)
int	maxDrawCount()
VkGeneratedCommandsInfoEXT	maxDrawCount(int value)
int	maxSequenceCount()
VkGeneratedCommandsInfoEXT	maxSequenceCount(int value)
MemorySegment	pNext()
VkGeneratedCommandsInfoEXT	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
long	preprocessAddress()
VkGeneratedCommandsInfoEXT	preprocessAddress(long value)
long	preprocessSize()
VkGeneratedCommandsInfoEXT	preprocessSize(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	sequenceCountAddress()
VkGeneratedCommandsInfoEXT	sequenceCountAddress(long value)
int	shaderStages()
VkGeneratedCommandsInfoEXT	shaderStages(int value)
int	sType()
VkGeneratedCommandsInfoEXT	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$shaderStages

public static final MemoryLayout.PathElement PATH$shaderStages

PATH$indirectExecutionSet

public static final MemoryLayout.PathElement PATH$indirectExecutionSet

PATH$indirectCommandsLayout

public static final MemoryLayout.PathElement PATH$indirectCommandsLayout

PATH$indirectAddress

public static final MemoryLayout.PathElement PATH$indirectAddress

PATH$indirectAddressSize

public static final MemoryLayout.PathElement PATH$indirectAddressSize

PATH$preprocessAddress

public static final MemoryLayout.PathElement PATH$preprocessAddress

PATH$preprocessSize

public static final MemoryLayout.PathElement PATH$preprocessSize

PATH$maxSequenceCount

public static final MemoryLayout.PathElement PATH$maxSequenceCount

PATH$sequenceCountAddress

public static final MemoryLayout.PathElement PATH$sequenceCountAddress

PATH$maxDrawCount

public static final MemoryLayout.PathElement PATH$maxDrawCount

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$shaderStages

public static final ValueLayout.OfInt LAYOUT$shaderStages

LAYOUT$indirectExecutionSet

public static final AddressLayout LAYOUT$indirectExecutionSet

LAYOUT$indirectCommandsLayout

public static final AddressLayout LAYOUT$indirectCommandsLayout

LAYOUT$indirectAddress

public static final ValueLayout.OfLong LAYOUT$indirectAddress

LAYOUT$indirectAddressSize

public static final ValueLayout.OfLong LAYOUT$indirectAddressSize

LAYOUT$preprocessAddress

public static final ValueLayout.OfLong LAYOUT$preprocessAddress

LAYOUT$preprocessSize

public static final ValueLayout.OfLong LAYOUT$preprocessSize

LAYOUT$maxSequenceCount

public static final ValueLayout.OfInt LAYOUT$maxSequenceCount

LAYOUT$sequenceCountAddress

public static final ValueLayout.OfLong LAYOUT$sequenceCountAddress

LAYOUT$maxDrawCount

public static final ValueLayout.OfInt LAYOUT$maxDrawCount

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$shaderStages

public static final long SIZE$shaderStages

SIZE$indirectExecutionSet

public static final long SIZE$indirectExecutionSet

SIZE$indirectCommandsLayout

public static final long SIZE$indirectCommandsLayout

SIZE$indirectAddress

public static final long SIZE$indirectAddress

SIZE$indirectAddressSize

public static final long SIZE$indirectAddressSize

SIZE$preprocessAddress

public static final long SIZE$preprocessAddress

SIZE$preprocessSize

public static final long SIZE$preprocessSize

SIZE$maxSequenceCount

public static final long SIZE$maxSequenceCount

SIZE$sequenceCountAddress

public static final long SIZE$sequenceCountAddress

SIZE$maxDrawCount

public static final long SIZE$maxDrawCount

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$shaderStages

public static final long OFFSET$shaderStages

OFFSET$indirectExecutionSet

public static final long OFFSET$indirectExecutionSet

OFFSET$indirectCommandsLayout

public static final long OFFSET$indirectCommandsLayout

OFFSET$indirectAddress

public static final long OFFSET$indirectAddress

OFFSET$indirectAddressSize

public static final long OFFSET$indirectAddressSize

OFFSET$preprocessAddress

public static final long OFFSET$preprocessAddress

OFFSET$preprocessSize

public static final long OFFSET$preprocessSize

OFFSET$maxSequenceCount

public static final long OFFSET$maxSequenceCount

OFFSET$sequenceCountAddress

public static final long OFFSET$sequenceCountAddress

OFFSET$maxDrawCount

public static final long OFFSET$maxDrawCount

Constructor Details

VkGeneratedCommandsInfoEXT

public VkGeneratedCommandsInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkGeneratedCommandsInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkGeneratedCommandsInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkGeneratedCommandsInfoEXT clone(Arena arena,
 VkGeneratedCommandsInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkGeneratedCommandsInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

shaderStages

@EnumType(VkShaderStageFlags.class)
public int shaderStages()

shaderStages

public VkGeneratedCommandsInfoEXT shaderStages(@EnumType(VkShaderStageFlags.class)
 int value)

indirectExecutionSet

@Nullable
public @Nullable VkIndirectExecutionSetEXT indirectExecutionSet()

indirectExecutionSet

public VkGeneratedCommandsInfoEXT indirectExecutionSet(@Nullable
 @Nullable VkIndirectExecutionSetEXT value)

indirectCommandsLayout

@Nullable
public @Nullable VkIndirectCommandsLayoutEXT indirectCommandsLayout()

indirectCommandsLayout

public VkGeneratedCommandsInfoEXT indirectCommandsLayout(@Nullable
 @Nullable VkIndirectCommandsLayoutEXT value)

indirectAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long indirectAddress()

indirectAddress

public VkGeneratedCommandsInfoEXT indirectAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

indirectAddressSize

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

indirectAddressSize

public VkGeneratedCommandsInfoEXT indirectAddressSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

preprocessAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long preprocessAddress()

preprocessAddress

public VkGeneratedCommandsInfoEXT preprocessAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

preprocessSize

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

preprocessSize

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

maxSequenceCount

@Unsigned
public int maxSequenceCount()

maxSequenceCount

public VkGeneratedCommandsInfoEXT maxSequenceCount(@Unsigned
 int value)

sequenceCountAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long sequenceCountAddress()

sequenceCountAddress

public VkGeneratedCommandsInfoEXT sequenceCountAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

maxDrawCount

@Unsigned
public int maxDrawCount()

maxDrawCount

public VkGeneratedCommandsInfoEXT maxDrawCount(@Unsigned
 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