Record Class VkFramebufferCreateInfo
- All Implemented Interfaces:
IPointer,IVkFramebufferCreateInfo
Represents a pointer to a VkFramebufferCreateInfo structure in native memory.
Structure
typedef struct VkFramebufferCreateInfo {
VkStructureType sType;
void const* pNext; // optional
VkFramebufferCreateFlags flags; // optional
VkRenderPass renderPass;
uint32_t attachmentCount; // optional
VkImageView const* pAttachments; // optional
uint32_t width;
uint32_t height;
uint32_t layers;
} VkFramebufferCreateInfo;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_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 ofVkFramebufferCreateInfostructure(s) in native memory. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longstatic final StructLayoutstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final ValueLayout.OfIntstatic final AddressLayoutstatic final AddressLayoutstatic final AddressLayoutstatic 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
ConstructorsConstructorDescriptionVkFramebufferCreateInfo(@NotNull MemorySegment segment) Creates an instance of aVkFramebufferCreateInforecord class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkFramebufferCreateInfostatic VkFramebufferCreateInfo.PtrintattachmentCount(int value) voidautoInit()static VkFramebufferCreateInfoclone(Arena arena, VkFramebufferCreateInfo 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) intlayers()layers(int value) Note: the returnedVkImageView.Ptrdoes not have correctVkImageView.Ptr.size()property.pAttachments(VkImageView.Ptr value) @NotNull MemorySegmentvoidpAttachmentsRaw(@NotNull MemorySegment value) @NotNull MemorySegmentpNext()pNext(@NotNull MemorySegment value) @Nullable VkRenderPassrenderPass(@Nullable VkRenderPass value) @NotNull MemorySegmentsegment()Returns the value of thesegmentrecord component.intsType()sType(int value) final StringtoString()Returns a string representation of this record class.intwidth()width(int value)
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$sType
-
PATH$pNext
-
PATH$flags
-
PATH$renderPass
-
PATH$attachmentCount
-
PATH$pAttachments
-
PATH$width
-
PATH$height
-
PATH$layers
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$flags
-
LAYOUT$renderPass
-
LAYOUT$attachmentCount
-
LAYOUT$pAttachments
-
LAYOUT$width
-
LAYOUT$height
-
LAYOUT$layers
-
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$renderPass
public static final long SIZE$renderPass -
SIZE$attachmentCount
public static final long SIZE$attachmentCount -
SIZE$pAttachments
public static final long SIZE$pAttachments -
SIZE$width
public static final long SIZE$width -
SIZE$height
public static final long SIZE$height -
SIZE$layers
public static final long SIZE$layers -
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$renderPass
public static final long OFFSET$renderPass -
OFFSET$attachmentCount
public static final long OFFSET$attachmentCount -
OFFSET$pAttachments
public static final long OFFSET$pAttachments -
OFFSET$width
public static final long OFFSET$width -
OFFSET$height
public static final long OFFSET$height -
OFFSET$layers
public static final long OFFSET$layers
-
-
Constructor Details
-
VkFramebufferCreateInfo
Creates an instance of aVkFramebufferCreateInforecord class.- Parameters:
segment- the value for thesegmentrecord component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
public VkFramebufferCreateInfo pNext(@Pointer(comment="void*") @NotNull @NotNull MemorySegment value) -
pNext
-
flags
-
flags
-
renderPass
-
renderPass
-
attachmentCount
-
attachmentCount
-
pAttachments
Note: the returnedVkImageView.Ptrdoes not have correctVkImageView.Ptr.size()property. It's up to user to track the size of the buffer, and useVkImageView.Ptr.reinterpret(long)to set the size before actually reading from or writing to the buffer. -
pAttachments
-
pAttachmentsRaw
-
pAttachmentsRaw
public void pAttachmentsRaw(@Pointer(target=VkImageView.class) @NotNull @NotNull MemorySegment value) -
width
-
width
-
height
-
height
-
layers
-
layers
-
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.
-