Record Class VkWriteDescriptorSet
- All Implemented Interfaces:
IPointer
,IVkWriteDescriptorSet
Represents a pointer to a VkWriteDescriptorSet
structure in native memory.
Structure
typedef struct VkWriteDescriptorSet {
VkStructureType
sType
;
void const* pNext
; // optional
VkDescriptorSet
dstSet
;
uint32_t dstBinding
;
uint32_t dstArrayElement
;
uint32_t descriptorCount
;
VkDescriptorType
descriptorType
;
VkDescriptorImageInfo
const* pImageInfo
;
VkDescriptorBufferInfo
const* pBufferInfo
;
VkBufferView
const* pTexelBufferView
;
} VkWriteDescriptorSet;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET
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 ofVkWriteDescriptorSet
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 ValueLayout.OfInt
static final AddressLayout
static final AddressLayout
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 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 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
static final long
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionVkWriteDescriptorSet
(@NotNull MemorySegment segment) Creates an instance of aVkWriteDescriptorSet
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkWriteDescriptorSet
static VkWriteDescriptorSet.Ptr
void
autoInit()
static VkWriteDescriptorSet
clone
(Arena arena, VkWriteDescriptorSet src) int
descriptorCount
(int value) int
descriptorType
(int value) int
dstArrayElement
(int value) int
dstBinding
(int value) @Nullable VkDescriptorSet
dstSet()
dstSet
(@Nullable VkDescriptorSet value) final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.@Nullable VkDescriptorBufferInfo
pBufferInfo
(int assumedCount) pBufferInfo
(@Nullable IVkDescriptorBufferInfo value) void
pBufferInfoRaw
(MemorySegment value) @Nullable VkDescriptorImageInfo
pImageInfo
(int assumedCount) pImageInfo
(@Nullable IVkDescriptorImageInfo value) void
pImageInfoRaw
(MemorySegment value) pNext()
void
pNext
(MemorySegment value) Note: the returnedVkBufferView.Ptr
does not have correctVkBufferView.Ptr.size()
property.pTexelBufferView
(VkBufferView.Ptr value) void
pTexelBufferViewRaw
(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$dstSet
-
PATH$dstBinding
-
PATH$dstArrayElement
-
PATH$descriptorCount
-
PATH$descriptorType
-
PATH$pImageInfo
-
PATH$pBufferInfo
-
PATH$pTexelBufferView
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$dstSet
-
LAYOUT$dstBinding
-
LAYOUT$dstArrayElement
-
LAYOUT$descriptorCount
-
LAYOUT$descriptorType
-
LAYOUT$pImageInfo
-
LAYOUT$pBufferInfo
-
LAYOUT$pTexelBufferView
-
SIZE$sType
public static final long SIZE$sType -
SIZE$pNext
public static final long SIZE$pNext -
SIZE$dstSet
public static final long SIZE$dstSet -
SIZE$dstBinding
public static final long SIZE$dstBinding -
SIZE$dstArrayElement
public static final long SIZE$dstArrayElement -
SIZE$descriptorCount
public static final long SIZE$descriptorCount -
SIZE$descriptorType
public static final long SIZE$descriptorType -
SIZE$pImageInfo
public static final long SIZE$pImageInfo -
SIZE$pBufferInfo
public static final long SIZE$pBufferInfo -
SIZE$pTexelBufferView
public static final long SIZE$pTexelBufferView -
OFFSET$sType
public static final long OFFSET$sType -
OFFSET$pNext
public static final long OFFSET$pNext -
OFFSET$dstSet
public static final long OFFSET$dstSet -
OFFSET$dstBinding
public static final long OFFSET$dstBinding -
OFFSET$dstArrayElement
public static final long OFFSET$dstArrayElement -
OFFSET$descriptorCount
public static final long OFFSET$descriptorCount -
OFFSET$descriptorType
public static final long OFFSET$descriptorType -
OFFSET$pImageInfo
public static final long OFFSET$pImageInfo -
OFFSET$pBufferInfo
public static final long OFFSET$pBufferInfo -
OFFSET$pTexelBufferView
public static final long OFFSET$pTexelBufferView
-
-
Constructor Details
-
VkWriteDescriptorSet
Creates an instance of aVkWriteDescriptorSet
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
-
pNext
-
dstSet
-
dstSet
-
dstBinding
-
dstBinding
-
dstArrayElement
-
dstArrayElement
-
descriptorCount
-
descriptorCount
-
descriptorType
-
descriptorType
-
pImageInfo
-
pImageInfo
-
pImageInfo
-
pImageInfoRaw
-
pImageInfoRaw
-
pBufferInfo
-
pBufferInfo
-
pBufferInfo
-
pBufferInfoRaw
-
pBufferInfoRaw
-
pTexelBufferView
Note: the returnedVkBufferView.Ptr
does not have correctVkBufferView.Ptr.size()
property. It's up to user to track the size of the buffer, and useVkBufferView.Ptr.reinterpret(long)
to set the size before actually reading from or writing to the buffer. -
pTexelBufferView
-
pTexelBufferViewRaw
-
pTexelBufferViewRaw
-
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.
-