Record Class VkSparseImageFormatProperties2
- All Implemented Interfaces:
IPointer
,IVkSparseImageFormatProperties2
Represents a pointer to a VkSparseImageFormatProperties2
structure in native memory.
Structure
typedef struct VkSparseImageFormatProperties2 {
VkStructureType
sType
;
void* pNext
; // optional
VkSparseImageFormatProperties
properties
;
} VkSparseImageFormatProperties2;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_SPARSE_IMAGE_FORMAT_PROPERTIES_2
The allocate
(allocate(Arena)
, allocate(Arena, long)
)
functions will automatically initialize these fields. Also, you may call autoInit()
to initialize these fields manually for non-allocated instances.
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 ofVkSparseImageFormatProperties2
structure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final long
static final StructLayout
static final AddressLayout
static final StructLayout
static final ValueLayout.OfInt
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
ConstructorsConstructorDescriptionVkSparseImageFormatProperties2
(@NotNull MemorySegment segment) Creates an instance of aVkSparseImageFormatProperties2
record class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
autoInit()
clone
(Arena arena, VkSparseImageFormatProperties2 src) final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.pNext()
void
pNext
(MemorySegment value) @NotNull VkSparseImageFormatProperties
properties
(@NotNull VkSparseImageFormatProperties value) properties
(Consumer<@NotNull VkSparseImageFormatProperties> consumer) @NotNull MemorySegment
segment()
Returns the value of thesegment
record component.int
sType()
sType
(int value) final String
toString()
Returns a string representation of this record class.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$sType
-
PATH$pNext
-
PATH$properties
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$properties
-
SIZE$sType
public static final long SIZE$sType -
SIZE$pNext
public static final long SIZE$pNext -
SIZE$properties
public static final long SIZE$properties -
OFFSET$sType
public static final long OFFSET$sType -
OFFSET$pNext
public static final long OFFSET$pNext -
OFFSET$properties
public static final long OFFSET$properties
-
-
Constructor Details
-
VkSparseImageFormatProperties2
Creates an instance of aVkSparseImageFormatProperties2
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
-
pNext
-
properties
-
properties
public VkSparseImageFormatProperties2 properties(@NotNull @NotNull VkSparseImageFormatProperties value) -
properties
public VkSparseImageFormatProperties2 properties(Consumer<@NotNull VkSparseImageFormatProperties> consumer) -
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.
-