Record Class VkExternalFormatQNX

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

Represents a pointer to a VkExternalFormatQNX structure in native memory.

Structure

typedef struct VkExternalFormatQNX {
    VkStructureType sType;
    void* pNext; // optional
    uint64_t externalFormat;
} VkExternalFormatQNX;

Auto initialization

This structure has the following members that can be automatically initialized:

  • sType = VK_STRUCTURE_TYPE_EXTERNAL_FORMAT_QNX

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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$sType

      public static final MemoryLayout.PathElement PATH$sType

    • PATH$pNext

      public static final MemoryLayout.PathElement PATH$pNext

    • PATH$externalFormat

      public static final MemoryLayout.PathElement PATH$externalFormat

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$externalFormat

      public static final ValueLayout.OfLong LAYOUT$externalFormat

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$externalFormat

      public static final long SIZE$externalFormat

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$externalFormat

      public static final long OFFSET$externalFormat

  • Constructor Details

    • VkExternalFormatQNX

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

  • Method Details

    • allocate

      public static VkExternalFormatQNX allocate(Arena arena)

    • allocate

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

    • clone

      public static VkExternalFormatQNX clone(Arena arena, VkExternalFormatQNX src)

    • autoInit

      public void autoInit()

    • sType

      @EnumType(VkStructureType.class) public int sType()

    • sType

      public VkExternalFormatQNX sType(@EnumType(VkStructureType.class) int value)

    • pNext

      @Pointer(comment="void*") public MemorySegment pNext()

    • pNext

      public void pNext(@Pointer(comment="void*") MemorySegment value)

    • pNext

      public VkExternalFormatQNX pNext(@Nullable @Nullable IPointer pointer)

    • externalFormat

      @Unsigned public long externalFormat()

    • externalFormat

      public VkExternalFormatQNX externalFormat(@Unsigned long 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