Record Class VkFormatProperties

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkFormatProperties

All Implemented Interfaces:

IPointer, IVkFormatProperties

@ValueBasedCandidate
@UnsafeConstructor
public record VkFormatProperties(@NotNull MemorySegment segment)
extends Record
implements IVkFormatProperties

Represents a pointer to a VkFormatProperties structure in native memory.

Structure

typedef struct VkFormatProperties {
    VkFormatFeatureFlags linearTilingFeatures; // optional
    VkFormatFeatureFlags optimalTilingFeatures; // optional
    VkFormatFeatureFlags bufferFeatures; // optional
} VkFormatProperties;

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:

• VkFormatProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkFormatProperties.Ptr	Represents a pointer to / an array of VkFormatProperties 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$bufferFeatures
static final ValueLayout.OfInt	LAYOUT$linearTilingFeatures
static final ValueLayout.OfInt	LAYOUT$optimalTilingFeatures
static final long	OFFSET$bufferFeatures
static final long	OFFSET$linearTilingFeatures
static final long	OFFSET$optimalTilingFeatures
static final MemoryLayout.PathElement	PATH$bufferFeatures
static final MemoryLayout.PathElement	PATH$linearTilingFeatures
static final MemoryLayout.PathElement	PATH$optimalTilingFeatures
static final long	SIZE$bufferFeatures
static final long	SIZE$linearTilingFeatures
static final long	SIZE$optimalTilingFeatures

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkFormatProperties	allocate(Arena arena)
static VkFormatProperties.Ptr	allocate(Arena arena, long count)
int	bufferFeatures()
VkFormatProperties	bufferFeatures(int value)
static VkFormatProperties	clone(Arena arena, VkFormatProperties 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	linearTilingFeatures()
VkFormatProperties	linearTilingFeatures(int value)
int	optimalTilingFeatures()
VkFormatProperties	optimalTilingFeatures(int value)
@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$linearTilingFeatures

public static final MemoryLayout.PathElement PATH$linearTilingFeatures

PATH$optimalTilingFeatures

public static final MemoryLayout.PathElement PATH$optimalTilingFeatures

PATH$bufferFeatures

public static final MemoryLayout.PathElement PATH$bufferFeatures

LAYOUT$linearTilingFeatures

public static final ValueLayout.OfInt LAYOUT$linearTilingFeatures

LAYOUT$optimalTilingFeatures

public static final ValueLayout.OfInt LAYOUT$optimalTilingFeatures

LAYOUT$bufferFeatures

public static final ValueLayout.OfInt LAYOUT$bufferFeatures

SIZE$linearTilingFeatures

public static final long SIZE$linearTilingFeatures

SIZE$optimalTilingFeatures

public static final long SIZE$optimalTilingFeatures

SIZE$bufferFeatures

public static final long SIZE$bufferFeatures

OFFSET$linearTilingFeatures

public static final long OFFSET$linearTilingFeatures

OFFSET$optimalTilingFeatures

public static final long OFFSET$optimalTilingFeatures

OFFSET$bufferFeatures

public static final long OFFSET$bufferFeatures

Constructor Details

VkFormatProperties

public VkFormatProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkFormatProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkFormatProperties allocate(Arena arena)

allocate

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

clone

public static VkFormatProperties clone(Arena arena,
 VkFormatProperties src)

linearTilingFeatures

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

linearTilingFeatures

public VkFormatProperties linearTilingFeatures(@Bitmask(VkFormatFeatureFlags.class)
 int value)

optimalTilingFeatures

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

optimalTilingFeatures

public VkFormatProperties optimalTilingFeatures(@Bitmask(VkFormatFeatureFlags.class)
 int value)

bufferFeatures

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

bufferFeatures

public VkFormatProperties bufferFeatures(@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