Record Class VkFrameBoundaryEXT
- All Implemented Interfaces:
IPointer,IVkFrameBoundaryEXT
Represents a pointer to a VkFrameBoundaryEXT structure in native memory.
Structure
typedef struct VkFrameBoundaryEXT {
VkStructureType sType;
void const* pNext; // optional
VkFrameBoundaryFlagsEXT flags; // optional
uint64_t frameID;
uint32_t imageCount; // optional
VkImage const* pImages; // optional
uint32_t bufferCount; // optional
VkBuffer const* pBuffers; // optional
uint64_t tagName; // optional
size_t tagSize; // optional
void const* pTag; // optional
} VkFrameBoundaryEXT;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_FRAME_BOUNDARY_EXT
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 ofVkFrameBoundaryEXTstructure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longstatic final StructLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final ValueLayout.OfLongstatic final ValueLayout.OfIntstatic final AddressLayoutstatic final AddressLayoutstatic final AddressLayoutstatic final AddressLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfLongstatic final longstatic final longstatic final longstatic final longstatic 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 MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final MemoryLayout.PathElementstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final long -
Constructor Summary
ConstructorsConstructorDescriptionVkFrameBoundaryEXT(@NotNull MemorySegment segment) Creates an instance of aVkFrameBoundaryEXTrecord class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkFrameBoundaryEXTstatic VkFrameBoundaryEXT.PtrvoidautoInit()intbufferCount(int value) static VkFrameBoundaryEXTclone(Arena arena, VkFrameBoundaryEXT src) final booleanIndicates whether some other object is "equal to" this one.intflags()flags(int value) longframeID()frameID(long value) final inthashCode()Returns a hash code value for this object.intimageCount(int value) pBuffers()Note: the returnedVkBuffer.Ptrdoes not have correctVkBuffer.Ptr.size()property.pBuffers(VkBuffer.Ptr value) @NotNull MemorySegmentvoidpBuffersRaw(@NotNull MemorySegment value) pImages()Note: the returnedVkImage.Ptrdoes not have correctVkImage.Ptr.size()property.pImages(VkImage.Ptr value) @NotNull MemorySegmentvoidpImagesRaw(@NotNull MemorySegment value) @NotNull MemorySegmentpNext()pNext(@NotNull MemorySegment value) @NotNull MemorySegmentpTag()pTag(@NotNull MemorySegment value) @NotNull MemorySegmentsegment()Returns the value of thesegmentrecord component.intsType()sType(int value) longtagName()tagName(long value) longtagSize()tagSize(long 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$flags
-
PATH$frameID
-
PATH$imageCount
-
PATH$pImages
-
PATH$bufferCount
-
PATH$pBuffers
-
PATH$tagName
-
PATH$tagSize
-
PATH$pTag
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$flags
-
LAYOUT$frameID
-
LAYOUT$imageCount
-
LAYOUT$pImages
-
LAYOUT$bufferCount
-
LAYOUT$pBuffers
-
LAYOUT$tagName
-
LAYOUT$pTag
-
SIZE$sType
public static final long SIZE$sType -
SIZE$pNext
public static final long SIZE$pNext -
SIZE$flags
public static final long SIZE$flags -
SIZE$frameID
public static final long SIZE$frameID -
SIZE$imageCount
public static final long SIZE$imageCount -
SIZE$pImages
public static final long SIZE$pImages -
SIZE$bufferCount
public static final long SIZE$bufferCount -
SIZE$pBuffers
public static final long SIZE$pBuffers -
SIZE$tagName
public static final long SIZE$tagName -
SIZE$tagSize
public static final long SIZE$tagSize -
SIZE$pTag
public static final long SIZE$pTag -
OFFSET$sType
public static final long OFFSET$sType -
OFFSET$pNext
public static final long OFFSET$pNext -
OFFSET$flags
public static final long OFFSET$flags -
OFFSET$frameID
public static final long OFFSET$frameID -
OFFSET$imageCount
public static final long OFFSET$imageCount -
OFFSET$pImages
public static final long OFFSET$pImages -
OFFSET$bufferCount
public static final long OFFSET$bufferCount -
OFFSET$pBuffers
public static final long OFFSET$pBuffers -
OFFSET$tagName
public static final long OFFSET$tagName -
OFFSET$tagSize
public static final long OFFSET$tagSize -
OFFSET$pTag
public static final long OFFSET$pTag
-
-
Constructor Details
-
VkFrameBoundaryEXT
Creates an instance of aVkFrameBoundaryEXTrecord class.- Parameters:
segment- the value for thesegmentrecord component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
-
pNext
-
flags
-
flags
-
frameID
-
frameID
-
imageCount
-
imageCount
-
pImages
Note: the returnedVkImage.Ptrdoes not have correctVkImage.Ptr.size()property. It's up to user to track the size of the buffer, and useVkImage.Ptr.reinterpret(long)to set the size before actually reading from or writing to the buffer. -
pImages
-
pImagesRaw
-
pImagesRaw
-
bufferCount
-
bufferCount
-
pBuffers
Note: the returnedVkBuffer.Ptrdoes not have correctVkBuffer.Ptr.size()property. It's up to user to track the size of the buffer, and useVkBuffer.Ptr.reinterpret(long)to set the size before actually reading from or writing to the buffer. -
pBuffers
-
pBuffersRaw
-
pBuffersRaw
-
tagName
-
tagName
-
tagSize
-
tagSize
-
pTag
-
pTag
-
pTag
-
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.
-