Record Class VkPipelineInfoKHR

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

Represents a pointer to a VkPipelineInfoKHR structure in native memory.

Structure

typedef struct VkPipelineInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkPipeline pipeline;
} VkPipelineInfoKHR;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_PIPELINE_INFO_KHR

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

      public static final MemoryLayout.PathElement PATH$pipeline

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$pipeline

      public static final AddressLayout LAYOUT$pipeline

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$pipeline

      public static final long SIZE$pipeline

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$pipeline

      public static final long OFFSET$pipeline

  • Constructor Details

    • VkPipelineInfoKHR

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

  • Method Details

    • allocate

      public static VkPipelineInfoKHR allocate(Arena arena)

    • allocate

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

    • clone

      public static VkPipelineInfoKHR clone(Arena arena, VkPipelineInfoKHR src)

    • autoInit

      public void autoInit()

    • sType

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

    • sType

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

    • pNext

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

    • pNext

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

    • pNext

      public VkPipelineInfoKHR pNext(@Nullable @Nullable IPointer pointer)

    • pipeline

      @Nullable public @Nullable VkPipeline pipeline()

    • pipeline

      public VkPipelineInfoKHR pipeline(@Nullable @Nullable VkPipeline 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