Record Class VkComponentMapping

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkComponentMapping

All Implemented Interfaces:

IPointer, IVkComponentMapping

@ValueBasedCandidate
@UnsafeConstructor
public record VkComponentMapping(@NotNull MemorySegment segment)
extends Record
implements IVkComponentMapping

Represents a pointer to a VkComponentMapping structure in native memory.

Structure

typedef struct VkComponentMapping {
    VkComponentSwizzle r;
    VkComponentSwizzle g;
    VkComponentSwizzle b;
    VkComponentSwizzle a;
} VkComponentMapping;

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:

• VkComponentMapping

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkComponentMapping.Ptr	Represents a pointer to / an array of VkComponentMapping 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$a
static final ValueLayout.OfInt	LAYOUT$b
static final ValueLayout.OfInt	LAYOUT$g
static final ValueLayout.OfInt	LAYOUT$r
static final long	OFFSET$a
static final long	OFFSET$b
static final long	OFFSET$g
static final long	OFFSET$r
static final MemoryLayout.PathElement	PATH$a
static final MemoryLayout.PathElement	PATH$b
static final MemoryLayout.PathElement	PATH$g
static final MemoryLayout.PathElement	PATH$r
static final long	SIZE$a
static final long	SIZE$b
static final long	SIZE$g
static final long	SIZE$r

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	a()
VkComponentMapping	a(int value)
static VkComponentMapping	allocate(Arena arena)
static VkComponentMapping.Ptr	allocate(Arena arena, long count)
int	b()
VkComponentMapping	b(int value)
static VkComponentMapping	clone(Arena arena, VkComponentMapping src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	g()
VkComponentMapping	g(int value)
final int	hashCode()	Returns a hash code value for this object.
int	r()
VkComponentMapping	r(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$r

public static final MemoryLayout.PathElement PATH$r

PATH$g

public static final MemoryLayout.PathElement PATH$g

PATH$b

public static final MemoryLayout.PathElement PATH$b

PATH$a

public static final MemoryLayout.PathElement PATH$a

LAYOUT$r

public static final ValueLayout.OfInt LAYOUT$r

LAYOUT$g

public static final ValueLayout.OfInt LAYOUT$g

LAYOUT$b

public static final ValueLayout.OfInt LAYOUT$b

LAYOUT$a

public static final ValueLayout.OfInt LAYOUT$a

SIZE$r

public static final long SIZE$r

SIZE$g

public static final long SIZE$g

SIZE$b

public static final long SIZE$b

SIZE$a

public static final long SIZE$a

OFFSET$r

public static final long OFFSET$r

OFFSET$g

public static final long OFFSET$g

OFFSET$b

public static final long OFFSET$b

OFFSET$a

public static final long OFFSET$a

Constructor Details

VkComponentMapping

public VkComponentMapping(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkComponentMapping record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkComponentMapping allocate(Arena arena)

allocate

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

clone

public static VkComponentMapping clone(Arena arena,
 VkComponentMapping src)

r

@EnumType(VkComponentSwizzle.class)
public int r()

r

public VkComponentMapping r(@EnumType(VkComponentSwizzle.class)
 int value)

g

@EnumType(VkComponentSwizzle.class)
public int g()

g

public VkComponentMapping g(@EnumType(VkComponentSwizzle.class)
 int value)

b

@EnumType(VkComponentSwizzle.class)
public int b()

b

public VkComponentMapping b(@EnumType(VkComponentSwizzle.class)
 int value)

a

@EnumType(VkComponentSwizzle.class)
public int a()

a

public VkComponentMapping a(@EnumType(VkComponentSwizzle.class)
 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