Record Class VkImageSubresourceRange

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageSubresourceRange

All Implemented Interfaces:

IPointer, IVkImageSubresourceRange

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageSubresourceRange(@NotNull MemorySegment segment)
extends Record
implements IVkImageSubresourceRange

Represents a pointer to a VkImageSubresourceRange structure in native memory.

Structure

typedef struct VkImageSubresourceRange {
    VkImageAspectFlags aspectMask;
    uint32_t baseMipLevel;
    uint32_t levelCount;
    uint32_t baseArrayLayer;
    uint32_t layerCount;
} VkImageSubresourceRange;

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:

• VkImageSubresourceRange

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkImageSubresourceRange.Ptr	Represents a pointer to / an array of VkImageSubresourceRange 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$aspectMask
static final ValueLayout.OfInt	LAYOUT$baseArrayLayer
static final ValueLayout.OfInt	LAYOUT$baseMipLevel
static final ValueLayout.OfInt	LAYOUT$layerCount
static final ValueLayout.OfInt	LAYOUT$levelCount
static final long	OFFSET$aspectMask
static final long	OFFSET$baseArrayLayer
static final long	OFFSET$baseMipLevel
static final long	OFFSET$layerCount
static final long	OFFSET$levelCount
static final MemoryLayout.PathElement	PATH$aspectMask
static final MemoryLayout.PathElement	PATH$baseArrayLayer
static final MemoryLayout.PathElement	PATH$baseMipLevel
static final MemoryLayout.PathElement	PATH$layerCount
static final MemoryLayout.PathElement	PATH$levelCount
static final long	SIZE$aspectMask
static final long	SIZE$baseArrayLayer
static final long	SIZE$baseMipLevel
static final long	SIZE$layerCount
static final long	SIZE$levelCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageSubresourceRange	allocate(Arena arena)
static VkImageSubresourceRange.Ptr	allocate(Arena arena, long count)
int	aspectMask()
VkImageSubresourceRange	aspectMask(int value)
int	baseArrayLayer()
VkImageSubresourceRange	baseArrayLayer(int value)
int	baseMipLevel()
VkImageSubresourceRange	baseMipLevel(int value)
static VkImageSubresourceRange	clone(Arena arena, VkImageSubresourceRange 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	layerCount()
VkImageSubresourceRange	layerCount(int value)
int	levelCount()
VkImageSubresourceRange	levelCount(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$aspectMask

public static final MemoryLayout.PathElement PATH$aspectMask

PATH$baseMipLevel

public static final MemoryLayout.PathElement PATH$baseMipLevel

PATH$levelCount

public static final MemoryLayout.PathElement PATH$levelCount

PATH$baseArrayLayer

public static final MemoryLayout.PathElement PATH$baseArrayLayer

PATH$layerCount

public static final MemoryLayout.PathElement PATH$layerCount

LAYOUT$aspectMask

public static final ValueLayout.OfInt LAYOUT$aspectMask

LAYOUT$baseMipLevel

public static final ValueLayout.OfInt LAYOUT$baseMipLevel

LAYOUT$levelCount

public static final ValueLayout.OfInt LAYOUT$levelCount

LAYOUT$baseArrayLayer

public static final ValueLayout.OfInt LAYOUT$baseArrayLayer

LAYOUT$layerCount

public static final ValueLayout.OfInt LAYOUT$layerCount

SIZE$aspectMask

public static final long SIZE$aspectMask

SIZE$baseMipLevel

public static final long SIZE$baseMipLevel

SIZE$levelCount

public static final long SIZE$levelCount

SIZE$baseArrayLayer

public static final long SIZE$baseArrayLayer

SIZE$layerCount

public static final long SIZE$layerCount

OFFSET$aspectMask

public static final long OFFSET$aspectMask

OFFSET$baseMipLevel

public static final long OFFSET$baseMipLevel

OFFSET$levelCount

public static final long OFFSET$levelCount

OFFSET$baseArrayLayer

public static final long OFFSET$baseArrayLayer

OFFSET$layerCount

public static final long OFFSET$layerCount

Constructor Details

VkImageSubresourceRange

public VkImageSubresourceRange(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageSubresourceRange record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageSubresourceRange allocate(Arena arena)

allocate

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

clone

public static VkImageSubresourceRange clone(Arena arena,
 VkImageSubresourceRange src)

aspectMask

@Bitmask(VkImageAspectFlags.class)
public int aspectMask()

aspectMask

public VkImageSubresourceRange aspectMask(@Bitmask(VkImageAspectFlags.class)
 int value)

baseMipLevel

@Unsigned
public int baseMipLevel()

baseMipLevel

public VkImageSubresourceRange baseMipLevel(@Unsigned
 int value)

levelCount

@Unsigned
public int levelCount()

levelCount

public VkImageSubresourceRange levelCount(@Unsigned
 int value)

baseArrayLayer

@Unsigned
public int baseArrayLayer()

baseArrayLayer

public VkImageSubresourceRange baseArrayLayer(@Unsigned
 int value)

layerCount

@Unsigned
public int layerCount()

layerCount

public VkImageSubresourceRange layerCount(@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