Record Class VkDisplayPropertiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDisplayPropertiesKHR

All Implemented Interfaces:

IPointer, IVkDisplayPropertiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkDisplayPropertiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkDisplayPropertiesKHR

Represents a pointer to a VkDisplayPropertiesKHR structure in native memory.

Structure

typedef struct VkDisplayPropertiesKHR {
    VkDisplayKHR display;
    char const* displayName;
    VkExtent2D physicalDimensions;
    VkExtent2D physicalResolution;
    VkSurfaceTransformFlagsKHR supportedTransforms; // optional
    VkBool32 planeReorderPossible;
    VkBool32 persistentContent;
} VkDisplayPropertiesKHR;

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:

• VkDisplayPropertiesKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDisplayPropertiesKHR.Ptr	Represents a pointer to / an array of VkDisplayPropertiesKHR 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$display
static final AddressLayout	LAYOUT$displayName
static final ValueLayout.OfInt	LAYOUT$persistentContent
static final StructLayout	LAYOUT$physicalDimensions
static final StructLayout	LAYOUT$physicalResolution
static final ValueLayout.OfInt	LAYOUT$planeReorderPossible
static final ValueLayout.OfInt	LAYOUT$supportedTransforms
static final long	OFFSET$display
static final long	OFFSET$displayName
static final long	OFFSET$persistentContent
static final long	OFFSET$physicalDimensions
static final long	OFFSET$physicalResolution
static final long	OFFSET$planeReorderPossible
static final long	OFFSET$supportedTransforms
static final MemoryLayout.PathElement	PATH$display
static final MemoryLayout.PathElement	PATH$displayName
static final MemoryLayout.PathElement	PATH$persistentContent
static final MemoryLayout.PathElement	PATH$physicalDimensions
static final MemoryLayout.PathElement	PATH$physicalResolution
static final MemoryLayout.PathElement	PATH$planeReorderPossible
static final MemoryLayout.PathElement	PATH$supportedTransforms
static final long	SIZE$display
static final long	SIZE$displayName
static final long	SIZE$persistentContent
static final long	SIZE$physicalDimensions
static final long	SIZE$physicalResolution
static final long	SIZE$planeReorderPossible
static final long	SIZE$supportedTransforms

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDisplayPropertiesKHR	allocate(Arena arena)
static VkDisplayPropertiesKHR.Ptr	allocate(Arena arena, long count)
static VkDisplayPropertiesKHR	clone(Arena arena, VkDisplayPropertiesKHR src)
@Nullable VkDisplayKHR	display()
VkDisplayPropertiesKHR	display(@Nullable VkDisplayKHR value)
@Nullable BytePtr	displayName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
VkDisplayPropertiesKHR	displayName(@Nullable BytePtr value)
MemorySegment	displayNameRaw()
void	displayNameRaw(MemorySegment 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.
int	persistentContent()
VkDisplayPropertiesKHR	persistentContent(int value)
@NotNull VkExtent2D	physicalDimensions()
VkDisplayPropertiesKHR	physicalDimensions(@NotNull VkExtent2D value)
VkDisplayPropertiesKHR	physicalDimensions(Consumer<@NotNull VkExtent2D> consumer)
@NotNull VkExtent2D	physicalResolution()
VkDisplayPropertiesKHR	physicalResolution(@NotNull VkExtent2D value)
VkDisplayPropertiesKHR	physicalResolution(Consumer<@NotNull VkExtent2D> consumer)
int	planeReorderPossible()
VkDisplayPropertiesKHR	planeReorderPossible(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	supportedTransforms()
VkDisplayPropertiesKHR	supportedTransforms(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$display

public static final MemoryLayout.PathElement PATH$display

PATH$displayName

public static final MemoryLayout.PathElement PATH$displayName

PATH$physicalDimensions

public static final MemoryLayout.PathElement PATH$physicalDimensions

PATH$physicalResolution

public static final MemoryLayout.PathElement PATH$physicalResolution

PATH$supportedTransforms

public static final MemoryLayout.PathElement PATH$supportedTransforms

PATH$planeReorderPossible

public static final MemoryLayout.PathElement PATH$planeReorderPossible

PATH$persistentContent

public static final MemoryLayout.PathElement PATH$persistentContent

LAYOUT$display

public static final AddressLayout LAYOUT$display

LAYOUT$displayName

public static final AddressLayout LAYOUT$displayName

LAYOUT$physicalDimensions

public static final StructLayout LAYOUT$physicalDimensions

LAYOUT$physicalResolution

public static final StructLayout LAYOUT$physicalResolution

LAYOUT$supportedTransforms

public static final ValueLayout.OfInt LAYOUT$supportedTransforms

LAYOUT$planeReorderPossible

public static final ValueLayout.OfInt LAYOUT$planeReorderPossible

LAYOUT$persistentContent

public static final ValueLayout.OfInt LAYOUT$persistentContent

SIZE$display

public static final long SIZE$display

SIZE$displayName

public static final long SIZE$displayName

SIZE$physicalDimensions

public static final long SIZE$physicalDimensions

SIZE$physicalResolution

public static final long SIZE$physicalResolution

SIZE$supportedTransforms

public static final long SIZE$supportedTransforms

SIZE$planeReorderPossible

public static final long SIZE$planeReorderPossible

SIZE$persistentContent

public static final long SIZE$persistentContent

OFFSET$display

public static final long OFFSET$display

OFFSET$displayName

public static final long OFFSET$displayName

OFFSET$physicalDimensions

public static final long OFFSET$physicalDimensions

OFFSET$physicalResolution

public static final long OFFSET$physicalResolution

OFFSET$supportedTransforms

public static final long OFFSET$supportedTransforms

OFFSET$planeReorderPossible

public static final long OFFSET$planeReorderPossible

OFFSET$persistentContent

public static final long OFFSET$persistentContent

Constructor Details

VkDisplayPropertiesKHR

public VkDisplayPropertiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDisplayPropertiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDisplayPropertiesKHR allocate(Arena arena)

allocate

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

clone

public static VkDisplayPropertiesKHR clone(Arena arena,
 VkDisplayPropertiesKHR src)

display

@Nullable
public @Nullable VkDisplayKHR display()

display

public VkDisplayPropertiesKHR display(@Nullable
 @Nullable VkDisplayKHR value)

displayName

@Nullable
public @Nullable BytePtr displayName()

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

displayName

public VkDisplayPropertiesKHR displayName(@Nullable
 @Nullable BytePtr value)

displayNameRaw

@Pointer(comment="int8_t*")
public MemorySegment displayNameRaw()

displayNameRaw

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

physicalDimensions

@NotNull
public @NotNull VkExtent2D physicalDimensions()

physicalDimensions

public VkDisplayPropertiesKHR physicalDimensions(@NotNull
 @NotNull VkExtent2D value)

physicalDimensions

public VkDisplayPropertiesKHR physicalDimensions(Consumer<@NotNull VkExtent2D> consumer)

physicalResolution

@NotNull
public @NotNull VkExtent2D physicalResolution()

physicalResolution

public VkDisplayPropertiesKHR physicalResolution(@NotNull
 @NotNull VkExtent2D value)

physicalResolution

public VkDisplayPropertiesKHR physicalResolution(Consumer<@NotNull VkExtent2D> consumer)

supportedTransforms

@EnumType(VkSurfaceTransformFlagsKHR.class)
public int supportedTransforms()

supportedTransforms

public VkDisplayPropertiesKHR supportedTransforms(@EnumType(VkSurfaceTransformFlagsKHR.class)
 int value)

planeReorderPossible

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

planeReorderPossible

public VkDisplayPropertiesKHR planeReorderPossible(@NativeType("VkBool32") @Unsigned
 int value)

persistentContent

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

persistentContent

public VkDisplayPropertiesKHR persistentContent(@NativeType("VkBool32") @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