Record Class Mapping.Float

java.lang.Object

java.lang.Record

org.lwjgl.system.ffm.mapping.Mapping.Float

All Implemented Interfaces:

DataMapping<ValueLayout.OfFloat>, Mapping<ValueLayout.OfFloat>, PrimitiveMapping<ValueLayout.OfFloat>

Enclosing interface:

Mapping<L extends MemoryLayout>

public static record Mapping.Float(ValueLayout.OfFloat layout, Mapping.Pointer p)
extends Record
implements PrimitiveMapping<ValueLayout.OfFloat>

Mapping from ValueLayout.JAVA_FLOAT to C float.

Nested Class Summary

Nested classes/interfaces inherited from interface Mapping

Mapping.Boolean, Mapping.Byte, Mapping.Char, Mapping.CLong, Mapping.Double, Mapping.Float, Mapping.Int, Mapping.Long, Mapping.Opaque, Mapping.Pointer, Mapping.Sequence, Mapping.Short, Mapping.Size, Mapping.Struct, Mapping.Union

Constructor Summary

Constructors

Constructor	Description
Float(ValueLayout.OfFloat layout, Mapping.Pointer p)	Creates an instance of a Float record class.

Method Summary

Modifier and Type	Method	Description
Mapping.Float	cconst()	Creates a new instance of this mapping with the C const qualifier
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
float	get(MemorySegment segment, long offset)
float	getAligned(MemorySegment segment, long offset)
float	getAtIndex(MemorySegment segment, long index)
float	getAtIndexAligned(MemorySegment segment, long index)
final int	hashCode()	Returns a hash code value for this object.
ValueLayout.OfFloat	layout()	Returns the value of the layout record component.
Mapping.Pointer	p()	Returns the value of the p record component.
Mapping.Float	set(MemorySegment segment, long offset, float value)
Mapping.Float	setAligned(MemorySegment segment, long offset, float value)
Mapping.Float	setAtIndex(MemorySegment segment, long index, float value)
Mapping.Float	setAtIndexAligned(MemorySegment segment, long index, float value)
final String	toString()	Returns a string representation of this record class.
Mapping.Float	typedef(String name)	Creates a new instance of this mapping with the specified type name.
Mapping.Float	withByteAlignment(long byteAlignment)	Returns a copy of this mapping with the specified byte alignment.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DataMapping

allocateSegment, allocateSegment, allocateSegment, allocateSegment, array, mallocSegment, mallocSegment

Constructor Details

Float

public Float(ValueLayout.OfFloat layout,
 Mapping.Pointer p)

Creates an instance of a Float record class.

Parameters:

layout - the value for the layout record component

p - the value for the p record component

Method Details

withByteAlignment

public Mapping.Float withByteAlignment(long byteAlignment)

Description copied from interface: DataMapping

Returns a copy of this mapping with the specified byte alignment.

Specified by:

withByteAlignment in interface DataMapping<ValueLayout.OfFloat>

Specified by:

withByteAlignment in interface PrimitiveMapping<ValueLayout.OfFloat>

Parameters:

byteAlignment - the new byte alignment

Returns:

the new mapping

typedef

public Mapping.Float typedef(String name)

Description copied from interface: Mapping

Creates a new instance of this mapping with the specified type name.

Specified by:

typedef in interface Mapping<ValueLayout.OfFloat>

Specified by:

typedef in interface PrimitiveMapping<ValueLayout.OfFloat>

Returns:

the new mapping

cconst

public Mapping.Float cconst()

Description copied from interface: Mapping

Creates a new instance of this mapping with the C const qualifier

Specified by:

cconst in interface Mapping<ValueLayout.OfFloat>

Returns:

the new mapping

get

public float get(MemorySegment segment,
 long offset)

getAligned

public float getAligned(MemorySegment segment,
 long offset)

getAtIndex

public float getAtIndex(MemorySegment segment,
 long index)

getAtIndexAligned

public float getAtIndexAligned(MemorySegment segment,
 long index)

set

public Mapping.Float set(MemorySegment segment,
 long offset,
 float value)

setAligned

public Mapping.Float setAligned(MemorySegment segment,
 long offset,
 float value)

setAtIndex

public Mapping.Float setAtIndex(MemorySegment segment,
 long index,
 float value)

setAtIndexAligned

public Mapping.Float setAtIndexAligned(MemorySegment segment,
 long index,
 float 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.

layout

public ValueLayout.OfFloat layout()

Returns the value of the layout record component.

Specified by:

layout in interface Mapping<ValueLayout.OfFloat>

Returns:

the value of the layout record component

p

public Mapping.Pointer p()

Returns the value of the p record component.

Specified by:

p in interface Mapping<ValueLayout.OfFloat>

Returns:

the value of the p record component