Contents
Record Class VkSparseImageFormatProperties
java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkSparseImageFormatProperties
- All Implemented Interfaces:
IPointer
,IVkSparseImageFormatProperties
@ValueBasedCandidate
@UnsafeConstructor
public record VkSparseImageFormatProperties(@NotNull MemorySegment segment)
extends Record
implements IVkSparseImageFormatProperties
Represents a pointer to a VkSparseImageFormatProperties
structure in native memory.
Structure 
typedef struct VkSparseImageFormatProperties {
VkImageAspectFlags
aspectMask
; // optional
VkExtent3D
imageGranularity
;
VkSparseImageFormatFlags
flags
; // optional
} VkSparseImageFormatProperties;
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final record
Represents a pointer to / an array ofVkSparseImageFormatProperties
structure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final long
static final StructLayout
static final ValueLayout.OfInt
static final ValueLayout.OfInt
static final StructLayout
static final long
static final long
static final long
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final long
static final long
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionVkSparseImageFormatProperties
(@NotNull MemorySegment segment) Creates an instance of aVkSparseImageFormatProperties
record class. -
Method Summary
Modifier and TypeMethodDescriptionint
aspectMask
(int value) clone
(Arena arena, VkSparseImageFormatProperties src) final boolean
Indicates whether some other object is "equal to" this one.int
flags()
flags
(int value) final int
hashCode()
Returns a hash code value for this object.@NotNull VkExtent3D
imageGranularity
(@NotNull VkExtent3D value) imageGranularity
(Consumer<@NotNull VkExtent3D> consumer) @NotNull MemorySegment
segment()
Returns the value of thesegment
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$aspectMask
-
PATH$imageGranularity
-
PATH$flags
-
LAYOUT$aspectMask
-
LAYOUT$imageGranularity
-
LAYOUT$flags
-
SIZE$aspectMask
public static final long SIZE$aspectMask -
SIZE$imageGranularity
public static final long SIZE$imageGranularity -
SIZE$flags
public static final long SIZE$flags -
OFFSET$aspectMask
public static final long OFFSET$aspectMask -
OFFSET$imageGranularity
public static final long OFFSET$imageGranularity -
OFFSET$flags
public static final long OFFSET$flags
-
-
Constructor Details
-
Method Details
-
allocate
-
allocate
-
clone
-
aspectMask
-
aspectMask
-
imageGranularity
-
imageGranularity
-
imageGranularity
-
flags
-
flags
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object)
. -
segment
Returns the value of thesegment
record component.
-