Record Class Mapping.Struct

java.lang.Object
java.lang.Record
org.lwjgl.system.ffm.mapping.Mapping.Struct
All Implemented Interfaces:
DataMapping<StructLayout>, GroupMapping<StructLayout>, Mapping<StructLayout>
Enclosing interface:
Mapping<L extends MemoryLayout>
public static record Mapping.Struct(StructLayout layout) extends Record implements GroupMapping<StructLayout>
Mapping from StructLayout to a C struct.

Using a StructBinder directly is usually preferred over this mapping.

  • Constructor Details

    • Struct

      public Struct(StructLayout layout)
      Creates an instance of a Struct record class.
      Parameters:
      layout - the value for the layout record component

    • Struct

      public Struct(String name, StructLayout layout)

  • Method Details

    • withByteAlignment

      public Mapping.Struct 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<StructLayout>
      Specified by:
      withByteAlignment in interface GroupMapping<StructLayout>
      Parameters:
      byteAlignment - the new byte alignment
      Returns:
      the new mapping

    • typedef

      public Mapping.Struct 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 GroupMapping<StructLayout>
      Specified by:
      typedef in interface Mapping<StructLayout>
      Returns:
      the new mapping

    • cconst

      public Mapping.Struct cconst()
      Description copied from interface: Mapping
      Creates a new instance of this mapping with the C const qualifier
      Specified by:
      cconst in interface Mapping<StructLayout>
      Returns:
      the new mapping

    • 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 StructLayout layout()
      Returns the value of the layout record component.
      Specified by:
      layout in interface Mapping<StructLayout>
      Returns:
      the value of the layout record component