Record Class VkDecompressMemoryRegionNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDecompressMemoryRegionNV

All Implemented Interfaces:

IPointer, IVkDecompressMemoryRegionNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkDecompressMemoryRegionNV(@NotNull MemorySegment segment)
extends Record
implements IVkDecompressMemoryRegionNV

Represents a pointer to a VkDecompressMemoryRegionNV structure in native memory.

Structure

typedef struct VkDecompressMemoryRegionNV {
    VkDeviceAddress srcAddress;
    VkDeviceAddress dstAddress;
    VkDeviceSize compressedSize;
    VkDeviceSize decompressedSize;
    VkMemoryDecompressionMethodFlagsNV decompressionMethod;
} VkDecompressMemoryRegionNV;

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:

• VkDecompressMemoryRegionNV

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDecompressMemoryRegionNV.Ptr	Represents a pointer to / an array of VkDecompressMemoryRegionNV 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$compressedSize
static final ValueLayout.OfLong	LAYOUT$decompressedSize
static final ValueLayout.OfLong	LAYOUT$decompressionMethod
static final ValueLayout.OfLong	LAYOUT$dstAddress
static final ValueLayout.OfLong	LAYOUT$srcAddress
static final long	OFFSET$compressedSize
static final long	OFFSET$decompressedSize
static final long	OFFSET$decompressionMethod
static final long	OFFSET$dstAddress
static final long	OFFSET$srcAddress
static final MemoryLayout.PathElement	PATH$compressedSize
static final MemoryLayout.PathElement	PATH$decompressedSize
static final MemoryLayout.PathElement	PATH$decompressionMethod
static final MemoryLayout.PathElement	PATH$dstAddress
static final MemoryLayout.PathElement	PATH$srcAddress
static final long	SIZE$compressedSize
static final long	SIZE$decompressedSize
static final long	SIZE$decompressionMethod
static final long	SIZE$dstAddress
static final long	SIZE$srcAddress

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDecompressMemoryRegionNV	allocate(Arena arena)
static VkDecompressMemoryRegionNV.Ptr	allocate(Arena arena, long count)
static VkDecompressMemoryRegionNV	clone(Arena arena, VkDecompressMemoryRegionNV src)
long	compressedSize()
VkDecompressMemoryRegionNV	compressedSize(long value)
long	decompressedSize()
VkDecompressMemoryRegionNV	decompressedSize(long value)
long	decompressionMethod()
VkDecompressMemoryRegionNV	decompressionMethod(long value)
long	dstAddress()
VkDecompressMemoryRegionNV	dstAddress(long 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.
long	srcAddress()
VkDecompressMemoryRegionNV	srcAddress(long 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$srcAddress

public static final MemoryLayout.PathElement PATH$srcAddress

PATH$dstAddress

public static final MemoryLayout.PathElement PATH$dstAddress

PATH$compressedSize

public static final MemoryLayout.PathElement PATH$compressedSize

PATH$decompressedSize

public static final MemoryLayout.PathElement PATH$decompressedSize

PATH$decompressionMethod

public static final MemoryLayout.PathElement PATH$decompressionMethod

LAYOUT$srcAddress

public static final ValueLayout.OfLong LAYOUT$srcAddress

LAYOUT$dstAddress

public static final ValueLayout.OfLong LAYOUT$dstAddress

LAYOUT$compressedSize

public static final ValueLayout.OfLong LAYOUT$compressedSize

LAYOUT$decompressedSize

public static final ValueLayout.OfLong LAYOUT$decompressedSize

LAYOUT$decompressionMethod

public static final ValueLayout.OfLong LAYOUT$decompressionMethod

SIZE$srcAddress

public static final long SIZE$srcAddress

SIZE$dstAddress

public static final long SIZE$dstAddress

SIZE$compressedSize

public static final long SIZE$compressedSize

SIZE$decompressedSize

public static final long SIZE$decompressedSize

SIZE$decompressionMethod

public static final long SIZE$decompressionMethod

OFFSET$srcAddress

public static final long OFFSET$srcAddress

OFFSET$dstAddress

public static final long OFFSET$dstAddress

OFFSET$compressedSize

public static final long OFFSET$compressedSize

OFFSET$decompressedSize

public static final long OFFSET$decompressedSize

OFFSET$decompressionMethod

public static final long OFFSET$decompressionMethod

Constructor Details

VkDecompressMemoryRegionNV

public VkDecompressMemoryRegionNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDecompressMemoryRegionNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDecompressMemoryRegionNV allocate(Arena arena)

allocate

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

clone

public static VkDecompressMemoryRegionNV clone(Arena arena,
 VkDecompressMemoryRegionNV src)

srcAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long srcAddress()

srcAddress

public VkDecompressMemoryRegionNV srcAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

dstAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long dstAddress()

dstAddress

public VkDecompressMemoryRegionNV dstAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

compressedSize

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

compressedSize

public VkDecompressMemoryRegionNV compressedSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

decompressedSize

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

decompressedSize

public VkDecompressMemoryRegionNV decompressedSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

decompressionMethod

@EnumType(VkMemoryDecompressionMethodFlagsNV.class)
public long decompressionMethod()

decompressionMethod

public VkDecompressMemoryRegionNV decompressionMethod(@EnumType(VkMemoryDecompressionMethodFlagsNV.class)
 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