Record Class VkSubpassDescription
java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkSubpassDescription
- All Implemented Interfaces:
IPointer
,IVkSubpassDescription
@ValueBasedCandidate
@UnsafeConstructor
public record VkSubpassDescription(@NotNull MemorySegment segment)
extends Record
implements IVkSubpassDescription
Represents a pointer to a VkSubpassDescription
structure in native memory.
Structure
typedef struct VkSubpassDescription {
VkSubpassDescriptionFlags
flags
; // optional
VkPipelineBindPoint
pipelineBindPoint
;
uint32_t inputAttachmentCount
; // optional
VkAttachmentReference
const* pInputAttachments
;
uint32_t colorAttachmentCount
; // optional
VkAttachmentReference
const* pColorAttachments
;
VkAttachmentReference
const* pResolveAttachments
; // optional
VkAttachmentReference
const* pDepthStencilAttachment
; // optional
uint32_t preserveAttachmentCount
; // optional
uint32_t const* pPreserveAttachments
;
} VkSubpassDescription;
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 ofVkSubpassDescription
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 AddressLayout
static final AddressLayout
static final AddressLayout
static final ValueLayout.OfInt
static final AddressLayout
static final ValueLayout.OfInt
static final AddressLayout
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
ConstructorsConstructorDescriptionVkSubpassDescription
(@NotNull MemorySegment segment) Creates an instance of aVkSubpassDescription
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkSubpassDescription
static VkSubpassDescription.Ptr
static VkSubpassDescription
clone
(Arena arena, VkSubpassDescription src) int
colorAttachmentCount
(int value) 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
inputAttachmentCount
(int value) @Nullable VkAttachmentReference
pColorAttachments
(int assumedCount) pColorAttachments
(@Nullable IVkAttachmentReference value) void
@Nullable VkAttachmentReference
pDepthStencilAttachment
(int assumedCount) pDepthStencilAttachment
(@Nullable IVkAttachmentReference value) void
@Nullable VkAttachmentReference
pInputAttachments
(int assumedCount) pInputAttachments
(@Nullable IVkAttachmentReference value) void
int
pipelineBindPoint
(int value) @Nullable IntPtr
Note: the returnedIntPtr
does not have correctIntPtr.size()
property.pPreserveAttachments
(@Nullable IntPtr value) void
int
preserveAttachmentCount
(int value) @Nullable VkAttachmentReference
pResolveAttachments
(int assumedCount) pResolveAttachments
(@Nullable IVkAttachmentReference value) void
@NotNull MemorySegment
segment()
Returns the value of thesegment
record component.final String
toString()
Returns a string representation of this record class.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$flags
-
PATH$pipelineBindPoint
-
PATH$inputAttachmentCount
-
PATH$pInputAttachments
-
PATH$colorAttachmentCount
-
PATH$pColorAttachments
-
PATH$pResolveAttachments
-
PATH$pDepthStencilAttachment
-
PATH$preserveAttachmentCount
-
PATH$pPreserveAttachments
-
LAYOUT$flags
-
LAYOUT$pipelineBindPoint
-
LAYOUT$inputAttachmentCount
-
LAYOUT$pInputAttachments
-
LAYOUT$colorAttachmentCount
-
LAYOUT$pColorAttachments
-
LAYOUT$pResolveAttachments
-
LAYOUT$pDepthStencilAttachment
-
LAYOUT$preserveAttachmentCount
-
LAYOUT$pPreserveAttachments
-
SIZE$flags
public static final long SIZE$flags -
SIZE$pipelineBindPoint
public static final long SIZE$pipelineBindPoint -
SIZE$inputAttachmentCount
public static final long SIZE$inputAttachmentCount -
SIZE$pInputAttachments
public static final long SIZE$pInputAttachments -
SIZE$colorAttachmentCount
public static final long SIZE$colorAttachmentCount -
SIZE$pColorAttachments
public static final long SIZE$pColorAttachments -
SIZE$pResolveAttachments
public static final long SIZE$pResolveAttachments -
SIZE$pDepthStencilAttachment
public static final long SIZE$pDepthStencilAttachment -
SIZE$preserveAttachmentCount
public static final long SIZE$preserveAttachmentCount -
SIZE$pPreserveAttachments
public static final long SIZE$pPreserveAttachments -
OFFSET$flags
public static final long OFFSET$flags -
OFFSET$pipelineBindPoint
public static final long OFFSET$pipelineBindPoint -
OFFSET$inputAttachmentCount
public static final long OFFSET$inputAttachmentCount -
OFFSET$pInputAttachments
public static final long OFFSET$pInputAttachments -
OFFSET$colorAttachmentCount
public static final long OFFSET$colorAttachmentCount -
OFFSET$pColorAttachments
public static final long OFFSET$pColorAttachments -
OFFSET$pResolveAttachments
public static final long OFFSET$pResolveAttachments -
OFFSET$pDepthStencilAttachment
public static final long OFFSET$pDepthStencilAttachment -
OFFSET$preserveAttachmentCount
public static final long OFFSET$preserveAttachmentCount -
OFFSET$pPreserveAttachments
public static final long OFFSET$pPreserveAttachments
-
-
Constructor Details
-
VkSubpassDescription
Creates an instance of aVkSubpassDescription
record class.- Parameters:
segment
- the value for thesegment
record component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
flags
-
flags
-
pipelineBindPoint
-
pipelineBindPoint
-
inputAttachmentCount
-
inputAttachmentCount
-
pInputAttachments
-
pInputAttachments
-
pInputAttachments
-
pInputAttachmentsRaw
-
pInputAttachmentsRaw
-
colorAttachmentCount
-
colorAttachmentCount
-
pColorAttachments
-
pColorAttachments
-
pColorAttachments
-
pColorAttachmentsRaw
-
pColorAttachmentsRaw
-
pResolveAttachments
-
pResolveAttachments
-
pResolveAttachments
-
pResolveAttachmentsRaw
-
pResolveAttachmentsRaw
public void pResolveAttachmentsRaw(@Pointer(target=VkAttachmentReference.class) MemorySegment value) -
pDepthStencilAttachment
public VkSubpassDescription pDepthStencilAttachment(@Nullable @Nullable IVkAttachmentReference value) -
pDepthStencilAttachment
-
pDepthStencilAttachment
-
pDepthStencilAttachmentRaw
-
pDepthStencilAttachmentRaw
public void pDepthStencilAttachmentRaw(@Pointer(target=VkAttachmentReference.class) MemorySegment value) -
preserveAttachmentCount
-
preserveAttachmentCount
-
pPreserveAttachments
Note: the returnedIntPtr
does 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 from or writing to the buffer. -
pPreserveAttachments
-
pPreserveAttachmentsRaw
-
pPreserveAttachmentsRaw
-
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.
-