Record Class VkSemaphoreSciSyncCreateInfoNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSemaphoreSciSyncCreateInfoNV

All Implemented Interfaces:

IPointer, IVkSemaphoreSciSyncCreateInfoNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkSemaphoreSciSyncCreateInfoNV(@NotNull MemorySegment segment)
extends Record
implements IVkSemaphoreSciSyncCreateInfoNV

Represents a pointer to a VkSemaphoreSciSyncCreateInfoNV structure in native memory.

Structure

typedef struct VkSemaphoreSciSyncCreateInfoNV {
    VkStructureType sType;
    void const* pNext; // optional
    VkSemaphoreSciSyncPoolNV semaphorePool;
    NvSciSyncFence const* pFence;
} VkSemaphoreSciSyncCreateInfoNV;

Auto initialization

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

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

• VkSemaphoreSciSyncCreateInfoNV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSemaphoreSciSyncCreateInfoNV	allocate(Arena arena)
static VkSemaphoreSciSyncCreateInfoNV.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkSemaphoreSciSyncCreateInfoNV	clone(Arena arena, VkSemaphoreSciSyncCreateInfoNV 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 NvSciSyncFenceVKREF	pFence()
NvSciSyncFenceVKREF.Ptr	pFence(int assumedCount)
VkSemaphoreSciSyncCreateInfoNV	pFence(@Nullable INvSciSyncFenceVKREF value)
MemorySegment	pFenceRaw()
void	pFenceRaw(MemorySegment value)
MemorySegment	pNext()
VkSemaphoreSciSyncCreateInfoNV	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable VkSemaphoreSciSyncPoolNV	semaphorePool()
VkSemaphoreSciSyncCreateInfoNV	semaphorePool(@Nullable VkSemaphoreSciSyncPoolNV value)
int	sType()
VkSemaphoreSciSyncCreateInfoNV	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$semaphorePool

public static final MemoryLayout.PathElement PATH$semaphorePool

PATH$pFence

public static final MemoryLayout.PathElement PATH$pFence

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$semaphorePool

public static final AddressLayout LAYOUT$semaphorePool

LAYOUT$pFence

public static final AddressLayout LAYOUT$pFence

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$semaphorePool

public static final long SIZE$semaphorePool

SIZE$pFence

public static final long SIZE$pFence

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$semaphorePool

public static final long OFFSET$semaphorePool

OFFSET$pFence

public static final long OFFSET$pFence

Constructor Details

VkSemaphoreSciSyncCreateInfoNV

public VkSemaphoreSciSyncCreateInfoNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSemaphoreSciSyncCreateInfoNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSemaphoreSciSyncCreateInfoNV allocate(Arena arena)

allocate

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

clone

public static VkSemaphoreSciSyncCreateInfoNV clone(Arena arena,
 VkSemaphoreSciSyncCreateInfoNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkSemaphoreSciSyncCreateInfoNV pNext(@Nullable
 @Nullable IPointer pointer)

semaphorePool

@Nullable
public @Nullable VkSemaphoreSciSyncPoolNV semaphorePool()

semaphorePool

public VkSemaphoreSciSyncCreateInfoNV semaphorePool(@Nullable
 @Nullable VkSemaphoreSciSyncPoolNV value)

pFence

public VkSemaphoreSciSyncCreateInfoNV pFence(@Nullable
 @Nullable INvSciSyncFenceVKREF value)

pFence

@Unsafe
@Nullable
public NvSciSyncFenceVKREF.Ptr pFence(int assumedCount)

pFence

@Nullable
public @Nullable NvSciSyncFenceVKREF pFence()

pFenceRaw

@Pointer(target=NvSciSyncFenceVKREF.class)
public MemorySegment pFenceRaw()

pFenceRaw

public void pFenceRaw(@Pointer(target=NvSciSyncFenceVKREF.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