Record Class VkCopyImageToBufferInfo2
- All Implemented Interfaces:
IPointer,IVkCopyImageToBufferInfo2
Represents a pointer to a VkCopyImageToBufferInfo2 structure in native memory.
Structure
typedef struct VkCopyImageToBufferInfo2 {
VkStructureType sType;
void const* pNext; // optional
VkImage srcImage;
VkImageLayout srcImageLayout;
VkBuffer dstBuffer;
uint32_t regionCount;
VkBufferImageCopy2 const* pRegions;
} VkCopyImageToBufferInfo2;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_COPY_IMAGE_TO_BUFFER_INFO_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 recordRepresents a pointer to / an array ofVkCopyImageToBufferInfo2structure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longstatic final StructLayoutstatic final AddressLayoutstatic final AddressLayoutstatic final AddressLayoutstatic final ValueLayout.OfIntstatic final AddressLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final long -
Constructor Summary
ConstructorsConstructorDescriptionVkCopyImageToBufferInfo2(@NotNull MemorySegment segment) Creates an instance of aVkCopyImageToBufferInfo2record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkCopyImageToBufferInfo2static VkCopyImageToBufferInfo2.PtrvoidautoInit()static VkCopyImageToBufferInfo2clone(Arena arena, VkCopyImageToBufferInfo2 src) @Nullable VkBufferfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.@NotNull MemorySegmentpNext()pNext(@NotNull MemorySegment value) @Nullable VkBufferImageCopy2pRegions()pRegions(int assumedCount) pRegions(@Nullable IVkBufferImageCopy2 value) @NotNull MemorySegmentvoidpRegionsRaw(@NotNull MemorySegment value) intregionCount(int value) @NotNull MemorySegmentsegment()Returns the value of thesegmentrecord component.@Nullable VkImagesrcImage()intsrcImageLayout(int value) intsType()sType(int value) final StringtoString()Returns a string representation of this record class.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$sType
-
PATH$pNext
-
PATH$srcImage
-
PATH$srcImageLayout
-
PATH$dstBuffer
-
PATH$regionCount
-
PATH$pRegions
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$srcImage
-
LAYOUT$srcImageLayout
-
LAYOUT$dstBuffer
-
LAYOUT$regionCount
-
LAYOUT$pRegions
-
SIZE$sType
public static final long SIZE$sType -
SIZE$pNext
public static final long SIZE$pNext -
SIZE$srcImage
public static final long SIZE$srcImage -
SIZE$srcImageLayout
public static final long SIZE$srcImageLayout -
SIZE$dstBuffer
public static final long SIZE$dstBuffer -
SIZE$regionCount
public static final long SIZE$regionCount -
SIZE$pRegions
public static final long SIZE$pRegions -
OFFSET$sType
public static final long OFFSET$sType -
OFFSET$pNext
public static final long OFFSET$pNext -
OFFSET$srcImage
public static final long OFFSET$srcImage -
OFFSET$srcImageLayout
public static final long OFFSET$srcImageLayout -
OFFSET$dstBuffer
public static final long OFFSET$dstBuffer -
OFFSET$regionCount
public static final long OFFSET$regionCount -
OFFSET$pRegions
public static final long OFFSET$pRegions
-
-
Constructor Details
-
VkCopyImageToBufferInfo2
Creates an instance of aVkCopyImageToBufferInfo2record class.- Parameters:
segment- the value for thesegmentrecord component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
public VkCopyImageToBufferInfo2 pNext(@Pointer(comment="void*") @NotNull @NotNull MemorySegment value) -
pNext
-
srcImage
-
srcImage
-
srcImageLayout
-
srcImageLayout
-
dstBuffer
-
dstBuffer
-
regionCount
-
regionCount
-
pRegions
-
pRegions
-
pRegions
-
pRegionsRaw
-
pRegionsRaw
public void pRegionsRaw(@Pointer(target=VkBufferImageCopy2.class) @NotNull @NotNull MemorySegment value) -
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 thesegmentrecord component.
-