Record Class VkVertexInputAttributeDescription

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVertexInputAttributeDescription

All Implemented Interfaces:

IPointer, IVkVertexInputAttributeDescription

@ValueBasedCandidate
@UnsafeConstructor
public record VkVertexInputAttributeDescription(@NotNull MemorySegment segment)
extends Record
implements IVkVertexInputAttributeDescription

Represents a pointer to a VkVertexInputAttributeDescription structure in native memory.

Structure

typedef struct VkVertexInputAttributeDescription {
    uint32_t location;
    uint32_t binding;
    VkFormat format;
    uint32_t offset;
} VkVertexInputAttributeDescription;

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:

• VkVertexInputAttributeDescription

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$location

PATH$binding

public static final MemoryLayout.PathElement PATH$binding

PATH$format

public static final MemoryLayout.PathElement PATH$format

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

LAYOUT$location

public static final ValueLayout.OfInt LAYOUT$location

LAYOUT$binding

public static final ValueLayout.OfInt LAYOUT$binding

LAYOUT$format

public static final ValueLayout.OfInt LAYOUT$format

LAYOUT$offset

public static final ValueLayout.OfInt LAYOUT$offset

SIZE$location

public static final long SIZE$location

SIZE$binding

public static final long SIZE$binding

SIZE$format

public static final long SIZE$format

SIZE$offset

public static final long SIZE$offset

OFFSET$location

public static final long OFFSET$location

OFFSET$binding

public static final long OFFSET$binding

OFFSET$format

public static final long OFFSET$format

OFFSET$offset

public static final long OFFSET$offset

Constructor Details

VkVertexInputAttributeDescription

public VkVertexInputAttributeDescription(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVertexInputAttributeDescription record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVertexInputAttributeDescription allocate(Arena arena)

allocate

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

clone

public static VkVertexInputAttributeDescription clone(Arena arena,
 VkVertexInputAttributeDescription src)

location

@Unsigned
public int location()

location

public VkVertexInputAttributeDescription location(@Unsigned
 int value)

binding

@Unsigned
public int binding()

binding

public VkVertexInputAttributeDescription binding(@Unsigned
 int value)

format

@EnumType(VkFormat.class)
public int format()

format

public VkVertexInputAttributeDescription format(@EnumType(VkFormat.class)
 int value)

offset

@Unsigned
public int offset()

offset

public VkVertexInputAttributeDescription offset(@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