Record Class VkVertexInputBindingDescription

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVertexInputBindingDescription

All Implemented Interfaces:

IPointer, IVkVertexInputBindingDescription

@ValueBasedCandidate
@UnsafeConstructor
public record VkVertexInputBindingDescription(@NotNull MemorySegment segment)
extends Record
implements IVkVertexInputBindingDescription

Represents a pointer to a VkVertexInputBindingDescription structure in native memory.

Structure

typedef struct VkVertexInputBindingDescription {
    uint32_t binding;
    uint32_t stride;
    VkVertexInputRate inputRate;
} VkVertexInputBindingDescription;

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:

• VkVertexInputBindingDescription

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVertexInputBindingDescription	allocate(Arena arena)
static VkVertexInputBindingDescription.Ptr	allocate(Arena arena, long count)
int	binding()
VkVertexInputBindingDescription	binding(int value)
static VkVertexInputBindingDescription	clone(Arena arena, VkVertexInputBindingDescription 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	inputRate()
VkVertexInputBindingDescription	inputRate(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	stride()
VkVertexInputBindingDescription	stride(int 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$binding

public static final MemoryLayout.PathElement PATH$binding

PATH$stride

public static final MemoryLayout.PathElement PATH$stride

PATH$inputRate

public static final MemoryLayout.PathElement PATH$inputRate

LAYOUT$binding

public static final ValueLayout.OfInt LAYOUT$binding

LAYOUT$stride

public static final ValueLayout.OfInt LAYOUT$stride

LAYOUT$inputRate

public static final ValueLayout.OfInt LAYOUT$inputRate

SIZE$binding

public static final long SIZE$binding

SIZE$stride

public static final long SIZE$stride

SIZE$inputRate

public static final long SIZE$inputRate

OFFSET$binding

public static final long OFFSET$binding

OFFSET$stride

public static final long OFFSET$stride

OFFSET$inputRate

public static final long OFFSET$inputRate

Constructor Details

VkVertexInputBindingDescription

public VkVertexInputBindingDescription(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVertexInputBindingDescription record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVertexInputBindingDescription allocate(Arena arena)

allocate

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

clone

public static VkVertexInputBindingDescription clone(Arena arena,
 VkVertexInputBindingDescription src)

binding

@Unsigned
public int binding()

binding

public VkVertexInputBindingDescription binding(@Unsigned
 int value)

stride

@Unsigned
public int stride()

stride

public VkVertexInputBindingDescription stride(@Unsigned
 int value)

inputRate

@EnumType(VkVertexInputRate.class)
public int inputRate()

inputRate

public VkVertexInputBindingDescription inputRate(@EnumType(VkVertexInputRate.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