Record Class VkDisplayModePropertiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDisplayModePropertiesKHR

All Implemented Interfaces:

IPointer, IVkDisplayModePropertiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkDisplayModePropertiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkDisplayModePropertiesKHR

Represents a pointer to a VkDisplayModePropertiesKHR structure in native memory.

Structure

typedef struct VkDisplayModePropertiesKHR {
    VkDisplayModeKHR displayMode;
    VkDisplayModeParametersKHR parameters;
} VkDisplayModePropertiesKHR;

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:

• VkDisplayModePropertiesKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDisplayModePropertiesKHR.Ptr	Represents a pointer to / an array of VkDisplayModePropertiesKHR 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$displayMode
static final StructLayout	LAYOUT$parameters
static final long	OFFSET$displayMode
static final long	OFFSET$parameters
static final MemoryLayout.PathElement	PATH$displayMode
static final MemoryLayout.PathElement	PATH$parameters
static final long	SIZE$displayMode
static final long	SIZE$parameters

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDisplayModePropertiesKHR	allocate(Arena arena)
static VkDisplayModePropertiesKHR.Ptr	allocate(Arena arena, long count)
static VkDisplayModePropertiesKHR	clone(Arena arena, VkDisplayModePropertiesKHR src)
@Nullable VkDisplayModeKHR	displayMode()
VkDisplayModePropertiesKHR	displayMode(@Nullable VkDisplayModeKHR value)
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.
@NotNull VkDisplayModeParametersKHR	parameters()
VkDisplayModePropertiesKHR	parameters(@NotNull VkDisplayModeParametersKHR value)
VkDisplayModePropertiesKHR	parameters(Consumer<@NotNull VkDisplayModeParametersKHR> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$displayMode

public static final MemoryLayout.PathElement PATH$displayMode

PATH$parameters

public static final MemoryLayout.PathElement PATH$parameters

LAYOUT$displayMode

public static final AddressLayout LAYOUT$displayMode

LAYOUT$parameters

public static final StructLayout LAYOUT$parameters

SIZE$displayMode

public static final long SIZE$displayMode

SIZE$parameters

public static final long SIZE$parameters

OFFSET$displayMode

public static final long OFFSET$displayMode

OFFSET$parameters

public static final long OFFSET$parameters

Constructor Details

VkDisplayModePropertiesKHR

public VkDisplayModePropertiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDisplayModePropertiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDisplayModePropertiesKHR allocate(Arena arena)

allocate

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

clone

public static VkDisplayModePropertiesKHR clone(Arena arena,
 VkDisplayModePropertiesKHR src)

displayMode

@Nullable
public @Nullable VkDisplayModeKHR displayMode()

displayMode

public VkDisplayModePropertiesKHR displayMode(@Nullable
 @Nullable VkDisplayModeKHR value)

parameters

@NotNull
public @NotNull VkDisplayModeParametersKHR parameters()

parameters

public VkDisplayModePropertiesKHR parameters(@NotNull
 @NotNull VkDisplayModeParametersKHR value)

parameters

public VkDisplayModePropertiesKHR parameters(Consumer<@NotNull VkDisplayModeParametersKHR> consumer)

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