Record Class VkAndroidSurfaceCreateInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAndroidSurfaceCreateInfoKHR

All Implemented Interfaces:

IPointer, IVkAndroidSurfaceCreateInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkAndroidSurfaceCreateInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkAndroidSurfaceCreateInfoKHR

Represents a pointer to a VkAndroidSurfaceCreateInfoKHR structure in native memory.

Structure

typedef struct VkAndroidSurfaceCreateInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkAndroidSurfaceCreateFlagsKHR flags; // optional
    ANativeWindow* window;
} VkAndroidSurfaceCreateInfoKHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_ANDROID_SURFACE_CREATE_INFO_KHR

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:

• VkAndroidSurfaceCreateInfoKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

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

public static final MemoryLayout.PathElement PATH$window

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

public static final AddressLayout LAYOUT$window

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

public static final long SIZE$window

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

public static final long OFFSET$window

Constructor Details

VkAndroidSurfaceCreateInfoKHR

public VkAndroidSurfaceCreateInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAndroidSurfaceCreateInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAndroidSurfaceCreateInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkAndroidSurfaceCreateInfoKHR clone(Arena arena,
 VkAndroidSurfaceCreateInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkAndroidSurfaceCreateInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

flags

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

flags

public VkAndroidSurfaceCreateInfoKHR flags(@Bitmask(VkAndroidSurfaceCreateFlagsKHR.class)
 int value)

window

@Nullable
public @Nullable PointerPtr window()

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

window

public VkAndroidSurfaceCreateInfoKHR window(@Nullable
 @Nullable PointerPtr value)

windowRaw

@Pointer(comment="ANativeWindow*")
@NotNull
public @NotNull MemorySegment windowRaw()

windowRaw

public void windowRaw(@Pointer(comment="ANativeWindow*") @NotNull
 @NotNull 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