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
;
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 record
Represents a pointer to / an array ofVkFramebufferCreateInfo
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 ValueLayout.OfInt
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 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
-
Constructor Summary
ConstructorsConstructorDescriptionVkFramebufferCreateInfo
(@NotNull MemorySegment segment) Creates an instance of aVkFramebufferCreateInfo
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkFramebufferCreateInfo
static VkFramebufferCreateInfo.Ptr
int
attachmentCount
(int value) void
autoInit()
static VkFramebufferCreateInfo
clone
(Arena arena, VkFramebufferCreateInfo src) final boolean
Indicates whether some other object is "equal to" this one.int
flags()
flags
(int value) final int
hashCode()
Returns a hash code value for this object.int
height()
height
(int value) int
layers()
layers
(int value) Note: the returnedVkImageView.Ptr
does not have correctVkImageView.Ptr.size()
property.pAttachments
(VkImageView.Ptr value) void
pAttachmentsRaw
(MemorySegment value) pNext()
void
pNext
(MemorySegment value) @Nullable VkRenderPass
renderPass
(@Nullable VkRenderPass 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.int
width()
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 aVkFramebufferCreateInfo
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
autoInit
public void autoInit() -
sType
-
sType
-
pNext
-
pNext
-
pNext
-
flags
-
flags
-
renderPass
-
renderPass
-
attachmentCount
-
attachmentCount
-
pAttachments
Note: the returnedVkImageView.Ptr
does 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
-
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 thesegment
record component.
-