Record Class VkBufferCopy

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

Represents a pointer to a VkBufferCopy structure in native memory.

Structure

typedef struct VkBufferCopy {
    VkDeviceSize srcOffset;
    VkDeviceSize dstOffset;
    VkDeviceSize size;
} VkBufferCopy;

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

      public static final MemoryLayout.PathElement PATH$srcOffset

    • PATH$dstOffset

      public static final MemoryLayout.PathElement PATH$dstOffset

    • PATH$size

      public static final MemoryLayout.PathElement PATH$size

    • LAYOUT$srcOffset

      public static final ValueLayout.OfLong LAYOUT$srcOffset

    • LAYOUT$dstOffset

      public static final ValueLayout.OfLong LAYOUT$dstOffset

    • LAYOUT$size

      public static final ValueLayout.OfLong LAYOUT$size

    • SIZE$srcOffset

      public static final long SIZE$srcOffset

    • SIZE$dstOffset

      public static final long SIZE$dstOffset

    • SIZE$size

      public static final long SIZE$size

    • OFFSET$srcOffset

      public static final long OFFSET$srcOffset

    • OFFSET$dstOffset

      public static final long OFFSET$dstOffset

    • OFFSET$size

      public static final long OFFSET$size

  • Constructor Details

    • VkBufferCopy

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

  • Method Details

    • allocate

      public static VkBufferCopy allocate(Arena arena)

    • allocate

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

    • clone

      public static VkBufferCopy clone(Arena arena, VkBufferCopy src)

    • srcOffset

      @NativeType("VkDeviceSize") @Unsigned public long srcOffset()

    • srcOffset

      public VkBufferCopy srcOffset(@NativeType("VkDeviceSize") @Unsigned long value)

    • dstOffset

      @NativeType("VkDeviceSize") @Unsigned public long dstOffset()

    • dstOffset

      public VkBufferCopy dstOffset(@NativeType("VkDeviceSize") @Unsigned long value)

    • size

      @NativeType("VkDeviceSize") @Unsigned public long size()

    • size

      public VkBufferCopy size(@NativeType("VkDeviceSize") @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