Record Class VkDrawIndirectCommand

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

Represents a pointer to a VkDrawIndirectCommand structure in native memory.

Structure

typedef struct VkDrawIndirectCommand {
    uint32_t vertexCount;
    uint32_t instanceCount;
    uint32_t firstVertex;
    uint32_t firstInstance;
} VkDrawIndirectCommand;

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

      public static final MemoryLayout.PathElement PATH$vertexCount

    • PATH$instanceCount

      public static final MemoryLayout.PathElement PATH$instanceCount

    • PATH$firstVertex

      public static final MemoryLayout.PathElement PATH$firstVertex

    • PATH$firstInstance

      public static final MemoryLayout.PathElement PATH$firstInstance

    • LAYOUT$vertexCount

      public static final ValueLayout.OfInt LAYOUT$vertexCount

    • LAYOUT$instanceCount

      public static final ValueLayout.OfInt LAYOUT$instanceCount

    • LAYOUT$firstVertex

      public static final ValueLayout.OfInt LAYOUT$firstVertex

    • LAYOUT$firstInstance

      public static final ValueLayout.OfInt LAYOUT$firstInstance

    • SIZE$vertexCount

      public static final long SIZE$vertexCount

    • SIZE$instanceCount

      public static final long SIZE$instanceCount

    • SIZE$firstVertex

      public static final long SIZE$firstVertex

    • SIZE$firstInstance

      public static final long SIZE$firstInstance

    • OFFSET$vertexCount

      public static final long OFFSET$vertexCount

    • OFFSET$instanceCount

      public static final long OFFSET$instanceCount

    • OFFSET$firstVertex

      public static final long OFFSET$firstVertex

    • OFFSET$firstInstance

      public static final long OFFSET$firstInstance

  • Constructor Details

    • VkDrawIndirectCommand

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

  • Method Details

    • allocate

      public static VkDrawIndirectCommand allocate(Arena arena)

    • allocate

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

    • clone

      public static VkDrawIndirectCommand clone(Arena arena, VkDrawIndirectCommand src)

    • vertexCount

      @Unsigned public int vertexCount()

    • vertexCount

      public VkDrawIndirectCommand vertexCount(@Unsigned int value)

    • instanceCount

      @Unsigned public int instanceCount()

    • instanceCount

      public VkDrawIndirectCommand instanceCount(@Unsigned int value)

    • firstVertex

      @Unsigned public int firstVertex()

    • firstVertex

      public VkDrawIndirectCommand firstVertex(@Unsigned int value)

    • firstInstance

      @Unsigned public int firstInstance()

    • firstInstance

      public VkDrawIndirectCommand firstInstance(@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