Record Class VkPhysicalDeviceHostImageCopyProperties
- All Implemented Interfaces:
IPointer
,IVkPhysicalDeviceHostImageCopyProperties
Represents a pointer to a VkPhysicalDeviceHostImageCopyProperties
structure in native memory.
Structure
typedef struct VkPhysicalDeviceHostImageCopyProperties {
VkStructureType
sType
;
void* pNext
; // optional
uint32_t copySrcLayoutCount
; // optional
VkImageLayout
* pCopySrcLayouts
; // optional
uint32_t copyDstLayoutCount
; // optional
VkImageLayout
* pCopyDstLayouts
; // optional
uint8_t[VK_UUID_SIZE] optimalTilingLayoutUUID
; // optional
VkBool32 identicalMemoryTypeRequirements
;
} VkPhysicalDeviceHostImageCopyProperties;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_HOST_IMAGE_COPY_PROPERTIES
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 ofVkPhysicalDeviceHostImageCopyProperties
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 ValueLayout.OfInt
static final SequenceLayout
static final AddressLayout
static final AddressLayout
static final AddressLayout
static final ValueLayout.OfInt
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final MemoryLayout.PathElement
static final long
static final long
static final long
static final long
static final long
static final long
static final long
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionVkPhysicalDeviceHostImageCopyProperties
(@NotNull MemorySegment segment) Creates an instance of aVkPhysicalDeviceHostImageCopyProperties
record class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
autoInit()
clone
(Arena arena, VkPhysicalDeviceHostImageCopyProperties src) int
copyDstLayoutCount
(int value) int
copySrcLayoutCount
(int value) final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.int
identicalMemoryTypeRequirements
(int value) optimalTilingLayoutUUID
(BytePtr value) @Nullable IntPtr
Note: the returnedIntPtr
does not have correctIntPtr.size()
property.pCopyDstLayouts
(@Nullable IntPtr value) void
pCopyDstLayoutsRaw
(MemorySegment value) @Nullable IntPtr
Note: the returnedIntPtr
does not have correctIntPtr.size()
property.pCopySrcLayouts
(@Nullable IntPtr value) void
pCopySrcLayoutsRaw
(MemorySegment value) pNext()
void
pNext
(MemorySegment value) @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$copySrcLayoutCount
-
PATH$pCopySrcLayouts
-
PATH$copyDstLayoutCount
-
PATH$pCopyDstLayouts
-
PATH$optimalTilingLayoutUUID
-
PATH$identicalMemoryTypeRequirements
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$copySrcLayoutCount
-
LAYOUT$pCopySrcLayouts
-
LAYOUT$copyDstLayoutCount
-
LAYOUT$pCopyDstLayouts
-
LAYOUT$optimalTilingLayoutUUID
-
LAYOUT$identicalMemoryTypeRequirements
-
SIZE$sType
public static final long SIZE$sType -
SIZE$pNext
public static final long SIZE$pNext -
SIZE$copySrcLayoutCount
public static final long SIZE$copySrcLayoutCount -
SIZE$pCopySrcLayouts
public static final long SIZE$pCopySrcLayouts -
SIZE$copyDstLayoutCount
public static final long SIZE$copyDstLayoutCount -
SIZE$pCopyDstLayouts
public static final long SIZE$pCopyDstLayouts -
SIZE$optimalTilingLayoutUUID
public static final long SIZE$optimalTilingLayoutUUID -
SIZE$identicalMemoryTypeRequirements
public static final long SIZE$identicalMemoryTypeRequirements -
OFFSET$sType
public static final long OFFSET$sType -
OFFSET$pNext
public static final long OFFSET$pNext -
OFFSET$copySrcLayoutCount
public static final long OFFSET$copySrcLayoutCount -
OFFSET$pCopySrcLayouts
public static final long OFFSET$pCopySrcLayouts -
OFFSET$copyDstLayoutCount
public static final long OFFSET$copyDstLayoutCount -
OFFSET$pCopyDstLayouts
public static final long OFFSET$pCopyDstLayouts -
OFFSET$optimalTilingLayoutUUID
public static final long OFFSET$optimalTilingLayoutUUID -
OFFSET$identicalMemoryTypeRequirements
public static final long OFFSET$identicalMemoryTypeRequirements
-
-
Constructor Details
-
VkPhysicalDeviceHostImageCopyProperties
Creates an instance of aVkPhysicalDeviceHostImageCopyProperties
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
public static VkPhysicalDeviceHostImageCopyProperties clone(Arena arena, VkPhysicalDeviceHostImageCopyProperties src) -
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
-
pNext
-
copySrcLayoutCount
-
copySrcLayoutCount
-
pCopySrcLayouts
Note: the returnedIntPtr
does not have correctIntPtr.size()
property. It's up to user to track the size of the buffer, and useIntPtr.reinterpret(long)
to set the size before actually reading fro or writing to the buffer. -
pCopySrcLayouts
public VkPhysicalDeviceHostImageCopyProperties pCopySrcLayouts(@Nullable @EnumType(VkImageLayout.class) @Nullable IntPtr value) -
pCopySrcLayoutsRaw
-
pCopySrcLayoutsRaw
-
copyDstLayoutCount
-
copyDstLayoutCount
-
pCopyDstLayouts
Note: the returnedIntPtr
does not have correctIntPtr.size()
property. It's up to user to track the size of the buffer, and useIntPtr.reinterpret(long)
to set the size before actually reading fro or writing to the buffer. -
pCopyDstLayouts
public VkPhysicalDeviceHostImageCopyProperties pCopyDstLayouts(@Nullable @EnumType(VkImageLayout.class) @Nullable IntPtr value) -
pCopyDstLayoutsRaw
-
pCopyDstLayoutsRaw
-
optimalTilingLayoutUUID
-
optimalTilingLayoutUUID
-
optimalTilingLayoutUUIDRaw
-
identicalMemoryTypeRequirements
-
identicalMemoryTypeRequirements
public VkPhysicalDeviceHostImageCopyProperties identicalMemoryTypeRequirements(@NativeType("VkBool32") @Unsigned int 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 thesegment
record component.
-