Record Class VkClearAttachment

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

Represents a pointer to a VkClearAttachment structure in native memory.

Structure

typedef struct VkClearAttachment {
    VkImageAspectFlags aspectMask;
    uint32_t colorAttachment;
    VkClearValue clearValue;
} VkClearAttachment;

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

      public static final MemoryLayout.PathElement PATH$colorAttachment

    • PATH$clearValue

      public static final MemoryLayout.PathElement PATH$clearValue

    • LAYOUT$aspectMask

      public static final ValueLayout.OfInt LAYOUT$aspectMask

    • LAYOUT$colorAttachment

      public static final ValueLayout.OfInt LAYOUT$colorAttachment

    • LAYOUT$clearValue

      public static final UnionLayout LAYOUT$clearValue

    • SIZE$aspectMask

      public static final long SIZE$aspectMask

    • SIZE$colorAttachment

      public static final long SIZE$colorAttachment

    • SIZE$clearValue

      public static final long SIZE$clearValue

    • OFFSET$aspectMask

      public static final long OFFSET$aspectMask

    • OFFSET$colorAttachment

      public static final long OFFSET$colorAttachment

    • OFFSET$clearValue

      public static final long OFFSET$clearValue

  • Constructor Details

    • VkClearAttachment

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

  • Method Details

    • allocate

      public static VkClearAttachment allocate(Arena arena)

    • allocate

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

    • clone

      public static VkClearAttachment clone(Arena arena, VkClearAttachment src)

    • aspectMask

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

    • aspectMask

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

    • colorAttachment

      @Unsigned public int colorAttachment()

    • colorAttachment

      public VkClearAttachment colorAttachment(@Unsigned int value)

    • clearValue

      @NotNull public @NotNull VkClearValue clearValue()

    • clearValue

      public VkClearAttachment clearValue(@NotNull @NotNull VkClearValue value)

    • clearValue

      public VkClearAttachment clearValue(Consumer<@NotNull VkClearValue> consumer)

    • 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