Record Class VkImageCompressionControlEXT
- All Implemented Interfaces:
IPointer
,IVkImageCompressionControlEXT
Represents a pointer to a VkImageCompressionControlEXT
structure in native memory.
Structure
typedef struct VkImageCompressionControlEXT {
VkStructureType
sType
;
void const* pNext
; // optional
VkImageCompressionFlagsEXT
flags
;
uint32_t compressionControlPlaneCount
; // optional
VkImageCompressionFixedRateFlagsEXT
* pFixedRateFlags
;
} VkImageCompressionControlEXT;
Auto initialization
This structure has the following members that can be automatically initialized:
sType = VK_STRUCTURE_TYPE_IMAGE_COMPRESSION_CONTROL_EXT
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 ofVkImageCompressionControlEXT
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 AddressLayout
static final AddressLayout
static final ValueLayout.OfInt
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 long
static final long
static final long
static final long
static final long
-
Constructor Summary
ConstructorsConstructorDescriptionVkImageCompressionControlEXT
(@NotNull MemorySegment segment) Creates an instance of aVkImageCompressionControlEXT
record class. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkImageCompressionControlEXT
void
autoInit()
static VkImageCompressionControlEXT
clone
(Arena arena, VkImageCompressionControlEXT src) int
compressionControlPlaneCount
(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.@Nullable IntPtr
Note: the returnedIntPtr
does not have correctIntPtr.size()
property.pFixedRateFlags
(@Nullable IntPtr value) void
pFixedRateFlagsRaw
(MemorySegment value) pNext()
void
pNext
(MemorySegment 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.
-
Field Details
-
LAYOUT
-
BYTES
public static final long BYTES -
PATH$sType
-
PATH$pNext
-
PATH$flags
-
PATH$compressionControlPlaneCount
-
PATH$pFixedRateFlags
-
LAYOUT$sType
-
LAYOUT$pNext
-
LAYOUT$flags
-
LAYOUT$compressionControlPlaneCount
-
LAYOUT$pFixedRateFlags
-
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$compressionControlPlaneCount
public static final long SIZE$compressionControlPlaneCount -
SIZE$pFixedRateFlags
public static final long SIZE$pFixedRateFlags -
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$compressionControlPlaneCount
public static final long OFFSET$compressionControlPlaneCount -
OFFSET$pFixedRateFlags
public static final long OFFSET$pFixedRateFlags
-
-
Constructor Details
-
VkImageCompressionControlEXT
Creates an instance of aVkImageCompressionControlEXT
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
-
compressionControlPlaneCount
-
compressionControlPlaneCount
-
pFixedRateFlags
@Nullable @EnumType(VkImageCompressionFixedRateFlagsEXT.class) public @Nullable IntPtr pFixedRateFlags()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 fro or writing to the buffer. -
pFixedRateFlags
public VkImageCompressionControlEXT pFixedRateFlags(@Nullable @EnumType(VkImageCompressionFixedRateFlagsEXT.class) @Nullable IntPtr value) -
pFixedRateFlagsRaw
@Pointer(target=VkImageCompressionFixedRateFlagsEXT.class) public MemorySegment pFixedRateFlagsRaw() -
pFixedRateFlagsRaw
public void pFixedRateFlagsRaw(@Pointer(target=VkImageCompressionFixedRateFlagsEXT.class) MemorySegment value) -
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.
-