Record Class VkExternalMemoryProperties

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkExternalMemoryProperties

All Implemented Interfaces:

IPointer, IVkExternalMemoryProperties

@ValueBasedCandidate
@UnsafeConstructor
public record VkExternalMemoryProperties(@NotNull MemorySegment segment)
extends Record
implements IVkExternalMemoryProperties

Represents a pointer to a VkExternalMemoryProperties structure in native memory.

Structure

typedef struct VkExternalMemoryProperties {
    VkExternalMemoryFeatureFlags externalMemoryFeatures;
    VkExternalMemoryHandleTypeFlags exportFromImportedHandleTypes; // optional
    VkExternalMemoryHandleTypeFlags compatibleHandleTypes;
} VkExternalMemoryProperties;

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:

• VkExternalMemoryProperties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkExternalMemoryProperties.Ptr	Represents a pointer to / an array of VkExternalMemoryProperties 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$compatibleHandleTypes
static final ValueLayout.OfInt	LAYOUT$exportFromImportedHandleTypes
static final ValueLayout.OfInt	LAYOUT$externalMemoryFeatures
static final long	OFFSET$compatibleHandleTypes
static final long	OFFSET$exportFromImportedHandleTypes
static final long	OFFSET$externalMemoryFeatures
static final MemoryLayout.PathElement	PATH$compatibleHandleTypes
static final MemoryLayout.PathElement	PATH$exportFromImportedHandleTypes
static final MemoryLayout.PathElement	PATH$externalMemoryFeatures
static final long	SIZE$compatibleHandleTypes
static final long	SIZE$exportFromImportedHandleTypes
static final long	SIZE$externalMemoryFeatures

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkExternalMemoryProperties	allocate(Arena arena)
static VkExternalMemoryProperties.Ptr	allocate(Arena arena, long count)
static VkExternalMemoryProperties	clone(Arena arena, VkExternalMemoryProperties src)
int	compatibleHandleTypes()
VkExternalMemoryProperties	compatibleHandleTypes(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	exportFromImportedHandleTypes()
VkExternalMemoryProperties	exportFromImportedHandleTypes(int value)
int	externalMemoryFeatures()
VkExternalMemoryProperties	externalMemoryFeatures(int value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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$externalMemoryFeatures

public static final MemoryLayout.PathElement PATH$externalMemoryFeatures

PATH$exportFromImportedHandleTypes

public static final MemoryLayout.PathElement PATH$exportFromImportedHandleTypes

PATH$compatibleHandleTypes

public static final MemoryLayout.PathElement PATH$compatibleHandleTypes

LAYOUT$externalMemoryFeatures

public static final ValueLayout.OfInt LAYOUT$externalMemoryFeatures

LAYOUT$exportFromImportedHandleTypes

public static final ValueLayout.OfInt LAYOUT$exportFromImportedHandleTypes

LAYOUT$compatibleHandleTypes

public static final ValueLayout.OfInt LAYOUT$compatibleHandleTypes

SIZE$externalMemoryFeatures

public static final long SIZE$externalMemoryFeatures

SIZE$exportFromImportedHandleTypes

public static final long SIZE$exportFromImportedHandleTypes

SIZE$compatibleHandleTypes

public static final long SIZE$compatibleHandleTypes

OFFSET$externalMemoryFeatures

public static final long OFFSET$externalMemoryFeatures

OFFSET$exportFromImportedHandleTypes

public static final long OFFSET$exportFromImportedHandleTypes

OFFSET$compatibleHandleTypes

public static final long OFFSET$compatibleHandleTypes

Constructor Details

VkExternalMemoryProperties

public VkExternalMemoryProperties(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkExternalMemoryProperties record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkExternalMemoryProperties allocate(Arena arena)

allocate

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

clone

public static VkExternalMemoryProperties clone(Arena arena,
 VkExternalMemoryProperties src)

externalMemoryFeatures

@EnumType(VkExternalMemoryFeatureFlags.class)
public int externalMemoryFeatures()

externalMemoryFeatures

public VkExternalMemoryProperties externalMemoryFeatures(@EnumType(VkExternalMemoryFeatureFlags.class)
 int value)

exportFromImportedHandleTypes

@EnumType(VkExternalMemoryHandleTypeFlags.class)
public int exportFromImportedHandleTypes()

exportFromImportedHandleTypes

public VkExternalMemoryProperties exportFromImportedHandleTypes(@EnumType(VkExternalMemoryHandleTypeFlags.class)
 int value)

compatibleHandleTypes

@EnumType(VkExternalMemoryHandleTypeFlags.class)
public int compatibleHandleTypes()

compatibleHandleTypes

public VkExternalMemoryProperties compatibleHandleTypes(@EnumType(VkExternalMemoryHandleTypeFlags.class)
 int 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