Record Class VkDrmFormatModifierPropertiesEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDrmFormatModifierPropertiesEXT

All Implemented Interfaces:

IPointer, IVkDrmFormatModifierPropertiesEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkDrmFormatModifierPropertiesEXT(@NotNull MemorySegment segment)
extends Record
implements IVkDrmFormatModifierPropertiesEXT

Represents a pointer to a VkDrmFormatModifierPropertiesEXT structure in native memory.

Structure

typedef struct VkDrmFormatModifierPropertiesEXT {
    uint64_t drmFormatModifier;
    uint32_t drmFormatModifierPlaneCount;
    VkFormatFeatureFlags drmFormatModifierTilingFeatures;
} VkDrmFormatModifierPropertiesEXT;

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:

• VkDrmFormatModifierPropertiesEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$drmFormatModifier
static final ValueLayout.OfInt	LAYOUT$drmFormatModifierPlaneCount
static final ValueLayout.OfInt	LAYOUT$drmFormatModifierTilingFeatures
static final long	OFFSET$drmFormatModifier
static final long	OFFSET$drmFormatModifierPlaneCount
static final long	OFFSET$drmFormatModifierTilingFeatures
static final MemoryLayout.PathElement	PATH$drmFormatModifier
static final MemoryLayout.PathElement	PATH$drmFormatModifierPlaneCount
static final MemoryLayout.PathElement	PATH$drmFormatModifierTilingFeatures
static final long	SIZE$drmFormatModifier
static final long	SIZE$drmFormatModifierPlaneCount
static final long	SIZE$drmFormatModifierTilingFeatures

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDrmFormatModifierPropertiesEXT	allocate(Arena arena)
static VkDrmFormatModifierPropertiesEXT.Ptr	allocate(Arena arena, long count)
static VkDrmFormatModifierPropertiesEXT	clone(Arena arena, VkDrmFormatModifierPropertiesEXT src)
long	drmFormatModifier()
VkDrmFormatModifierPropertiesEXT	drmFormatModifier(long value)
int	drmFormatModifierPlaneCount()
VkDrmFormatModifierPropertiesEXT	drmFormatModifierPlaneCount(int value)
int	drmFormatModifierTilingFeatures()
VkDrmFormatModifierPropertiesEXT	drmFormatModifierTilingFeatures(int 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 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$drmFormatModifier

public static final MemoryLayout.PathElement PATH$drmFormatModifier

PATH$drmFormatModifierPlaneCount

public static final MemoryLayout.PathElement PATH$drmFormatModifierPlaneCount

PATH$drmFormatModifierTilingFeatures

public static final MemoryLayout.PathElement PATH$drmFormatModifierTilingFeatures

LAYOUT$drmFormatModifier

public static final ValueLayout.OfLong LAYOUT$drmFormatModifier

LAYOUT$drmFormatModifierPlaneCount

public static final ValueLayout.OfInt LAYOUT$drmFormatModifierPlaneCount

LAYOUT$drmFormatModifierTilingFeatures

public static final ValueLayout.OfInt LAYOUT$drmFormatModifierTilingFeatures

SIZE$drmFormatModifier

public static final long SIZE$drmFormatModifier

SIZE$drmFormatModifierPlaneCount

public static final long SIZE$drmFormatModifierPlaneCount

SIZE$drmFormatModifierTilingFeatures

public static final long SIZE$drmFormatModifierTilingFeatures

OFFSET$drmFormatModifier

public static final long OFFSET$drmFormatModifier

OFFSET$drmFormatModifierPlaneCount

public static final long OFFSET$drmFormatModifierPlaneCount

OFFSET$drmFormatModifierTilingFeatures

public static final long OFFSET$drmFormatModifierTilingFeatures

Constructor Details

VkDrmFormatModifierPropertiesEXT

public VkDrmFormatModifierPropertiesEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDrmFormatModifierPropertiesEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDrmFormatModifierPropertiesEXT allocate(Arena arena)

allocate

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

clone

public static VkDrmFormatModifierPropertiesEXT clone(Arena arena,
 VkDrmFormatModifierPropertiesEXT src)

drmFormatModifier

@Unsigned
public long drmFormatModifier()

drmFormatModifier

public VkDrmFormatModifierPropertiesEXT drmFormatModifier(@Unsigned
 long value)

drmFormatModifierPlaneCount

@Unsigned
public int drmFormatModifierPlaneCount()

drmFormatModifierPlaneCount

public VkDrmFormatModifierPropertiesEXT drmFormatModifierPlaneCount(@Unsigned
 int value)

drmFormatModifierTilingFeatures

@Bitmask(VkFormatFeatureFlags.class)
public int drmFormatModifierTilingFeatures()

drmFormatModifierTilingFeatures

public VkDrmFormatModifierPropertiesEXT drmFormatModifierTilingFeatures(@Bitmask(VkFormatFeatureFlags.class)
 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