Record Class XrFrustumf

java.lang.Object
java.lang.Record
club.doki7.openxr.datatype.XrFrustumf
All Implemented Interfaces:
IPointer, IXrFrustumf
@ValueBasedCandidate @UnsafeConstructor public record XrFrustumf(@NotNull MemorySegment segment) extends Record implements IXrFrustumf

Represents a pointer to a XrFrustumf structure in native memory.

Structure

typedef struct XrFrustumf {
    XrPosef pose;
    XrFovf fov;
    float nearZ;
    float farZ;
} XrFrustumf;

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:

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$pose

      public static final MemoryLayout.PathElement PATH$pose

    • PATH$fov

      public static final MemoryLayout.PathElement PATH$fov

    • PATH$nearZ

      public static final MemoryLayout.PathElement PATH$nearZ

    • PATH$farZ

      public static final MemoryLayout.PathElement PATH$farZ

    • LAYOUT$pose

      public static final StructLayout LAYOUT$pose

    • LAYOUT$fov

      public static final StructLayout LAYOUT$fov

    • LAYOUT$nearZ

      public static final ValueLayout.OfFloat LAYOUT$nearZ

    • LAYOUT$farZ

      public static final ValueLayout.OfFloat LAYOUT$farZ

    • SIZE$pose

      public static final long SIZE$pose

    • SIZE$fov

      public static final long SIZE$fov

    • SIZE$nearZ

      public static final long SIZE$nearZ

    • SIZE$farZ

      public static final long SIZE$farZ

    • OFFSET$pose

      public static final long OFFSET$pose

    • OFFSET$fov

      public static final long OFFSET$fov

    • OFFSET$nearZ

      public static final long OFFSET$nearZ

    • OFFSET$farZ

      public static final long OFFSET$farZ

  • Constructor Details

    • XrFrustumf

      public XrFrustumf(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a XrFrustumf record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static XrFrustumf allocate(Arena arena)

    • allocate

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

    • clone

      public static XrFrustumf clone(Arena arena, XrFrustumf src)

    • pose

      @NotNull public @NotNull XrPosef pose()

    • pose

      public XrFrustumf pose(@NotNull @NotNull XrPosef value)

    • pose

      public XrFrustumf pose(Consumer<@NotNull XrPosef> consumer)

    • fov

      @NotNull public @NotNull XrFovf fov()

    • fov

      public XrFrustumf fov(@NotNull @NotNull XrFovf value)

    • fov

      public XrFrustumf fov(Consumer<@NotNull XrFovf> consumer)

    • nearZ

      public float nearZ()

    • nearZ

      public XrFrustumf nearZ(float value)

    • farZ

      public float farZ()

    • farZ

      public XrFrustumf farZ(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.

    • 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