Record Class VkSubresourceLayout

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSubresourceLayout

All Implemented Interfaces:

IPointer, IVkSubresourceLayout

@ValueBasedCandidate
@UnsafeConstructor
public record VkSubresourceLayout(@NotNull MemorySegment segment)
extends Record
implements IVkSubresourceLayout

Represents a pointer to a VkSubresourceLayout structure in native memory.

Structure

typedef struct VkSubresourceLayout {
    VkDeviceSize offset;
    VkDeviceSize size;
    VkDeviceSize rowPitch;
    VkDeviceSize arrayPitch;
    VkDeviceSize depthPitch;
} VkSubresourceLayout;

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:

• VkSubresourceLayout

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkSubresourceLayout.Ptr	Represents a pointer to / an array of VkSubresourceLayout 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$arrayPitch
static final ValueLayout.OfLong	LAYOUT$depthPitch
static final ValueLayout.OfLong	LAYOUT$offset
static final ValueLayout.OfLong	LAYOUT$rowPitch
static final ValueLayout.OfLong	LAYOUT$size
static final long	OFFSET$arrayPitch
static final long	OFFSET$depthPitch
static final long	OFFSET$offset
static final long	OFFSET$rowPitch
static final long	OFFSET$size
static final MemoryLayout.PathElement	PATH$arrayPitch
static final MemoryLayout.PathElement	PATH$depthPitch
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$rowPitch
static final MemoryLayout.PathElement	PATH$size
static final long	SIZE$arrayPitch
static final long	SIZE$depthPitch
static final long	SIZE$offset
static final long	SIZE$rowPitch
static final long	SIZE$size

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkSubresourceLayout	allocate(Arena arena)
static VkSubresourceLayout.Ptr	allocate(Arena arena, long count)
long	arrayPitch()
VkSubresourceLayout	arrayPitch(long value)
static VkSubresourceLayout	clone(Arena arena, VkSubresourceLayout src)
long	depthPitch()
VkSubresourceLayout	depthPitch(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.
long	offset()
VkSubresourceLayout	offset(long value)
long	rowPitch()
VkSubresourceLayout	rowPitch(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
VkSubresourceLayout	size(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$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$rowPitch

public static final MemoryLayout.PathElement PATH$rowPitch

PATH$arrayPitch

public static final MemoryLayout.PathElement PATH$arrayPitch

PATH$depthPitch

public static final MemoryLayout.PathElement PATH$depthPitch

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

LAYOUT$rowPitch

public static final ValueLayout.OfLong LAYOUT$rowPitch

LAYOUT$arrayPitch

public static final ValueLayout.OfLong LAYOUT$arrayPitch

LAYOUT$depthPitch

public static final ValueLayout.OfLong LAYOUT$depthPitch

SIZE$offset

public static final long SIZE$offset

SIZE$size

public static final long SIZE$size

SIZE$rowPitch

public static final long SIZE$rowPitch

SIZE$arrayPitch

public static final long SIZE$arrayPitch

SIZE$depthPitch

public static final long SIZE$depthPitch

OFFSET$offset

public static final long OFFSET$offset

OFFSET$size

public static final long OFFSET$size

OFFSET$rowPitch

public static final long OFFSET$rowPitch

OFFSET$arrayPitch

public static final long OFFSET$arrayPitch

OFFSET$depthPitch

public static final long OFFSET$depthPitch

Constructor Details

VkSubresourceLayout

public VkSubresourceLayout(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkSubresourceLayout record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkSubresourceLayout allocate(Arena arena)

allocate

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

clone

public static VkSubresourceLayout clone(Arena arena,
 VkSubresourceLayout src)

offset

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

offset

public VkSubresourceLayout offset(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

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

size

public VkSubresourceLayout size(@NativeType("VkDeviceSize") @Unsigned
 long value)

rowPitch

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

rowPitch

public VkSubresourceLayout rowPitch(@NativeType("VkDeviceSize") @Unsigned
 long value)

arrayPitch

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

arrayPitch

public VkSubresourceLayout arrayPitch(@NativeType("VkDeviceSize") @Unsigned
 long value)

depthPitch

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

depthPitch

public VkSubresourceLayout depthPitch(@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