Record Class VkClearValue

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

Represents a pointer to a VkClearValue structure in native memory.

Structure

typedef union VkClearValue {
    VkClearColorValue color;
    VkClearDepthStencilValue depthStencil;
} VkClearValue;

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 UnionLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$color

      public static final MemoryLayout.PathElement PATH$color

    • PATH$depthStencil

      public static final MemoryLayout.PathElement PATH$depthStencil

    • LAYOUT$color

      public static final UnionLayout LAYOUT$color

    • LAYOUT$depthStencil

      public static final StructLayout LAYOUT$depthStencil

    • SIZE$color

      public static final long SIZE$color

    • SIZE$depthStencil

      public static final long SIZE$depthStencil

    • OFFSET$color

      public static final long OFFSET$color

    • OFFSET$depthStencil

      public static final long OFFSET$depthStencil

  • Constructor Details

    • VkClearValue

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

  • Method Details

    • allocate

      public static VkClearValue allocate(Arena arena)

    • allocate

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

    • clone

      public static VkClearValue clone(Arena arena, VkClearValue src)

    • color

      @NotNull public @NotNull VkClearColorValue color()

    • color

      public VkClearValue color(@NotNull @NotNull VkClearColorValue value)

    • color

      public VkClearValue color(Consumer<@NotNull VkClearColorValue> consumer)

    • depthStencil

      @NotNull public @NotNull VkClearDepthStencilValue depthStencil()

    • depthStencil

      public VkClearValue depthStencil(@NotNull @NotNull VkClearDepthStencilValue value)

    • depthStencil

      public VkClearValue depthStencil(Consumer<@NotNull VkClearDepthStencilValue> 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