Record Class VkLatencySleepModeInfoNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkLatencySleepModeInfoNV

All Implemented Interfaces:

IPointer, IVkLatencySleepModeInfoNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkLatencySleepModeInfoNV(@NotNull MemorySegment segment)
extends Record
implements IVkLatencySleepModeInfoNV

Represents a pointer to a VkLatencySleepModeInfoNV structure in native memory.

Structure

typedef struct VkLatencySleepModeInfoNV {
    VkStructureType sType;
    void const* pNext; // optional
    VkBool32 lowLatencyMode;
    VkBool32 lowLatencyBoost;
    uint32_t minimumIntervalUs;
} VkLatencySleepModeInfoNV;

Auto initialization

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

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

• VkLatencySleepModeInfoNV

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$lowLatencyBoost
static final ValueLayout.OfInt	LAYOUT$lowLatencyMode
static final ValueLayout.OfInt	LAYOUT$minimumIntervalUs
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$lowLatencyBoost
static final long	OFFSET$lowLatencyMode
static final long	OFFSET$minimumIntervalUs
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$lowLatencyBoost
static final MemoryLayout.PathElement	PATH$lowLatencyMode
static final MemoryLayout.PathElement	PATH$minimumIntervalUs
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$lowLatencyBoost
static final long	SIZE$lowLatencyMode
static final long	SIZE$minimumIntervalUs
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkLatencySleepModeInfoNV	allocate(Arena arena)
static VkLatencySleepModeInfoNV.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkLatencySleepModeInfoNV	clone(Arena arena, VkLatencySleepModeInfoNV 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.
int	lowLatencyBoost()
VkLatencySleepModeInfoNV	lowLatencyBoost(int value)
int	lowLatencyMode()
VkLatencySleepModeInfoNV	lowLatencyMode(int value)
int	minimumIntervalUs()
VkLatencySleepModeInfoNV	minimumIntervalUs(int value)
@NotNull MemorySegment	pNext()
VkLatencySleepModeInfoNV	pNext(@Nullable IPointer pointer)
VkLatencySleepModeInfoNV	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkLatencySleepModeInfoNV	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$lowLatencyMode

public static final MemoryLayout.PathElement PATH$lowLatencyMode

PATH$lowLatencyBoost

public static final MemoryLayout.PathElement PATH$lowLatencyBoost

PATH$minimumIntervalUs

public static final MemoryLayout.PathElement PATH$minimumIntervalUs

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$lowLatencyMode

public static final ValueLayout.OfInt LAYOUT$lowLatencyMode

LAYOUT$lowLatencyBoost

public static final ValueLayout.OfInt LAYOUT$lowLatencyBoost

LAYOUT$minimumIntervalUs

public static final ValueLayout.OfInt LAYOUT$minimumIntervalUs

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$lowLatencyMode

public static final long SIZE$lowLatencyMode

SIZE$lowLatencyBoost

public static final long SIZE$lowLatencyBoost

SIZE$minimumIntervalUs

public static final long SIZE$minimumIntervalUs

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$lowLatencyMode

public static final long OFFSET$lowLatencyMode

OFFSET$lowLatencyBoost

public static final long OFFSET$lowLatencyBoost

OFFSET$minimumIntervalUs

public static final long OFFSET$minimumIntervalUs

Constructor Details

VkLatencySleepModeInfoNV

public VkLatencySleepModeInfoNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkLatencySleepModeInfoNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkLatencySleepModeInfoNV allocate(Arena arena)

allocate

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

clone

public static VkLatencySleepModeInfoNV clone(Arena arena,
 VkLatencySleepModeInfoNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkLatencySleepModeInfoNV pNext(@Nullable
 @Nullable IPointer pointer)

lowLatencyMode

@NativeType("VkBool32")
@Unsigned
public int lowLatencyMode()

lowLatencyMode

public VkLatencySleepModeInfoNV lowLatencyMode(@NativeType("VkBool32") @Unsigned
 int value)

lowLatencyBoost

@NativeType("VkBool32")
@Unsigned
public int lowLatencyBoost()

lowLatencyBoost

public VkLatencySleepModeInfoNV lowLatencyBoost(@NativeType("VkBool32") @Unsigned
 int value)

minimumIntervalUs

@Unsigned
public int minimumIntervalUs()

minimumIntervalUs

public VkLatencySleepModeInfoNV minimumIntervalUs(@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