Record Class VkQueueFamilyProperties

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

Represents a pointer to a VkQueueFamilyProperties structure in native memory.

Structure

typedef struct VkQueueFamilyProperties {
    VkQueueFlags queueFlags; // optional
    uint32_t queueCount;
    uint32_t timestampValidBits;
    VkExtent3D minImageTransferGranularity;
} VkQueueFamilyProperties;

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

      public static final MemoryLayout.PathElement PATH$queueFlags

    • PATH$queueCount

      public static final MemoryLayout.PathElement PATH$queueCount

    • PATH$timestampValidBits

      public static final MemoryLayout.PathElement PATH$timestampValidBits

    • PATH$minImageTransferGranularity

      public static final MemoryLayout.PathElement PATH$minImageTransferGranularity

    • LAYOUT$queueFlags

      public static final ValueLayout.OfInt LAYOUT$queueFlags

    • LAYOUT$queueCount

      public static final ValueLayout.OfInt LAYOUT$queueCount

    • LAYOUT$timestampValidBits

      public static final ValueLayout.OfInt LAYOUT$timestampValidBits

    • LAYOUT$minImageTransferGranularity

      public static final StructLayout LAYOUT$minImageTransferGranularity

    • SIZE$queueFlags

      public static final long SIZE$queueFlags

    • SIZE$queueCount

      public static final long SIZE$queueCount

    • SIZE$timestampValidBits

      public static final long SIZE$timestampValidBits

    • SIZE$minImageTransferGranularity

      public static final long SIZE$minImageTransferGranularity

    • OFFSET$queueFlags

      public static final long OFFSET$queueFlags

    • OFFSET$queueCount

      public static final long OFFSET$queueCount

    • OFFSET$timestampValidBits

      public static final long OFFSET$timestampValidBits

    • OFFSET$minImageTransferGranularity

      public static final long OFFSET$minImageTransferGranularity

  • Constructor Details

    • VkQueueFamilyProperties

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

  • Method Details

    • allocate

      public static VkQueueFamilyProperties allocate(Arena arena)

    • allocate

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

    • clone

      public static VkQueueFamilyProperties clone(Arena arena, VkQueueFamilyProperties src)

    • queueFlags

      @EnumType(VkQueueFlags.class) public int queueFlags()

    • queueFlags

      public VkQueueFamilyProperties queueFlags(@EnumType(VkQueueFlags.class) int value)

    • queueCount

      @Unsigned public int queueCount()

    • queueCount

      public VkQueueFamilyProperties queueCount(@Unsigned int value)

    • timestampValidBits

      @Unsigned public int timestampValidBits()

    • timestampValidBits

      public VkQueueFamilyProperties timestampValidBits(@Unsigned int value)

    • minImageTransferGranularity

      @NotNull public @NotNull VkExtent3D minImageTransferGranularity()

    • minImageTransferGranularity

      public VkQueueFamilyProperties minImageTransferGranularity(@NotNull @NotNull VkExtent3D value)

    • minImageTransferGranularity

      public VkQueueFamilyProperties minImageTransferGranularity(Consumer<@NotNull VkExtent3D> 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