Record Class VkGeneratedCommandsShaderInfoEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkGeneratedCommandsShaderInfoEXT

All Implemented Interfaces:

IPointer, IVkGeneratedCommandsShaderInfoEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkGeneratedCommandsShaderInfoEXT(@NotNull MemorySegment segment)
extends Record
implements IVkGeneratedCommandsShaderInfoEXT

Represents a pointer to a VkGeneratedCommandsShaderInfoEXT structure in native memory.

Structure

typedef struct VkGeneratedCommandsShaderInfoEXT {
    VkStructureType sType;
    void* pNext; // optional
    uint32_t shaderCount;
    VkShaderEXT const* pShaders;
} VkGeneratedCommandsShaderInfoEXT;

Auto initialization

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

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

• VkGeneratedCommandsShaderInfoEXT

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$shaderCount

PATH$pShaders

public static final MemoryLayout.PathElement PATH$pShaders

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$shaderCount

public static final ValueLayout.OfInt LAYOUT$shaderCount

LAYOUT$pShaders

public static final AddressLayout LAYOUT$pShaders

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$shaderCount

public static final long SIZE$shaderCount

SIZE$pShaders

public static final long SIZE$pShaders

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$shaderCount

public static final long OFFSET$shaderCount

OFFSET$pShaders

public static final long OFFSET$pShaders

Constructor Details

VkGeneratedCommandsShaderInfoEXT

public VkGeneratedCommandsShaderInfoEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkGeneratedCommandsShaderInfoEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkGeneratedCommandsShaderInfoEXT allocate(Arena arena)

allocate

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

clone

public static VkGeneratedCommandsShaderInfoEXT clone(Arena arena,
 VkGeneratedCommandsShaderInfoEXT src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkGeneratedCommandsShaderInfoEXT pNext(@Nullable
 @Nullable IPointer pointer)

shaderCount

@Unsigned
public int shaderCount()

shaderCount

public VkGeneratedCommandsShaderInfoEXT shaderCount(@Unsigned
 int value)

pShaders

@Nullable
public VkShaderEXT.Ptr pShaders()

Note: the returned VkShaderEXT.Ptr does not have correct VkShaderEXT.Ptr.size() property. It's up to user to track the size of the buffer, and use VkShaderEXT.Ptr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pShaders

public VkGeneratedCommandsShaderInfoEXT pShaders(@Nullable
 VkShaderEXT.Ptr value)

pShadersRaw

@Pointer(target=VkShaderEXT.class)
public MemorySegment pShadersRaw()

pShadersRaw

public void pShadersRaw(@Pointer(target=VkShaderEXT.class)
 MemorySegment 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