Record Class VkImageStencilUsageCreateInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageStencilUsageCreateInfo

All Implemented Interfaces:

IPointer, IVkImageStencilUsageCreateInfo

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageStencilUsageCreateInfo(@NotNull MemorySegment segment)
extends Record
implements IVkImageStencilUsageCreateInfo

Represents a pointer to a VkImageStencilUsageCreateInfo structure in native memory.

Structure

typedef struct VkImageStencilUsageCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkImageUsageFlags stencilUsage;
} VkImageStencilUsageCreateInfo;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_IMAGE_STENCIL_USAGE_CREATE_INFO

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:

• VkImageStencilUsageCreateInfo

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageStencilUsageCreateInfo	allocate(Arena arena)
static VkImageStencilUsageCreateInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkImageStencilUsageCreateInfo	clone(Arena arena, VkImageStencilUsageCreateInfo src)
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.
MemorySegment	pNext()
VkImageStencilUsageCreateInfo	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	stencilUsage()
VkImageStencilUsageCreateInfo	stencilUsage(int value)
int	sType()
VkImageStencilUsageCreateInfo	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$stencilUsage

public static final MemoryLayout.PathElement PATH$stencilUsage

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$stencilUsage

public static final ValueLayout.OfInt LAYOUT$stencilUsage

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$stencilUsage

public static final long SIZE$stencilUsage

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$stencilUsage

public static final long OFFSET$stencilUsage

Constructor Details

VkImageStencilUsageCreateInfo

public VkImageStencilUsageCreateInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageStencilUsageCreateInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageStencilUsageCreateInfo allocate(Arena arena)

allocate

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

clone

public static VkImageStencilUsageCreateInfo clone(Arena arena,
 VkImageStencilUsageCreateInfo src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkImageStencilUsageCreateInfo pNext(@Nullable
 @Nullable IPointer pointer)

stencilUsage

@EnumType(VkImageUsageFlags.class)
public int stencilUsage()

stencilUsage

public VkImageStencilUsageCreateInfo stencilUsage(@EnumType(VkImageUsageFlags.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