Record Class VkD3D12FenceSubmitInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkD3D12FenceSubmitInfoKHR

All Implemented Interfaces:

IPointer, IVkD3D12FenceSubmitInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkD3D12FenceSubmitInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkD3D12FenceSubmitInfoKHR

Represents a pointer to a VkD3D12FenceSubmitInfoKHR structure in native memory.

Structure

typedef struct VkD3D12FenceSubmitInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t waitSemaphoreValuesCount; // optional
    uint64_t const* pWaitSemaphoreValues; // optional
    uint32_t signalSemaphoreValuesCount; // optional
    uint64_t const* pSignalSemaphoreValues; // optional
} VkD3D12FenceSubmitInfoKHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_D3D12_FENCE_SUBMIT_INFO_KHR

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:

• VkD3D12FenceSubmitInfoKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkD3D12FenceSubmitInfoKHR	allocate(Arena arena)
static VkD3D12FenceSubmitInfoKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkD3D12FenceSubmitInfoKHR	clone(Arena arena, VkD3D12FenceSubmitInfoKHR 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()
VkD3D12FenceSubmitInfoKHR	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@Nullable LongPtr	pSignalSemaphoreValues()	Note: the returned LongPtr does not have correct LongPtr.size() property.
VkD3D12FenceSubmitInfoKHR	pSignalSemaphoreValues(@Nullable LongPtr value)
MemorySegment	pSignalSemaphoreValuesRaw()
void	pSignalSemaphoreValuesRaw(MemorySegment value)
@Nullable LongPtr	pWaitSemaphoreValues()	Note: the returned LongPtr does not have correct LongPtr.size() property.
VkD3D12FenceSubmitInfoKHR	pWaitSemaphoreValues(@Nullable LongPtr value)
MemorySegment	pWaitSemaphoreValuesRaw()
void	pWaitSemaphoreValuesRaw(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	signalSemaphoreValuesCount()
VkD3D12FenceSubmitInfoKHR	signalSemaphoreValuesCount(int value)
int	sType()
VkD3D12FenceSubmitInfoKHR	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	waitSemaphoreValuesCount()
VkD3D12FenceSubmitInfoKHR	waitSemaphoreValuesCount(int value)

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$waitSemaphoreValuesCount

public static final MemoryLayout.PathElement PATH$waitSemaphoreValuesCount

PATH$pWaitSemaphoreValues

public static final MemoryLayout.PathElement PATH$pWaitSemaphoreValues

PATH$signalSemaphoreValuesCount

public static final MemoryLayout.PathElement PATH$signalSemaphoreValuesCount

PATH$pSignalSemaphoreValues

public static final MemoryLayout.PathElement PATH$pSignalSemaphoreValues

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$waitSemaphoreValuesCount

public static final ValueLayout.OfInt LAYOUT$waitSemaphoreValuesCount

LAYOUT$pWaitSemaphoreValues

public static final AddressLayout LAYOUT$pWaitSemaphoreValues

LAYOUT$signalSemaphoreValuesCount

public static final ValueLayout.OfInt LAYOUT$signalSemaphoreValuesCount

LAYOUT$pSignalSemaphoreValues

public static final AddressLayout LAYOUT$pSignalSemaphoreValues

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$waitSemaphoreValuesCount

public static final long SIZE$waitSemaphoreValuesCount

SIZE$pWaitSemaphoreValues

public static final long SIZE$pWaitSemaphoreValues

SIZE$signalSemaphoreValuesCount

public static final long SIZE$signalSemaphoreValuesCount

SIZE$pSignalSemaphoreValues

public static final long SIZE$pSignalSemaphoreValues

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$waitSemaphoreValuesCount

public static final long OFFSET$waitSemaphoreValuesCount

OFFSET$pWaitSemaphoreValues

public static final long OFFSET$pWaitSemaphoreValues

OFFSET$signalSemaphoreValuesCount

public static final long OFFSET$signalSemaphoreValuesCount

OFFSET$pSignalSemaphoreValues

public static final long OFFSET$pSignalSemaphoreValues

Constructor Details

VkD3D12FenceSubmitInfoKHR

public VkD3D12FenceSubmitInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkD3D12FenceSubmitInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkD3D12FenceSubmitInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkD3D12FenceSubmitInfoKHR clone(Arena arena,
 VkD3D12FenceSubmitInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkD3D12FenceSubmitInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

waitSemaphoreValuesCount

@Unsigned
public int waitSemaphoreValuesCount()

waitSemaphoreValuesCount

public VkD3D12FenceSubmitInfoKHR waitSemaphoreValuesCount(@Unsigned
 int value)

pWaitSemaphoreValues

@Nullable
@Unsigned
public @Nullable LongPtr pWaitSemaphoreValues()

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

pWaitSemaphoreValues

public VkD3D12FenceSubmitInfoKHR pWaitSemaphoreValues(@Nullable @Unsigned
 @Nullable LongPtr value)

pWaitSemaphoreValuesRaw

@Pointer(comment="uint64_t*")
public MemorySegment pWaitSemaphoreValuesRaw()

pWaitSemaphoreValuesRaw

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

signalSemaphoreValuesCount

@Unsigned
public int signalSemaphoreValuesCount()

signalSemaphoreValuesCount

public VkD3D12FenceSubmitInfoKHR signalSemaphoreValuesCount(@Unsigned
 int value)

pSignalSemaphoreValues

@Nullable
@Unsigned
public @Nullable LongPtr pSignalSemaphoreValues()

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

pSignalSemaphoreValues

public VkD3D12FenceSubmitInfoKHR pSignalSemaphoreValues(@Nullable @Unsigned
 @Nullable LongPtr value)

pSignalSemaphoreValuesRaw

@Pointer(comment="uint64_t*")
public MemorySegment pSignalSemaphoreValuesRaw()

pSignalSemaphoreValuesRaw

public void pSignalSemaphoreValuesRaw(@Pointer(comment="uint64_t*")
 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