Record Class VkVertexInputBindingDivisorDescription

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVertexInputBindingDivisorDescription

All Implemented Interfaces:

IPointer, IVkVertexInputBindingDivisorDescription

@ValueBasedCandidate
@UnsafeConstructor
public record VkVertexInputBindingDivisorDescription(@NotNull MemorySegment segment)
extends Record
implements IVkVertexInputBindingDivisorDescription

Represents a pointer to a VkVertexInputBindingDivisorDescription structure in native memory.

Structure

typedef struct VkVertexInputBindingDivisorDescription {
    uint32_t binding;
    uint32_t divisor;
} VkVertexInputBindingDivisorDescription;

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:

• VkVertexInputBindingDivisorDescription

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVertexInputBindingDivisorDescription	allocate(Arena arena)
static VkVertexInputBindingDivisorDescription.Ptr	allocate(Arena arena, long count)
int	binding()
VkVertexInputBindingDivisorDescription	binding(int value)
static VkVertexInputBindingDivisorDescription	clone(Arena arena, VkVertexInputBindingDivisorDescription src)
int	divisor()
VkVertexInputBindingDivisorDescription	divisor(int value)
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.
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$divisor

public static final MemoryLayout.PathElement PATH$divisor

LAYOUT$binding

public static final ValueLayout.OfInt LAYOUT$binding

LAYOUT$divisor

public static final ValueLayout.OfInt LAYOUT$divisor

SIZE$binding

public static final long SIZE$binding

SIZE$divisor

public static final long SIZE$divisor

OFFSET$binding

public static final long OFFSET$binding

OFFSET$divisor

public static final long OFFSET$divisor

Constructor Details

VkVertexInputBindingDivisorDescription

public VkVertexInputBindingDivisorDescription(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVertexInputBindingDivisorDescription record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVertexInputBindingDivisorDescription allocate(Arena arena)

allocate

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

clone

public static VkVertexInputBindingDivisorDescription clone(Arena arena,
 VkVertexInputBindingDivisorDescription src)

binding

@Unsigned
public int binding()

binding

public VkVertexInputBindingDivisorDescription binding(@Unsigned
 int value)

divisor

@Unsigned
public int divisor()

divisor

public VkVertexInputBindingDivisorDescription divisor(@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