Record Class VkImageBlit

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageBlit

All Implemented Interfaces:

IPointer, IVkImageBlit

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageBlit(@NotNull MemorySegment segment)
extends Record
implements IVkImageBlit

Represents a pointer to a VkImageBlit structure in native memory.

Structure

typedef struct VkImageBlit {
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D[2] srcOffsets;
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D[2] dstOffsets;
} VkImageBlit;

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:

• VkImageBlit

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkImageBlit.Ptr	Represents a pointer to / an array of VkImageBlit structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final SequenceLayout	LAYOUT$dstOffsets
static final StructLayout	LAYOUT$dstSubresource
static final SequenceLayout	LAYOUT$srcOffsets
static final StructLayout	LAYOUT$srcSubresource
static final long	OFFSET$dstOffsets
static final long	OFFSET$dstSubresource
static final long	OFFSET$srcOffsets
static final long	OFFSET$srcSubresource
static final MemoryLayout.PathElement	PATH$dstOffsets
static final MemoryLayout.PathElement	PATH$dstSubresource
static final MemoryLayout.PathElement	PATH$srcOffsets
static final MemoryLayout.PathElement	PATH$srcSubresource
static final long	SIZE$dstOffsets
static final long	SIZE$dstSubresource
static final long	SIZE$srcOffsets
static final long	SIZE$srcSubresource

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageBlit	allocate(Arena arena)
static VkImageBlit.Ptr	allocate(Arena arena, long count)
static VkImageBlit	clone(Arena arena, VkImageBlit src)
VkOffset3D.Ptr	dstOffsets()
VkImageBlit	dstOffsets(VkOffset3D.Ptr value)
VkImageBlit	dstOffsets(@NotNull Consumer<VkOffset3D.Ptr> consumer)
VkOffset3D	dstOffsetsAt(int index)
void	dstOffsetsAt(int index, VkOffset3D value)
@NotNull MemorySegment	dstOffsetsRaw()
@NotNull VkImageSubresourceLayers	dstSubresource()
VkImageBlit	dstSubresource(@NotNull VkImageSubresourceLayers value)
VkImageBlit	dstSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)
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.
VkOffset3D.Ptr	srcOffsets()
VkImageBlit	srcOffsets(VkOffset3D.Ptr value)
VkImageBlit	srcOffsets(@NotNull Consumer<VkOffset3D.Ptr> consumer)
VkOffset3D	srcOffsetsAt(int index)
void	srcOffsetsAt(int index, VkOffset3D value)
@NotNull MemorySegment	srcOffsetsRaw()
@NotNull VkImageSubresourceLayers	srcSubresource()
VkImageBlit	srcSubresource(@NotNull VkImageSubresourceLayers value)
VkImageBlit	srcSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)
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$srcSubresource

public static final MemoryLayout.PathElement PATH$srcSubresource

PATH$srcOffsets

public static final MemoryLayout.PathElement PATH$srcOffsets

PATH$dstSubresource

public static final MemoryLayout.PathElement PATH$dstSubresource

PATH$dstOffsets

public static final MemoryLayout.PathElement PATH$dstOffsets

LAYOUT$srcSubresource

public static final StructLayout LAYOUT$srcSubresource

LAYOUT$srcOffsets

public static final SequenceLayout LAYOUT$srcOffsets

LAYOUT$dstSubresource

public static final StructLayout LAYOUT$dstSubresource

LAYOUT$dstOffsets

public static final SequenceLayout LAYOUT$dstOffsets

SIZE$srcSubresource

public static final long SIZE$srcSubresource

SIZE$srcOffsets

public static final long SIZE$srcOffsets

SIZE$dstSubresource

public static final long SIZE$dstSubresource

SIZE$dstOffsets

public static final long SIZE$dstOffsets

OFFSET$srcSubresource

public static final long OFFSET$srcSubresource

OFFSET$srcOffsets

public static final long OFFSET$srcOffsets

OFFSET$dstSubresource

public static final long OFFSET$dstSubresource

OFFSET$dstOffsets

public static final long OFFSET$dstOffsets

Constructor Details

VkImageBlit

public VkImageBlit(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageBlit record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageBlit allocate(Arena arena)

allocate

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

clone

public static VkImageBlit clone(Arena arena,
 VkImageBlit src)

srcSubresource

@NotNull
public @NotNull VkImageSubresourceLayers srcSubresource()

srcSubresource

public VkImageBlit srcSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

srcSubresource

public VkImageBlit srcSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)

srcOffsets

public VkOffset3D.Ptr srcOffsets()

srcOffsets

public VkImageBlit srcOffsets(@NotNull
 @NotNull Consumer<VkOffset3D.Ptr> consumer)

srcOffsets

public VkImageBlit srcOffsets(VkOffset3D.Ptr value)

srcOffsetsAt

public VkOffset3D srcOffsetsAt(int index)

srcOffsetsAt

public void srcOffsetsAt(int index,
 VkOffset3D value)

srcOffsetsRaw

@NotNull
public @NotNull MemorySegment srcOffsetsRaw()

dstSubresource

@NotNull
public @NotNull VkImageSubresourceLayers dstSubresource()

dstSubresource

public VkImageBlit dstSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

dstSubresource

public VkImageBlit dstSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)

dstOffsets

public VkOffset3D.Ptr dstOffsets()

dstOffsets

public VkImageBlit dstOffsets(@NotNull
 @NotNull Consumer<VkOffset3D.Ptr> consumer)

dstOffsets

public VkImageBlit dstOffsets(VkOffset3D.Ptr value)

dstOffsetsAt

public VkOffset3D dstOffsetsAt(int index)

dstOffsetsAt

public void dstOffsetsAt(int index,
 VkOffset3D value)

dstOffsetsRaw

@NotNull
public @NotNull MemorySegment dstOffsetsRaw()

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