Record Class VkImageFormatProperties

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageFormatProperties

All Implemented Interfaces:

IPointer, IVkImageFormatProperties

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageFormatProperties(@NotNull MemorySegment segment)
extends Record
implements IVkImageFormatProperties

Represents a pointer to a VkImageFormatProperties structure in native memory.

Structure

typedef struct VkImageFormatProperties {
    VkExtent3D maxExtent;
    uint32_t maxMipLevels;
    uint32_t maxArrayLayers;
    VkSampleCountFlags sampleCounts; // optional
    VkDeviceSize maxResourceSize;
} VkImageFormatProperties;

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:

• VkImageFormatProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkImageFormatProperties.Ptr	Represents a pointer to / an array of VkImageFormatProperties 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$maxArrayLayers
static final StructLayout	LAYOUT$maxExtent
static final ValueLayout.OfInt	LAYOUT$maxMipLevels
static final ValueLayout.OfLong	LAYOUT$maxResourceSize
static final ValueLayout.OfInt	LAYOUT$sampleCounts
static final long	OFFSET$maxArrayLayers
static final long	OFFSET$maxExtent
static final long	OFFSET$maxMipLevels
static final long	OFFSET$maxResourceSize
static final long	OFFSET$sampleCounts
static final MemoryLayout.PathElement	PATH$maxArrayLayers
static final MemoryLayout.PathElement	PATH$maxExtent
static final MemoryLayout.PathElement	PATH$maxMipLevels
static final MemoryLayout.PathElement	PATH$maxResourceSize
static final MemoryLayout.PathElement	PATH$sampleCounts
static final long	SIZE$maxArrayLayers
static final long	SIZE$maxExtent
static final long	SIZE$maxMipLevels
static final long	SIZE$maxResourceSize
static final long	SIZE$sampleCounts

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageFormatProperties	allocate(Arena arena)
static VkImageFormatProperties.Ptr	allocate(Arena arena, long count)
static VkImageFormatProperties	clone(Arena arena, VkImageFormatProperties 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	maxArrayLayers()
VkImageFormatProperties	maxArrayLayers(int value)
@NotNull VkExtent3D	maxExtent()
VkImageFormatProperties	maxExtent(@NotNull VkExtent3D value)
VkImageFormatProperties	maxExtent(Consumer<@NotNull VkExtent3D> consumer)
int	maxMipLevels()
VkImageFormatProperties	maxMipLevels(int value)
long	maxResourceSize()
VkImageFormatProperties	maxResourceSize(long value)
int	sampleCounts()
VkImageFormatProperties	sampleCounts(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$maxExtent

public static final MemoryLayout.PathElement PATH$maxExtent

PATH$maxMipLevels

public static final MemoryLayout.PathElement PATH$maxMipLevels

PATH$maxArrayLayers

public static final MemoryLayout.PathElement PATH$maxArrayLayers

PATH$sampleCounts

public static final MemoryLayout.PathElement PATH$sampleCounts

PATH$maxResourceSize

public static final MemoryLayout.PathElement PATH$maxResourceSize

LAYOUT$maxExtent

public static final StructLayout LAYOUT$maxExtent

LAYOUT$maxMipLevels

public static final ValueLayout.OfInt LAYOUT$maxMipLevels

LAYOUT$maxArrayLayers

public static final ValueLayout.OfInt LAYOUT$maxArrayLayers

LAYOUT$sampleCounts

public static final ValueLayout.OfInt LAYOUT$sampleCounts

LAYOUT$maxResourceSize

public static final ValueLayout.OfLong LAYOUT$maxResourceSize

SIZE$maxExtent

public static final long SIZE$maxExtent

SIZE$maxMipLevels

public static final long SIZE$maxMipLevels

SIZE$maxArrayLayers

public static final long SIZE$maxArrayLayers

SIZE$sampleCounts

public static final long SIZE$sampleCounts

SIZE$maxResourceSize

public static final long SIZE$maxResourceSize

OFFSET$maxExtent

public static final long OFFSET$maxExtent

OFFSET$maxMipLevels

public static final long OFFSET$maxMipLevels

OFFSET$maxArrayLayers

public static final long OFFSET$maxArrayLayers

OFFSET$sampleCounts

public static final long OFFSET$sampleCounts

OFFSET$maxResourceSize

public static final long OFFSET$maxResourceSize

Constructor Details

VkImageFormatProperties

public VkImageFormatProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageFormatProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageFormatProperties allocate(Arena arena)

allocate

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

clone

public static VkImageFormatProperties clone(Arena arena,
 VkImageFormatProperties src)

maxExtent

@NotNull
public @NotNull VkExtent3D maxExtent()

maxExtent

public VkImageFormatProperties maxExtent(@NotNull
 @NotNull VkExtent3D value)

maxExtent

public VkImageFormatProperties maxExtent(Consumer<@NotNull VkExtent3D> consumer)

maxMipLevels

@Unsigned
public int maxMipLevels()

maxMipLevels

public VkImageFormatProperties maxMipLevels(@Unsigned
 int value)

maxArrayLayers

@Unsigned
public int maxArrayLayers()

maxArrayLayers

public VkImageFormatProperties maxArrayLayers(@Unsigned
 int value)

sampleCounts

@EnumType(VkSampleCountFlags.class)
public int sampleCounts()

sampleCounts

public VkImageFormatProperties sampleCounts(@EnumType(VkSampleCountFlags.class)
 int value)

maxResourceSize

@NativeType("VkDeviceSize")
@Unsigned
public long maxResourceSize()

maxResourceSize

public VkImageFormatProperties maxResourceSize(@NativeType("VkDeviceSize") @Unsigned
 long 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