Record Class VkStencilOpState

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkStencilOpState

All Implemented Interfaces:

IPointer, IVkStencilOpState

@ValueBasedCandidate
@UnsafeConstructor
public record VkStencilOpState(@NotNull MemorySegment segment)
extends Record
implements IVkStencilOpState

Represents a pointer to a VkStencilOpState structure in native memory.

Structure

typedef struct VkStencilOpState {
    VkStencilOp failOp;
    VkStencilOp passOp;
    VkStencilOp depthFailOp;
    VkCompareOp compareOp;
    uint32_t compareMask;
    uint32_t writeMask;
    uint32_t reference;
} VkStencilOpState;

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:

• VkStencilOpState

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkStencilOpState.Ptr	Represents a pointer to / an array of VkStencilOpState 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$compareMask
static final ValueLayout.OfInt	LAYOUT$compareOp
static final ValueLayout.OfInt	LAYOUT$depthFailOp
static final ValueLayout.OfInt	LAYOUT$failOp
static final ValueLayout.OfInt	LAYOUT$passOp
static final ValueLayout.OfInt	LAYOUT$reference
static final ValueLayout.OfInt	LAYOUT$writeMask
static final long	OFFSET$compareMask
static final long	OFFSET$compareOp
static final long	OFFSET$depthFailOp
static final long	OFFSET$failOp
static final long	OFFSET$passOp
static final long	OFFSET$reference
static final long	OFFSET$writeMask
static final MemoryLayout.PathElement	PATH$compareMask
static final MemoryLayout.PathElement	PATH$compareOp
static final MemoryLayout.PathElement	PATH$depthFailOp
static final MemoryLayout.PathElement	PATH$failOp
static final MemoryLayout.PathElement	PATH$passOp
static final MemoryLayout.PathElement	PATH$reference
static final MemoryLayout.PathElement	PATH$writeMask
static final long	SIZE$compareMask
static final long	SIZE$compareOp
static final long	SIZE$depthFailOp
static final long	SIZE$failOp
static final long	SIZE$passOp
static final long	SIZE$reference
static final long	SIZE$writeMask

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkStencilOpState	allocate(Arena arena)
static VkStencilOpState.Ptr	allocate(Arena arena, long count)
static VkStencilOpState	clone(Arena arena, VkStencilOpState src)
int	compareMask()
VkStencilOpState	compareMask(int value)
int	compareOp()
VkStencilOpState	compareOp(int value)
int	depthFailOp()
VkStencilOpState	depthFailOp(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	failOp()
VkStencilOpState	failOp(int value)
final int	hashCode()	Returns a hash code value for this object.
int	passOp()
VkStencilOpState	passOp(int value)
int	reference()
VkStencilOpState	reference(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	writeMask()
VkStencilOpState	writeMask(int 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$failOp

public static final MemoryLayout.PathElement PATH$failOp

PATH$passOp

public static final MemoryLayout.PathElement PATH$passOp

PATH$depthFailOp

public static final MemoryLayout.PathElement PATH$depthFailOp

PATH$compareOp

public static final MemoryLayout.PathElement PATH$compareOp

PATH$compareMask

public static final MemoryLayout.PathElement PATH$compareMask

PATH$writeMask

public static final MemoryLayout.PathElement PATH$writeMask

PATH$reference

public static final MemoryLayout.PathElement PATH$reference

LAYOUT$failOp

public static final ValueLayout.OfInt LAYOUT$failOp

LAYOUT$passOp

public static final ValueLayout.OfInt LAYOUT$passOp

LAYOUT$depthFailOp

public static final ValueLayout.OfInt LAYOUT$depthFailOp

LAYOUT$compareOp

public static final ValueLayout.OfInt LAYOUT$compareOp

LAYOUT$compareMask

public static final ValueLayout.OfInt LAYOUT$compareMask

LAYOUT$writeMask

public static final ValueLayout.OfInt LAYOUT$writeMask

LAYOUT$reference

public static final ValueLayout.OfInt LAYOUT$reference

SIZE$failOp

public static final long SIZE$failOp

SIZE$passOp

public static final long SIZE$passOp

SIZE$depthFailOp

public static final long SIZE$depthFailOp

SIZE$compareOp

public static final long SIZE$compareOp

SIZE$compareMask

public static final long SIZE$compareMask

SIZE$writeMask

public static final long SIZE$writeMask

SIZE$reference

public static final long SIZE$reference

OFFSET$failOp

public static final long OFFSET$failOp

OFFSET$passOp

public static final long OFFSET$passOp

OFFSET$depthFailOp

public static final long OFFSET$depthFailOp

OFFSET$compareOp

public static final long OFFSET$compareOp

OFFSET$compareMask

public static final long OFFSET$compareMask

OFFSET$writeMask

public static final long OFFSET$writeMask

OFFSET$reference

public static final long OFFSET$reference

Constructor Details

VkStencilOpState

public VkStencilOpState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkStencilOpState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkStencilOpState allocate(Arena arena)

allocate

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

clone

public static VkStencilOpState clone(Arena arena,
 VkStencilOpState src)

failOp

@EnumType(VkStencilOp.class)
public int failOp()

failOp

public VkStencilOpState failOp(@EnumType(VkStencilOp.class)
 int value)

passOp

@EnumType(VkStencilOp.class)
public int passOp()

passOp

public VkStencilOpState passOp(@EnumType(VkStencilOp.class)
 int value)

depthFailOp

@EnumType(VkStencilOp.class)
public int depthFailOp()

depthFailOp

public VkStencilOpState depthFailOp(@EnumType(VkStencilOp.class)
 int value)

compareOp

@EnumType(VkCompareOp.class)
public int compareOp()

compareOp

public VkStencilOpState compareOp(@EnumType(VkCompareOp.class)
 int value)

compareMask

@Unsigned
public int compareMask()

compareMask

public VkStencilOpState compareMask(@Unsigned
 int value)

writeMask

@Unsigned
public int writeMask()

writeMask

public VkStencilOpState writeMask(@Unsigned
 int value)

reference

@Unsigned
public int reference()

reference

public VkStencilOpState reference(@Unsigned
 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