Record Class VkAttachmentDescription
java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkAttachmentDescription
- All Implemented Interfaces:
IPointer,IVkAttachmentDescription
@ValueBasedCandidate
@UnsafeConstructor
public record VkAttachmentDescription(@NotNull MemorySegment segment)
extends Record
implements IVkAttachmentDescription
Represents a pointer to a VkAttachmentDescription structure in native memory.
Structure
typedef struct VkAttachmentDescription {
VkAttachmentDescriptionFlags flags; // optional
VkFormat format;
VkSampleCountFlags samples;
VkAttachmentLoadOp loadOp;
VkAttachmentStoreOp storeOp;
VkAttachmentLoadOp stencilLoadOp;
VkAttachmentStoreOp stencilStoreOp;
VkImageLayout initialLayout;
VkImageLayout finalLayout;
} VkAttachmentDescription;
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 ofVkAttachmentDescriptionstructure(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 ValueLayout.OfIntstatic 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
ConstructorsConstructorDescriptionVkAttachmentDescription(@NotNull MemorySegment segment) Creates an instance of aVkAttachmentDescriptionrecord class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkAttachmentDescriptionstatic VkAttachmentDescription.Ptrstatic VkAttachmentDescriptionclone(Arena arena, VkAttachmentDescription src) final booleanIndicates whether some other object is "equal to" this one.intfinalLayout(int value) intflags()flags(int value) intformat()format(int value) final inthashCode()Returns a hash code value for this object.intinitialLayout(int value) intloadOp()loadOp(int value) intsamples()samples(int value) @NotNull MemorySegmentsegment()Returns the value of thesegmentrecord component.intstencilLoadOp(int value) intstencilStoreOp(int value) intstoreOp()storeOp(int value) final StringtoString()Returns a string representation of this record class.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$flags
-
PATH$format
-
PATH$samples
-
PATH$loadOp
-
PATH$storeOp
-
PATH$stencilLoadOp
-
PATH$stencilStoreOp
-
PATH$initialLayout
-
PATH$finalLayout
-
LAYOUT$flags
-
LAYOUT$format
-
LAYOUT$samples
-
LAYOUT$loadOp
-
LAYOUT$storeOp
-
LAYOUT$stencilLoadOp
-
LAYOUT$stencilStoreOp
-
LAYOUT$initialLayout
-
LAYOUT$finalLayout
-
SIZE$flags
public static final long SIZE$flags -
SIZE$format
public static final long SIZE$format -
SIZE$samples
public static final long SIZE$samples -
SIZE$loadOp
public static final long SIZE$loadOp -
SIZE$storeOp
public static final long SIZE$storeOp -
SIZE$stencilLoadOp
public static final long SIZE$stencilLoadOp -
SIZE$stencilStoreOp
public static final long SIZE$stencilStoreOp -
SIZE$initialLayout
public static final long SIZE$initialLayout -
SIZE$finalLayout
public static final long SIZE$finalLayout -
OFFSET$flags
public static final long OFFSET$flags -
OFFSET$format
public static final long OFFSET$format -
OFFSET$samples
public static final long OFFSET$samples -
OFFSET$loadOp
public static final long OFFSET$loadOp -
OFFSET$storeOp
public static final long OFFSET$storeOp -
OFFSET$stencilLoadOp
public static final long OFFSET$stencilLoadOp -
OFFSET$stencilStoreOp
public static final long OFFSET$stencilStoreOp -
OFFSET$initialLayout
public static final long OFFSET$initialLayout -
OFFSET$finalLayout
public static final long OFFSET$finalLayout
-
-
Constructor Details
-
VkAttachmentDescription
Creates an instance of aVkAttachmentDescriptionrecord class.- Parameters:
segment- the value for thesegmentrecord component
-
-
Method Details
-
allocate
-
allocate
-
clone
-
flags
-
flags
-
format
-
format
-
samples
-
samples
-
loadOp
-
loadOp
-
storeOp
-
storeOp
-
stencilLoadOp
-
stencilLoadOp
-
stencilStoreOp
-
stencilStoreOp
-
initialLayout
-
initialLayout
-
finalLayout
-
finalLayout
-
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.
-