Record Class VkValidationFlagsEXT

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkValidationFlagsEXT

All Implemented Interfaces:

IPointer, IVkValidationFlagsEXT

@ValueBasedCandidate
@UnsafeConstructor
public record VkValidationFlagsEXT(@NotNull MemorySegment segment)
extends Record
implements IVkValidationFlagsEXT

Represents a pointer to a VkValidationFlagsEXT structure in native memory.

Structure

typedef struct VkValidationFlagsEXT {
    VkStructureType sType;
    void const* pNext; // optional
    uint32_t disabledValidationCheckCount;
    VkValidationCheckEXT const* pDisabledValidationChecks;
} VkValidationFlagsEXT;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_VALIDATION_FLAGS_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:

• VkValidationFlagsEXT

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkValidationFlagsEXT.Ptr	Represents a pointer to / an array of VkValidationFlagsEXT structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$disabledValidationCheckCount
static final AddressLayout	LAYOUT$pDisabledValidationChecks
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$disabledValidationCheckCount
static final long	OFFSET$pDisabledValidationChecks
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$disabledValidationCheckCount
static final MemoryLayout.PathElement	PATH$pDisabledValidationChecks
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$disabledValidationCheckCount
static final long	SIZE$pDisabledValidationChecks
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

Constructor	Description
VkValidationFlagsEXT(@NotNull MemorySegment segment)	Creates an instance of a VkValidationFlagsEXT record class.

Method Summary

Modifier and Type	Method	Description
static VkValidationFlagsEXT	allocate(Arena arena)
static VkValidationFlagsEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkValidationFlagsEXT	clone(Arena arena, VkValidationFlagsEXT src)
int	disabledValidationCheckCount()
VkValidationFlagsEXT	disabledValidationCheckCount(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable IntPtr	pDisabledValidationChecks()	Note: the returned IntPtr does not have correct IntPtr.size() property.
VkValidationFlagsEXT	pDisabledValidationChecks(@Nullable IntPtr value)
MemorySegment	pDisabledValidationChecksRaw()
void	pDisabledValidationChecksRaw(MemorySegment value)
MemorySegment	pNext()
VkValidationFlagsEXT	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkValidationFlagsEXT	sType(int value)
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$disabledValidationCheckCount

public static final MemoryLayout.PathElement PATH$disabledValidationCheckCount

PATH$pDisabledValidationChecks

public static final MemoryLayout.PathElement PATH$pDisabledValidationChecks

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$disabledValidationCheckCount

public static final ValueLayout.OfInt LAYOUT$disabledValidationCheckCount

LAYOUT$pDisabledValidationChecks

public static final AddressLayout LAYOUT$pDisabledValidationChecks

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$disabledValidationCheckCount

public static final long SIZE$disabledValidationCheckCount

SIZE$pDisabledValidationChecks

public static final long SIZE$pDisabledValidationChecks

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$disabledValidationCheckCount

public static final long OFFSET$disabledValidationCheckCount

OFFSET$pDisabledValidationChecks

public static final long OFFSET$pDisabledValidationChecks

Constructor Details

VkValidationFlagsEXT

public VkValidationFlagsEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkValidationFlagsEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkValidationFlagsEXT allocate(Arena arena)

allocate

public static VkValidationFlagsEXT.Ptr allocate(Arena arena,
 long count)

clone

public static VkValidationFlagsEXT clone(Arena arena,
 VkValidationFlagsEXT src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkValidationFlagsEXT sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
public MemorySegment pNext()

pNext

public void pNext(@Pointer(comment="void*")
 MemorySegment value)

pNext

public VkValidationFlagsEXT pNext(@Nullable
 @Nullable IPointer pointer)

disabledValidationCheckCount

@Unsigned
public int disabledValidationCheckCount()

disabledValidationCheckCount

public VkValidationFlagsEXT disabledValidationCheckCount(@Unsigned
 int value)

pDisabledValidationChecks

@Nullable
@EnumType(VkValidationCheckEXT.class)
public @Nullable IntPtr pDisabledValidationChecks()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading fro or writing to the buffer.

pDisabledValidationChecks

public VkValidationFlagsEXT pDisabledValidationChecks(@Nullable @EnumType(VkValidationCheckEXT.class)
 @Nullable IntPtr value)

pDisabledValidationChecksRaw

@Pointer(target=VkValidationCheckEXT.class)
public MemorySegment pDisabledValidationChecksRaw()

pDisabledValidationChecksRaw

public void pDisabledValidationChecksRaw(@Pointer(target=VkValidationCheckEXT.class)
 MemorySegment value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

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 with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component