Record Class VkPhysicalDeviceSparseProperties

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceSparseProperties

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceSparseProperties

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceSparseProperties(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceSparseProperties

Represents a pointer to a VkPhysicalDeviceSparseProperties structure in native memory.

Structure

typedef struct VkPhysicalDeviceSparseProperties {
    VkBool32 residencyStandard2DBlockShape;
    VkBool32 residencyStandard2DMultisampleBlockShape;
    VkBool32 residencyStandard3DBlockShape;
    VkBool32 residencyAlignedMipSize;
    VkBool32 residencyNonResidentStrict;
} VkPhysicalDeviceSparseProperties;

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:

• VkPhysicalDeviceSparseProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPhysicalDeviceSparseProperties.Ptr	Represents a pointer to / an array of VkPhysicalDeviceSparseProperties 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$residencyAlignedMipSize
static final ValueLayout.OfInt	LAYOUT$residencyNonResidentStrict
static final ValueLayout.OfInt	LAYOUT$residencyStandard2DBlockShape
static final ValueLayout.OfInt	LAYOUT$residencyStandard2DMultisampleBlockShape
static final ValueLayout.OfInt	LAYOUT$residencyStandard3DBlockShape
static final long	OFFSET$residencyAlignedMipSize
static final long	OFFSET$residencyNonResidentStrict
static final long	OFFSET$residencyStandard2DBlockShape
static final long	OFFSET$residencyStandard2DMultisampleBlockShape
static final long	OFFSET$residencyStandard3DBlockShape
static final MemoryLayout.PathElement	PATH$residencyAlignedMipSize
static final MemoryLayout.PathElement	PATH$residencyNonResidentStrict
static final MemoryLayout.PathElement	PATH$residencyStandard2DBlockShape
static final MemoryLayout.PathElement	PATH$residencyStandard2DMultisampleBlockShape
static final MemoryLayout.PathElement	PATH$residencyStandard3DBlockShape
static final long	SIZE$residencyAlignedMipSize
static final long	SIZE$residencyNonResidentStrict
static final long	SIZE$residencyStandard2DBlockShape
static final long	SIZE$residencyStandard2DMultisampleBlockShape
static final long	SIZE$residencyStandard3DBlockShape

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceSparseProperties	allocate(Arena arena)
static VkPhysicalDeviceSparseProperties.Ptr	allocate(Arena arena, long count)
static VkPhysicalDeviceSparseProperties	clone(Arena arena, VkPhysicalDeviceSparseProperties 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	residencyAlignedMipSize()
VkPhysicalDeviceSparseProperties	residencyAlignedMipSize(int value)
int	residencyNonResidentStrict()
VkPhysicalDeviceSparseProperties	residencyNonResidentStrict(int value)
int	residencyStandard2DBlockShape()
VkPhysicalDeviceSparseProperties	residencyStandard2DBlockShape(int value)
int	residencyStandard2DMultisampleBlockShape()
VkPhysicalDeviceSparseProperties	residencyStandard2DMultisampleBlockShape(int value)
int	residencyStandard3DBlockShape()
VkPhysicalDeviceSparseProperties	residencyStandard3DBlockShape(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$residencyStandard2DBlockShape

public static final MemoryLayout.PathElement PATH$residencyStandard2DBlockShape

PATH$residencyStandard2DMultisampleBlockShape

public static final MemoryLayout.PathElement PATH$residencyStandard2DMultisampleBlockShape

PATH$residencyStandard3DBlockShape

public static final MemoryLayout.PathElement PATH$residencyStandard3DBlockShape

PATH$residencyAlignedMipSize

public static final MemoryLayout.PathElement PATH$residencyAlignedMipSize

PATH$residencyNonResidentStrict

public static final MemoryLayout.PathElement PATH$residencyNonResidentStrict

LAYOUT$residencyStandard2DBlockShape

public static final ValueLayout.OfInt LAYOUT$residencyStandard2DBlockShape

LAYOUT$residencyStandard2DMultisampleBlockShape

public static final ValueLayout.OfInt LAYOUT$residencyStandard2DMultisampleBlockShape

LAYOUT$residencyStandard3DBlockShape

public static final ValueLayout.OfInt LAYOUT$residencyStandard3DBlockShape

LAYOUT$residencyAlignedMipSize

public static final ValueLayout.OfInt LAYOUT$residencyAlignedMipSize

LAYOUT$residencyNonResidentStrict

public static final ValueLayout.OfInt LAYOUT$residencyNonResidentStrict

SIZE$residencyStandard2DBlockShape

public static final long SIZE$residencyStandard2DBlockShape

SIZE$residencyStandard2DMultisampleBlockShape

public static final long SIZE$residencyStandard2DMultisampleBlockShape

SIZE$residencyStandard3DBlockShape

public static final long SIZE$residencyStandard3DBlockShape

SIZE$residencyAlignedMipSize

public static final long SIZE$residencyAlignedMipSize

SIZE$residencyNonResidentStrict

public static final long SIZE$residencyNonResidentStrict

OFFSET$residencyStandard2DBlockShape

public static final long OFFSET$residencyStandard2DBlockShape

OFFSET$residencyStandard2DMultisampleBlockShape

public static final long OFFSET$residencyStandard2DMultisampleBlockShape

OFFSET$residencyStandard3DBlockShape

public static final long OFFSET$residencyStandard3DBlockShape

OFFSET$residencyAlignedMipSize

public static final long OFFSET$residencyAlignedMipSize

OFFSET$residencyNonResidentStrict

public static final long OFFSET$residencyNonResidentStrict

Constructor Details

VkPhysicalDeviceSparseProperties

public VkPhysicalDeviceSparseProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceSparseProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceSparseProperties allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceSparseProperties clone(Arena arena,
 VkPhysicalDeviceSparseProperties src)

residencyStandard2DBlockShape

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

residencyStandard2DBlockShape

public VkPhysicalDeviceSparseProperties residencyStandard2DBlockShape(@NativeType("VkBool32") @Unsigned
 int value)

residencyStandard2DMultisampleBlockShape

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

residencyStandard2DMultisampleBlockShape

public VkPhysicalDeviceSparseProperties residencyStandard2DMultisampleBlockShape(@NativeType("VkBool32") @Unsigned
 int value)

residencyStandard3DBlockShape

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

residencyStandard3DBlockShape

public VkPhysicalDeviceSparseProperties residencyStandard3DBlockShape(@NativeType("VkBool32") @Unsigned
 int value)

residencyAlignedMipSize

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

residencyAlignedMipSize

public VkPhysicalDeviceSparseProperties residencyAlignedMipSize(@NativeType("VkBool32") @Unsigned
 int value)

residencyNonResidentStrict

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

residencyNonResidentStrict

public VkPhysicalDeviceSparseProperties residencyNonResidentStrict(@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