Record Class VkFramebufferAttachmentImageInfo
- All Implemented Interfaces:
IPointer,IVkFramebufferAttachmentImageInfo
Represents a pointer to a VkFramebufferAttachmentImageInfo structure in native memory.
Structure
typedef struct VkFramebufferAttachmentImageInfo {
VkStructureType sType;
void const* pNext; // optional
VkImageCreateFlags flags; // optional
VkImageUsageFlags usage;
uint32_t width;
uint32_t height;
uint32_t layerCount;
uint32_t viewFormatCount; // optional
VkFormat const* pViewFormats; // optional
} VkFramebufferAttachmentImageInfo;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_ATTACHMENT_IMAGE_INFO
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 ofVkFramebufferAttachmentImageInfostructure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longstatic final StructLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final AddressLayoutstatic final AddressLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic 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 longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final longstatic final long -
Constructor Summary
ConstructorsConstructorDescriptionVkFramebufferAttachmentImageInfo(@NotNull MemorySegment segment) Creates an instance of aVkFramebufferAttachmentImageInforecord class. -
Method Summary
Modifier and TypeMethodDescriptionvoidautoInit()clone(Arena arena, VkFramebufferAttachmentImageInfo src) final booleanIndicates whether some other object is "equal to" this one.intflags()flags(int value) final inthashCode()Returns a hash code value for this object.intheight()height(int value) intlayerCount(int value) @NotNull MemorySegmentpNext()pNext(@NotNull MemorySegment value) @Nullable IntPtrNote: the returnedIntPtrdoes not have correctIntPtr.size()property.pViewFormats(@Nullable IntPtr value) @NotNull MemorySegmentvoidpViewFormatsRaw(@NotNull MemorySegment value) @NotNull MemorySegmentsegment()Returns the value of thesegmentrecord component.intsType()sType(int value) final StringtoString()Returns a string representation of this record class.intusage()usage(int value) intviewFormatCount(int value) intwidth()width(int value)
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$sType
-
PATH$pNext
-
PATH$flags
-
PATH$usage
-
PATH$width
-
PATH$height
-
PATH$layerCount
-
PATH$viewFormatCount
-
PATH$pViewFormats
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$flags
-
LAYOUT$usage
-
LAYOUT$width
-
LAYOUT$height
-
LAYOUT$layerCount
-
LAYOUT$viewFormatCount
-
LAYOUT$pViewFormats
-
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$usage
public static final long SIZE$usage -
SIZE$width
public static final long SIZE$width -
SIZE$height
public static final long SIZE$height -
SIZE$layerCount
public static final long SIZE$layerCount -
SIZE$viewFormatCount
public static final long SIZE$viewFormatCount -
SIZE$pViewFormats
public static final long SIZE$pViewFormats -
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$usage
public static final long OFFSET$usage -
OFFSET$width
public static final long OFFSET$width -
OFFSET$height
public static final long OFFSET$height -
OFFSET$layerCount
public static final long OFFSET$layerCount -
OFFSET$viewFormatCount
public static final long OFFSET$viewFormatCount -
OFFSET$pViewFormats
public static final long OFFSET$pViewFormats
-
-
Constructor Details
-
VkFramebufferAttachmentImageInfo
Creates an instance of aVkFramebufferAttachmentImageInforecord class.- Parameters:
segment- the value for thesegmentrecord component
-
-
Method Details
-
allocate
-
allocate
-
clone
public static VkFramebufferAttachmentImageInfo clone(Arena arena, VkFramebufferAttachmentImageInfo src) -
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
public VkFramebufferAttachmentImageInfo pNext(@Pointer(comment="void*") @NotNull @NotNull MemorySegment value) -
pNext
-
flags
-
flags
-
usage
-
usage
-
width
-
width
-
height
-
height
-
layerCount
-
layerCount
-
viewFormatCount
-
viewFormatCount
-
pViewFormats
Note: the returnedIntPtrdoes 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. -
pViewFormats
public VkFramebufferAttachmentImageInfo pViewFormats(@Nullable @EnumType(VkFormat.class) @Nullable IntPtr value) -
pViewFormatsRaw
-
pViewFormatsRaw
-
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.
-