Record Class VkIOSSurfaceCreateInfoMVK

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkIOSSurfaceCreateInfoMVK

All Implemented Interfaces:

IPointer, IVkIOSSurfaceCreateInfoMVK

@ValueBasedCandidate
@UnsafeConstructor
public record VkIOSSurfaceCreateInfoMVK(@NotNull MemorySegment segment)
extends Record
implements IVkIOSSurfaceCreateInfoMVK

Represents a pointer to a VkIOSSurfaceCreateInfoMVK structure in native memory.

Structure

typedef struct VkIOSSurfaceCreateInfoMVK {
    VkStructureType sType;
    void const* pNext; // optional
    VkIOSSurfaceCreateFlagsMVK flags; // optional
    void const* pView;
} VkIOSSurfaceCreateInfoMVK;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_IOS_SURFACE_CREATE_INFO_MVK

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:

• VkIOSSurfaceCreateInfoMVK

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkIOSSurfaceCreateInfoMVK.Ptr	Represents a pointer to / an array of VkIOSSurfaceCreateInfoMVK 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$flags
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pView
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$flags
static final long	OFFSET$pNext
static final long	OFFSET$pView
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pView
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$flags
static final long	SIZE$pNext
static final long	SIZE$pView
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$flags

PATH$pView

public static final MemoryLayout.PathElement PATH$pView

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$flags

public static final ValueLayout.OfInt LAYOUT$flags

LAYOUT$pView

public static final AddressLayout LAYOUT$pView

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$pView

public static final long SIZE$pView

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$pView

public static final long OFFSET$pView

Constructor Details

VkIOSSurfaceCreateInfoMVK

public VkIOSSurfaceCreateInfoMVK(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkIOSSurfaceCreateInfoMVK record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkIOSSurfaceCreateInfoMVK allocate(Arena arena)

allocate

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

clone

public static VkIOSSurfaceCreateInfoMVK clone(Arena arena,
 VkIOSSurfaceCreateInfoMVK src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkIOSSurfaceCreateInfoMVK pNext(@Nullable
 @Nullable IPointer pointer)

flags

@Bitmask(VkIOSSurfaceCreateFlagsMVK.class)
public int flags()

flags

public VkIOSSurfaceCreateInfoMVK flags(@Bitmask(VkIOSSurfaceCreateFlagsMVK.class)
 int value)

pView

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment pView()

pView

public VkIOSSurfaceCreateInfoMVK pView(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pView

public VkIOSSurfaceCreateInfoMVK pView(@Nullable
 @Nullable IPointer pointer)

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