Record Class VkImageSubresource

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

Represents a pointer to a VkImageSubresource structure in native memory.

Structure

typedef struct VkImageSubresource {
    VkImageAspectFlags aspectMask;
    uint32_t mipLevel;
    uint32_t arrayLayer;
} VkImageSubresource;

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

      public static final MemoryLayout.PathElement PATH$aspectMask

    • PATH$mipLevel

      public static final MemoryLayout.PathElement PATH$mipLevel

    • PATH$arrayLayer

      public static final MemoryLayout.PathElement PATH$arrayLayer

    • LAYOUT$aspectMask

      public static final ValueLayout.OfInt LAYOUT$aspectMask

    • LAYOUT$mipLevel

      public static final ValueLayout.OfInt LAYOUT$mipLevel

    • LAYOUT$arrayLayer

      public static final ValueLayout.OfInt LAYOUT$arrayLayer

    • SIZE$aspectMask

      public static final long SIZE$aspectMask

    • SIZE$mipLevel

      public static final long SIZE$mipLevel

    • SIZE$arrayLayer

      public static final long SIZE$arrayLayer

    • OFFSET$aspectMask

      public static final long OFFSET$aspectMask

    • OFFSET$mipLevel

      public static final long OFFSET$mipLevel

    • OFFSET$arrayLayer

      public static final long OFFSET$arrayLayer

  • Constructor Details

    • VkImageSubresource

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

  • Method Details

    • allocate

      public static VkImageSubresource allocate(Arena arena)

    • allocate

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

    • clone

      public static VkImageSubresource clone(Arena arena, VkImageSubresource src)

    • aspectMask

      @Bitmask(VkImageAspectFlags.class) public int aspectMask()

    • aspectMask

      public VkImageSubresource aspectMask(@Bitmask(VkImageAspectFlags.class) int value)

    • mipLevel

      @Unsigned public int mipLevel()

    • mipLevel

      public VkImageSubresource mipLevel(@Unsigned int value)

    • arrayLayer

      @Unsigned public int arrayLayer()

    • arrayLayer

      public VkImageSubresource arrayLayer(@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